1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
|
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">
<erlref>
<header>
<copyright>
<year>2000</year><year>2013</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
</legalnotice>
<title>cosNotificationApp</title>
<prepared>Niclas Eklund</prepared>
<responsible>Niclas Eklund</responsible>
<docno></docno>
<approved>Niclas Eklund</approved>
<checked></checked>
<date>2000-01-31</date>
<rev>PA1</rev>
</header>
<module>cosNotificationApp</module>
<modulesummary>The main module of the cosNotification application.</modulesummary>
<description>
<p>To get access to the record definitions for the structures use: <br></br>
<c>-include_lib("cosNotification/include/*.hrl").</c></p>
<p>This module contains the functions for starting and stopping the application.</p>
</description>
<funcs>
<func>
<name>install() -> Return</name>
<fsummary>Install the cosNotification application</fsummary>
<type>
<v>Return = ok | {'EXCEPTION', E}</v>
</type>
<desc>
<p>This operation installs the cosNotification application.</p>
</desc>
</func>
<func>
<name>install(Seconds) -> Return</name>
<fsummary>Install the cosNotification application</fsummary>
<type>
<v>Return = ok | {'EXCEPTION', E}</v>
</type>
<desc>
<p>This operation installs the cosNotification application using <c>Seconds</c>
delay between each block, currently 6, of IFR-registrations. This approach
spreads the IFR database access over a period of time to allow other
applications to run smother.</p>
</desc>
</func>
<func>
<name>install_event() -> Return</name>
<fsummary>Install the necessary cosEvent interfaces</fsummary>
<type>
<v>Return = ok | {'EXCEPTION', E}</v>
</type>
<desc>
<p>This operation, which may <em>only</em> be used if it is impossible to
upgrade to <em>cosEvent-2.0</em> or later, installs the necessary
cosEvent interfaces. If cosEvent-2.0 is available, use
<c>cosEventApp:install()</c> instead.</p>
</desc>
</func>
<func>
<name>install_event(Seconds) -> Return</name>
<fsummary>Install the necessary cosEvent interfaces</fsummary>
<type>
<v>Return = ok | {'EXCEPTION', E}</v>
</type>
<desc>
<p>This operation, which may <em>only</em> be used if it is impossible to
upgrade to <em>cosEvent-2.0</em> or later, installs the necessary cosEvent
interfaces using <c>Seconds</c> delay between each block of
IFR-registrations. If cosEvent-2.0 is available, use
<c>cosEventApp:install()</c> instead.</p>
</desc>
</func>
<func>
<name>uninstall() -> Return</name>
<fsummary>Uninstall the cosNotification application</fsummary>
<type>
<v>Return = ok | {'EXCEPTION', E}</v>
</type>
<desc>
<p>This operation uninstalls the cosNotification application.</p>
</desc>
</func>
<func>
<name>uninstall(Seconds) -> Return</name>
<fsummary>Uninstall the cosNotification application</fsummary>
<type>
<v>Return = ok | {'EXCEPTION', E}</v>
</type>
<desc>
<p>This operation uninstalls the cosNotification application using <c>Seconds</c>
delay between each block, currently 6, of IFR-unregistrations. This approach
spreads the IFR database access over a period of time to allow other
applications to run smother.</p>
</desc>
</func>
<func>
<name>uninstall_event() -> Return</name>
<fsummary>Uninstall the inherited cosEvent interfaces</fsummary>
<type>
<v>Return = ok | {'EXCEPTION', E}</v>
</type>
<desc>
<p>This operation uninstalls the inherited cosEvent interfaces. If cosEvent
is in use this function may not be used. This function may only be used if
<c>cosNotificationApp:install_event/1/2</c> was used. If not, use
<c>cosEventApp:uninstall()</c> instead.</p>
</desc>
</func>
<func>
<name>uninstall_event(Seconds) -> Return</name>
<fsummary>Uninstall the inherited cosEvent interfaces</fsummary>
<type>
<v>Return = ok | {'EXCEPTION', E}</v>
</type>
<desc>
<p>This operation uninstalls the inherited cosEvent interfaces, using <c>Seconds</c>
delay between each block of IFR-unregistrations. If cosEvent
is in use this function may not be used. This function may only be used if
<c>cosNotificationApp:install_event/1/2</c> was used. If not, use
<c>cosEventApp:uninstall()</c> instead.</p>
</desc>
</func>
<func>
<name>start() -> Return</name>
<fsummary>Start the cosNotification application</fsummary>
<type>
<v>Return = ok | {error, Reason}</v>
</type>
<desc>
<p>This operation starts the cosNotification application.</p>
</desc>
</func>
<func>
<name>stop() -> Return</name>
<fsummary>Stop the cosNotification application</fsummary>
<type>
<v>Return = ok | {error, Reason}</v>
</type>
<desc>
<p>This operation stops the cosNotification application.</p>
</desc>
</func>
<func>
<name>start_global_factory() -> ChannelFactory</name>
<fsummary>Start a global channel factory as default</fsummary>
<type>
<v>ChannelFactory = #objref</v>
</type>
<desc>
<p>This operation creates a
<seealso marker="CosNotifyChannelAdmin_EventChannelFactory">Event Channel Factory</seealso>
should be used for a multi-node Orber.
The Factory is used to create a new
<seealso marker="CosNotifyChannelAdmin_EventChannel">channel</seealso>. </p>
</desc>
</func>
<func>
<name>start_global_factory(Options) -> ChannelFactory</name>
<fsummary>Start a global channel factory with options</fsummary>
<type>
<v>Options = [Option]</v>
<v>Option = {pullInterval, Seconds} | {filterOp, Op} | {gcTime, Seconds} | {gcLimit, Anount} | {timeService, #objref}</v>
<v>ChannelFactory = #objref</v>
</type>
<desc>
<p>This operation creates a
<seealso marker="CosNotifyChannelAdmin_EventChannelFactory">Event Channel Factory</seealso> and
should be used for a multi-node Orber.
The Factory is used to create a new
<seealso marker="CosNotifyChannelAdmin_EventChannel">channel</seealso>. </p>
<p></p>
<list type="bulleted">
<item><c>{pullInterval, Seconds}</c> - determine how often Proxy Pull
Consumers will check for new events with the client application. The
default value is 20 seconds.</item>
<item><c>{filterOp, OperationType}</c> - determine which type of Administrator
objects should be started, i.e., <c>'OR_OP'</c> or <c>'AND_OP'</c>.
The default value is <c>'OR_OP'</c>.</item>
<item><c>{timeService, TimeServiceObj | 'undefined'}</c> - to be able to use
Start and/or Stop QoS this option must be used. See the function <c>start_time_service/2</c>
in the <c>cosTime</c> application. The default value is <c>'undefined'</c>.</item>
<item><c>{filterOp, OperationType}</c> - determine which type of Administrator
objects should be started, i.e., <c>'OR_OP'</c> or <c>'AND_OP'</c>.
The default value is <c>'OR_OP'</c>.</item>
<item><c>{gcTime, Seconds}</c> - this option determines how often, for example, proxies
will garbage collect expired events. The default value is 60.</item>
<item><c>{gcLimit, Amount}</c> - determines how many events will be stored before, for
example, proxies will garbage collect expired events. The default value is 50. This
option is tightly coupled with the QoS property <c>MaxEventsPerConsumer</c>, i.e.,
the <c>gcLimit</c> should be less than <c>MaxEventsPerConsumer</c> and greater than 0.</item>
</list>
</desc>
</func>
<func>
<name>start_factory() -> ChannelFactory</name>
<fsummary>Start a channel factory as default</fsummary>
<type>
<v>ChannelFactory = #objref</v>
</type>
<desc>
<p>This operation creates a
<seealso marker="CosNotifyChannelAdmin_EventChannelFactory">Event Channel Factory</seealso>.
The Factory is used to create a new
<seealso marker="CosNotifyChannelAdmin_EventChannel">channel</seealso>. </p>
</desc>
</func>
<func>
<name>start_factory(Options) -> ChannelFactory</name>
<fsummary>Start a channel factory with options</fsummary>
<type>
<v>Options = [Option]</v>
<v>Option = {pullInterval, Seconds} | {filterOp, Op} | {gcTime, Seconds} | {gcLimit, Amount} | {timeService, #objref}</v>
<v>ChannelFactory = #objref</v>
</type>
<desc>
<p>This operation creates a
<seealso marker="CosNotifyChannelAdmin_EventChannelFactory">Event Channel Factory</seealso>.
The Factory is used to create a new
<seealso marker="CosNotifyChannelAdmin_EventChannel">channel</seealso>. </p>
</desc>
</func>
<func>
<name>stop_factory(ChannelFactory) -> Reply</name>
<fsummary>Terminate the target object</fsummary>
<type>
<v>ChannelFactory = #objref</v>
<v>Reply = ok | {'EXCEPTION', E}</v>
</type>
<desc>
<p>This operation stop the target channel factory.</p>
</desc>
</func>
<func>
<name>start_filter_factory() -> FilterFactory</name>
<fsummary>Start a filter factory</fsummary>
<type>
<v>FilterFactory = #objref</v>
</type>
<desc>
<p>This operation creates a
<seealso marker="CosNotifyFilter_FilterFactory">Filter Factory</seealso>.
The Factory is used to create a new
<seealso marker="CosNotifyFilter_Filter">Filter's</seealso> and
<seealso marker="CosNotifyFilter_MappingFilter">MappingFilter's</seealso>. </p>
</desc>
</func>
<func>
<name>stop_filter_factory(FilterFactory) -> Reply</name>
<fsummary>Terminate the target object</fsummary>
<type>
<v>FilterFactory = #objref</v>
<v>Reply = ok | {'EXCEPTION', E}</v>
</type>
<desc>
<p>This operation stop the target filter factory.</p>
</desc>
</func>
<func>
<name>create_structured_event(Domain, Type, Event, VariableHeader, FilterableBody, BodyRemainder) -> Reply</name>
<fsummary>Create a structured event</fsummary>
<type>
<v>Domain = string()</v>
<v>Type = string()</v>
<v>Event = string()</v>
<v>VariableHeader = [CosNotification::Property]</v>
<v>FilterableBody = [CosNotification::Property]</v>
<v>BodyRemainder = #any data-type</v>
<v>Reply = CosNotification::StructuredEvent | {'EXCEPTION', E}</v>
</type>
<desc>
<p>An easy way to create a structured event is to use this function.
Simple typechecks are performed and if one of the arguments is not
correct a 'BAD_PARAM' exception is thrown.</p>
</desc>
</func>
<func>
<name>type_check() -> Reply</name>
<fsummary>Return the value of the configuration parameter type_check</fsummary>
<type>
<v>Reply = true | false</v>
</type>
<desc>
<p>This operation returns the value of the configuration parameter
<c>type_check</c>.</p>
</desc>
</func>
</funcs>
</erlref>
|
