1cosNotificationApp(3)      Erlang Module Definition      cosNotificationApp(3)
2
3
4

NAME

6       cosNotificationApp  -  The  main module of the cosNotification applica‐
7       tion.
8

DESCRIPTION

10       To get access to the record definitions for the structures use:
11       -include_lib("cosNotification/include/*.hrl").
12
13       This module contains the functions for starting and stopping the appli‐
14       cation.
15

EXPORTS

17       install() -> Return
18
19              Types:
20
21                 Return = ok | {'EXCEPTION', E}
22
23              This operation installs the cosNotification application.
24
25       install(Seconds) -> Return
26
27              Types:
28
29                 Return = ok | {'EXCEPTION', E}
30
31              This  operation  installs  the cosNotification application using
32              Seconds delay between each block, currently 6, of  IFR-registra‐
33              tions.  This approach spreads the IFR database access over a pe‐
34              riod of time to allow other applications to run smother.
35
36       install_event() -> Return
37
38              Types:
39
40                 Return = ok | {'EXCEPTION', E}
41
42              This operation, which may only be used if it  is  impossible  to
43              upgrade  to cosEvent-2.0 or later, installs the necessary cosEv‐
44              ent interfaces.  If  cosEvent-2.0  is  available,  use  cosEven‐
45              tApp:install() instead.
46
47       install_event(Seconds) -> Return
48
49              Types:
50
51                 Return = ok | {'EXCEPTION', E}
52
53              This  operation,  which  may only be used if it is impossible to
54              upgrade to cosEvent-2.0 or later, installs the necessary  cosEv‐
55              ent  interfaces  using  Seconds delay between each block of IFR-
56              registrations. If cosEvent-2.0 is available, use cosEventApp:in‐
57              stall() instead.
58
59       uninstall() -> Return
60
61              Types:
62
63                 Return = ok | {'EXCEPTION', E}
64
65              This operation uninstalls the cosNotification application.
66
67       uninstall(Seconds) -> Return
68
69              Types:
70
71                 Return = ok | {'EXCEPTION', E}
72
73              This  operation uninstalls the cosNotification application using
74              Seconds delay between each block, currently 6,  of  IFR-unregis‐
75              trations.  This  approach spreads the IFR database access over a
76              period of time to allow other applications to run smother.
77
78       uninstall_event() -> Return
79
80              Types:
81
82                 Return = ok | {'EXCEPTION', E}
83
84              This operation uninstalls the inherited cosEvent interfaces.  If
85              cosEvent  is in use this function may not be used. This function
86              may only be  used  if  cosNotificationApp:install_event/1/2  was
87              used. If not, use cosEventApp:uninstall() instead.
88
89       uninstall_event(Seconds) -> Return
90
91              Types:
92
93                 Return = ok | {'EXCEPTION', E}
94
95              This operation uninstalls the inherited cosEvent interfaces, us‐
96              ing Seconds delay between each block of IFR-unregistrations.  If
97              cosEvent  is in use this function may not be used. This function
98              may only be  used  if  cosNotificationApp:install_event/1/2  was
99              used. If not, use cosEventApp:uninstall() instead.
100
101       start() -> Return
102
103              Types:
104
105                 Return = ok | {error, Reason}
106
107              This operation starts the cosNotification application.
108
109       stop() -> Return
110
111              Types:
112
113                 Return = ok | {error, Reason}
114
115              This operation stops the cosNotification application.
116
117       start_global_factory() -> ChannelFactory
118
119              Types:
120
121                 ChannelFactory = #objref
122
123              This  operation  creates  a Event Channel Factory should be used
124              for a multi-node Orber. The Factory is  used  to  create  a  new
125              channel.
126
127       start_global_factory(Options) -> ChannelFactory
128
129              Types:
130
131                 Options = [Option]
132                 Option  = {pullInterval, Seconds} | {filterOp, Op} | {gcTime,
133                 Seconds} | {gcLimit, Anount} | {timeService, #objref}
134                 ChannelFactory = #objref
135
136              This operation creates a Event Channel  Factory  and  should  be
137              used for a multi-node Orber. The Factory is used to create a new
138              channel.
139
140                * {pullInterval, Seconds} - determine  how  often  Proxy  Pull
141                  Consumers will check for new events with the client applica‐
142                  tion. The default value is 20 seconds.
143
144                * {filterOp, OperationType} - determine which type of Adminis‐
145                  trator objects should be started, i.e., 'OR_OP' or 'AND_OP'.
146                  The default value is 'OR_OP'.
147
148                * {timeService, TimeServiceObj | 'undefined'} - to be able  to
149                  use  Start and/or Stop QoS this option must be used. See the
150                  function start_time_service/2 in  the  cosTime  application.
151                  The default value is 'undefined'.
152
153                * {filterOp, OperationType} - determine which type of Adminis‐
154                  trator objects should be started, i.e., 'OR_OP' or 'AND_OP'.
155                  The default value is 'OR_OP'.
156
157                * {gcTime,  Seconds}  -  this option determines how often, for
158                  example, proxies will garbage collect  expired  events.  The
159                  default value is 60.
160
161                * {gcLimit,  Amount}  -  determines  how  many  events will be
162                  stored before, for example, proxies will garbage collect ex‐
163                  pired  events.  The  default  value  is  50.  This option is
164                  tightly coupled with the QoS property  MaxEventsPerConsumer,
165                  i.e.,  the  gcLimit should be less than MaxEventsPerConsumer
166                  and greater than 0.
167
168       start_factory() -> ChannelFactory
169
170              Types:
171
172                 ChannelFactory = #objref
173
174              This operation creates a Event Channel Factory. The  Factory  is
175              used to create a new channel.
176
177       start_factory(Options) -> ChannelFactory
178
179              Types:
180
181                 Options = [Option]
182                 Option  = {pullInterval, Seconds} | {filterOp, Op} | {gcTime,
183                 Seconds} | {gcLimit, Amount} | {timeService, #objref}
184                 ChannelFactory = #objref
185
186              This operation creates a Event Channel Factory. The  Factory  is
187              used to create a new channel.
188
189       stop_factory(ChannelFactory) -> Reply
190
191              Types:
192
193                 ChannelFactory = #objref
194                 Reply = ok | {'EXCEPTION', E}
195
196              This operation stop the target channel factory.
197
198       start_filter_factory() -> FilterFactory
199
200              Types:
201
202                 FilterFactory = #objref
203
204              This  operation creates a Filter Factory. The Factory is used to
205              create a new Filter's and MappingFilter's.
206
207       stop_filter_factory(FilterFactory) -> Reply
208
209              Types:
210
211                 FilterFactory = #objref
212                 Reply = ok | {'EXCEPTION', E}
213
214              This operation stop the target filter factory.
215
216       create_structured_event(Domain, Type,  Event,  VariableHeader,  Filter‐
217       ableBody, BodyRemainder) -> Reply
218
219              Types:
220
221                 Domain = string()
222                 Type = string()
223                 Event = string()
224                 VariableHeader = [CosNotification::Property]
225                 FilterableBody = [CosNotification::Property]
226                 BodyRemainder = #any data-type
227                 Reply = CosNotification::StructuredEvent | {'EXCEPTION', E}
228
229              An  easy  way  to create a structured event is to use this func‐
230              tion. Simple typechecks are performed and if one  of  the  argu‐
231              ments is not correct a 'BAD_PARAM' exception is thrown.
232
233       type_check() -> Reply
234
235              Types:
236
237                 Reply = true | false
238
239              This  operation returns the value of the configuration parameter
240              type_check.
241
242
243
244Ericsson AB                   cosNotification 5.1        cosNotificationApp(3)