1CosEventDomainAdmin_EventDomEarilna(n3g)Module DefiCnoistEivoenntDomainAdmin_EventDomain(3)
2
3
4

NAME

6       CosEventDomainAdmin_EventDomain  - This module implements the Event Do‐
7       main interface.
8

DESCRIPTION

10       To get access to all definitions include necessary hrl files by using:
11       -include_lib("cosEventDomain/include/*.hrl").
12
13       This module also exports the functions described in:
14
15         * CosNotification_QoSAdmin
16
17         * CosNotification_AdminPropertiesAdmin
18

EXPORTS

20       add_channel(EventDomain, Channel) -> MemberID
21
22              Types:
23
24                 EventDomain = Channel = #objref
25                 MemberID = long()
26
27              Adds the given channel to the target domain. The channel must be
28              a CosNotifyChannelAdmin::EventChannel.
29
30       get_all_channels(EventDomain) -> MemberIDSeq
31
32              Types:
33
34                 EventDomain = #objref
35                 MemberIDSeq = [long()]
36
37              Returns  a a sequence of all channels associated with the target
38              object.
39
40       get_channel(EventDomain, MemberID) -> Reply
41
42              Types:
43
44                 EventDomain = #objref
45                 MemberID = long()
46                 Reply = Channel | {'EXCEPTION', #'CosNotifyChannelAdmin_Chan‐
47                 nelNotFound'{}}
48                 Channel = #objref
49
50              If  the target domain have a CosNotifyChannelAdmin::EventChannel
51              represented by the given id this channel is returned. Otherwise,
52              an exception is raised.
53
54       remove_channel(EventDomain, MemberID) -> Reply
55
56              Types:
57
58                 EventDomain = #objref
59                 MemberID = long()
60                 Reply  =  ok | {'EXCEPTION', #'CosNotifyChannelAdmin_Channel‐
61                 NotFound'{}}
62
63              If a CosNotifyChannelAdmin::EventChannel with the  MemberID  ex‐
64              ists  it will removed and all its Connections terminated. Other‐
65              wise an exception is raised.
66
67       add_connection(EventDomain, Connection) -> Reply
68
69              Types:
70
71                 EventDomain = #objref
72                 Connection      =       'CosEventDomainAdmin_Connection'{sup‐
73                 plier_id=MemberID,  consumer_id=MemberID, ctype=Type, notifi‐
74                 cation_style=Style}
75                 MemberID = long()
76                 Type = 'ANY_EVENT' | 'STRUCTURED_EVENT' | 'SEQUENCE_EVENT'
77                 Style = 'Pull' | 'Push'
78                 Reply = ConnectionID | {'EXCEPTION', Exc}
79                 ConnectionID = long()
80                 Exc = #'CosNotifyChannelAdmin_ChannelNotFound'{} | #'CosNoti‐
81                 fyChannelAdmin_TypeError'{}    |    #'CosEventDomainAdmin_Al‐
82                 readyExists'{} | #'CosEventDomainAdmin_DiamondCreationForbid‐
83                 den'{diam=RouteSeq} | #'CosEventDomainAdmin_CycleCreationFor‐
84                 bidden'{cyc=MemberIDSeq}
85                 RouteSeq = [MemberIDSeq]
86                 MemberIDSeq = [long()]
87
88              The Connection parameter must contain valid data to  enable  the
89              target  domain  to  setup a connection between two channels. The
90              struct members  supplier_id  and  consumer_id  determines  which
91              channel  should produce and consume events. which type of events
92              and if the supplier should push or the consumer pull  events  is
93              determined by ctype and notification_style respectively.
94
95              If the target domain is not able to setup the connection the ap‐
96              propriate exception is raised.
97
98       get_all_connections(EventDomain) -> ConnectionIDSeq
99
100              Types:
101
102                 EventDomain = #objref
103                 ConnectionIDSeq = [long()]
104
105              This operation returns a sequence of all connections within  the
106              target domain.
107
108       get_connection(EventDomain, ConnectionID) -> Reply
109
110              Types:
111
112                 EventDomain = #objref
113                 ConnectionID = long()
114                 Reply = Connection | {'EXCEPTION', #'CosEventDomainAdmin_Con‐
115                 nectionNotFound'{}}
116                 Connection      =       'CosEventDomainAdmin_Connection'{sup‐
117                 plier_id=MemberID,  consumer_id=MemberID, ctype=Type, notifi‐
118                 cation_style=Style}
119                 MemberID = long()
120                 Type = 'ANY_EVENT' | 'STRUCTURED_EVENT' | 'SEQUENCE_EVENT'
121                 Style = 'Pull' | 'Push'
122
123              If a connection identified by the given  id  exists  within  the
124              target  domain,  a #'CosEventDomainAdmin_Connection'{} which de‐
125              scribe the connection is returned. Otherwise,  an  exception  is
126              raised.
127
128       remove_connection(EventDomain, ConnectionID) -> Reply
129
130              Types:
131
132                 EventDomain = #objref
133                 ConnectionID = long()
134                 Reply  = ok | {'EXCEPTION', #'CosEventDomainAdmin_Connection‐
135                 NotFound'{}}
136
137              If the supplied connection id exists, the connection the id rep‐
138              resents is terminated. Otherwise, an exception is raised.
139
140       get_offer_channels(EventDomain, MemberID) -> Reply
141
142              Types:
143
144                 EventDomain = #objref
145                 MemberID = long()
146                 Reply  =  MemberIDSeq  |  {'EXCEPTION', #'CosNotifyChannelAd‐
147                 min_ChannelNotFound'{}}
148
149              This operation returns a sequence, containing the member id's of
150              all  channels  within the target domain which will supply events
151              to the channel identified by the given id. But, if  no  such  id
152              exists in this domain, an exception is raised.
153
154       get_subscription_channels(EventDomain, MemberID) -> Reply
155
156              Types:
157
158                 EventDomain = #objref
159                 Reply  =  MemberIDSeq  |  {'EXCEPTION', #'CosNotifyChannelAd‐
160                 min_ChannelNotFound'{}}
161
162              This operations behaves like get_subscription_channels; the dif‐
163              ference is that the id's returned identifies channels which will
164              consume events supplied by the channel associated with the given
165              id.
166
167       destroy(EventDomain) -> ok
168
169              Types:
170
171                 EventDomain = #objref
172
173              Calling this operation will terminate all connections within the
174              target domain. The domain will terminate but all  channels  will
175              not be affected.
176
177       get_cycles(EventDomain) -> RouteSeq
178
179              Types:
180
181                 EventDomain = #objref
182                 RouteSeq = [MemberIDSeq]
183                 MemberIDSeq = [long()]
184
185              Returns a list of all cycles within the target domain.
186
187       get_diamonds(EventDomain) -> DiamondSeq
188
189              Types:
190
191                 EventDomain = #objref
192                 DiamondSeq = [RouteSeq]
193                 RouteSeq = [MemberIDSeq]
194                 MemberIDSeq = [long()]
195
196              Returns a list of all diamonds within the target domain
197
198       set_default_consumer_channel(EventDomain, MemberID) -> Reply
199
200              Types:
201
202                 EventDomain = #objref
203                 Reply   =   MemberID  |  {'EXCEPTION',  #'CosNotifyChannelAd‐
204                 min_ChannelNotFound'{}}
205                 MemberID = long()
206
207              If the given id represents a channel within the  target  domain,
208              this  channel  will  be  used  when connection a supplier client
209              without specifying a certain channel. If no such channel  exists
210              an exceptions is raised.
211
212       set_default_supplier_channel(EventDomain, MemberID) -> Reply
213
214              Types:
215
216                 EventDomain = #objref
217                 Reply   =   MemberID  |  {'EXCEPTION',  #'CosNotifyChannelAd‐
218                 min_ChannelNotFound'{}}
219                 MemberID = long()
220
221              If the given id represents a channel within the  target  domain,
222              this  channel  will  be  used  when connection a consumer client
223              without specifying a certain channel. If no such channel  exists
224              an exceptions is raised.
225
226       connect_push_consumer(EventDomain, Consumer) -> Reply
227
228              Types:
229
230                 EventDomain = #objref
231                 Consumer = CosEventComm::PushConsumer
232                 Reply  =  CosNotifyChannelAdmin::ProxyPushSupplier | {'EXCEP‐
233                 TION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}
234
235              If a default Channel have been set, this operation connects  the
236              given  PushConsumer  to it. Otherwise, the #'CosNotifyChannelAd‐
237              min_ChannelNotFound'{} exception is raised.
238
239       connect_pull_consumer(EventDomain, Consumer) -> Reply
240
241              Types:
242
243                 EventDomain = #objref
244                 Consumer = CosEventComm::PullConsumer
245                 Reply = CosNotifyChannelAdmin::ProxyPullSupplier  |  {'EXCEP‐
246                 TION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}
247
248              If  a default Channel have been set, this operation connects the
249              given PullConsumer to it. Otherwise,  the  #'CosNotifyChannelAd‐
250              min_ChannelNotFound'{} exception is raised.
251
252       connect_push_supplier(EventDomain, Supplier) -> Reply
253
254              Types:
255
256                 EventDomain = #objref
257                 Supplier = CosEventComm::PushSupplier
258                 Reply  =  CosNotifyChannelAdmin::ProxyPushConsumer | {'EXCEP‐
259                 TION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}
260
261              If a default Channel have been set, this operation connects  the
262              given  PushSupplier  to it. Otherwise, the #'CosNotifyChannelAd‐
263              min_ChannelNotFound'{} exception is raised.
264
265       connect_pull_supplier(EventDomain, Supplier) -> Reply
266
267              Types:
268
269                 EventDomain = #objref
270                 Supplier = CosEventComm::PullSupplier
271                 Reply = CosNotifyChannelAdmin::ProxyPushConsumer  |  {'EXCEP‐
272                 TION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}
273
274              If  a default Channel have been set, this operation connects the
275              given PullSupplier to it. Otherwise,  the  #'CosNotifyChannelAd‐
276              min_ChannelNotFound'{} exception is raised.
277
278       connect_structured_push_consumer(EventDomain, Consumer) -> Reply
279
280              Types:
281
282                 EventDomain = #objref
283                 Consumer = CosNotifyComm::StructuredPushConsumer
284                 Reply  = CosNotifyChannelAdmin::StructuredProxyPushSupplier |
285                 {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}
286
287              If a default Channel have been set, this operation connects  the
288              given  StructuredPushConsumer to it. Otherwise, the #'CosNotify‐
289              ChannelAdmin_ChannelNotFound'{} exception is raised.
290
291       connect_structured_pull_consumer(EventDomain, Consumer) -> Reply
292
293              Types:
294
295                 EventDomain = #objref
296                 Consumer = CosNotifyComm::StructuredPullConsumer
297                 Reply = CosNotifyChannelAdmin::StructuredProxyPullSupplier  |
298                 {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}
299
300              If  a default Channel have been set, this operation connects the
301              given StructuredPullConsumer to it. Otherwise, the  #'CosNotify‐
302              ChannelAdmin_ChannelNotFound'{} exception is raised.
303
304       connect_structured_push_supplier(EventDomain, Supplier) -> Reply
305
306              Types:
307
308                 EventDomain = #objref
309                 Supplier = CosNotifyComm::StructuredPushSupplier
310                 Reply  = CosNotifyChannelAdmin::StructuredProxyPushConsumer |
311                 {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}
312
313              If a default Channel have been set, this operation connects  the
314              given  StructuredPushSupplier to it. Otherwise, the #'CosNotify‐
315              ChannelAdmin_ChannelNotFound'{} exception is raised.
316
317       connect_structured_pull_supplier(EventDomain, Supplier) -> Reply
318
319              Types:
320
321                 EventDomain = #objref
322                 Supplier = CosNotifyComm::StructuredPullSupplier
323                 Reply =  CosNotifyChannelAdmin::StructuredProxyPullConsume  |
324                 {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}
325
326              If  a default Channel have been set, this operation connects the
327              given StructuredPullSupplier to it. Otherwise, the  #'CosNotify‐
328              ChannelAdmin_ChannelNotFound'{} exception is raised.
329
330       connect_sequence_push_consumer(EventDomain, Consumer) -> Reply
331
332              Types:
333
334                 EventDomain = #objref
335                 Consumer = CosNotifyComm::SequencePushConsumer
336                 Reply  =  CosNotifyChannelAdmin::SequenceProxyPushSupplier  |
337                 {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}
338
339              If a default Channel have been set, this operation connects  the
340              given  SequencePushConsumer  to  it. Otherwise, the #'CosNotify‐
341              ChannelAdmin_ChannelNotFound'{} exception is raised.
342
343       connect_sequence_pull_consumer(EventDomain, Consumer) -> Reply
344
345              Types:
346
347                 EventDomain = #objref
348                 Consumer = CosNotifyComm::SequencePullConsumer
349                 Reply  =  CosNotifyChannelAdmin::SequenceProxyPullSupplier  |
350                 {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}
351
352              If  a default Channel have been set, this operation connects the
353              given SequencePullConsumer to it.  Otherwise,  the  #'CosNotify‐
354              ChannelAdmin_ChannelNotFound'{} exception is raised.
355
356       connect_sequence_push_supplier(EventDomain, Supplier) -> Reply
357
358              Types:
359
360                 EventDomain = #objref
361                 Supplier = CosNotifyComm::SequencePushSupplier
362                 Reply  =  CosNotifyChannelAdmin::SequenceProxyPushConsumer  |
363                 {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}
364
365              If a default Channel have been set, this operation connects  the
366              given  SequencePushSupplier  to  it. Otherwise, the #'CosNotify‐
367              ChannelAdmin_ChannelNotFound'{} exception is raised.
368
369       connect_sequence_pull_supplier(EventDomain, Supplier) -> Reply
370
371              Types:
372
373                 EventDomain = #objref
374                 Supplier = CosNotifyComm::SequencePullSupplier
375                 Reply  =  CosNotifyChannelAdmin::SequenceProxyPullConsumer  |
376                 {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}
377
378              If  a default Channel have been set, this operation connects the
379              given SequencePullSupplier to it.  Otherwise,  the  #'CosNotify‐
380              ChannelAdmin_ChannelNotFound'{} exception is raised.
381
382       connect_push_consumer_with_id(EventDomain, Consumer, MemberID) -> Reply
383
384              Types:
385
386                 EventDomain = #objref
387                 Consumer = CosEventComm::PushConsumer
388                 MemberID = long()
389                 Reply  =  CosNotifyChannelAdmin::ProxyPushSupplier | {'EXCEP‐
390                 TION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}
391
392              If a Channel associated with the given  MemberID  exists  within
393              the  target  Domain,  this operation connects the given PushCon‐
394              sumer to it. Otherwise, the  #'CosNotifyChannelAdmin_ChannelNot‐
395              Found'{} exception is raised.
396
397       connect_pull_consumer_with_id(EventDomain, Consumer, MemberID) -> Reply
398
399              Types:
400
401                 EventDomain = #objref
402                 Consumer = CosEventComm::PullConsumer
403                 MemberID = long()
404                 Reply  =  CosNotifyChannelAdmin::ProxyPullSupplier | {'EXCEP‐
405                 TION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}
406
407              If a Channel associated with the given  MemberID  exists  within
408              the  target  Domain,  this operation connects the given PullCon‐
409              sumer to it. Otherwise, the  #'CosNotifyChannelAdmin_ChannelNot‐
410              Found'{} exception is raised.
411
412       connect_push_supplier_with_id(EventDomain, Supplier, MemberID) -> Reply
413
414              Types:
415
416                 EventDomain = #objref
417                 Supplier = CosEventComm::PushSupplier
418                 MemberID = long()
419                 Reply  =  CosNotifyChannelAdmin::ProxyPushConsumer | {'EXCEP‐
420                 TION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}
421
422              If a Channel associated with the given  MemberID  exists  within
423              the  target  Domain,  this operation connects the given PushSup‐
424              plier to it. Otherwise, the  #'CosNotifyChannelAdmin_ChannelNot‐
425              Found'{} exception is raised.
426
427       connect_pull_supplier_with_id(EventDomain, Supplier, MemberID) -> Reply
428
429              Types:
430
431                 EventDomain = #objref
432                 Supplier = CosEventComm::PullSupplier
433                 MemberID = long()
434                 Reply  =  CosNotifyChannelAdmin::ProxyPushConsumer | {'EXCEP‐
435                 TION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}
436
437              If a Channel associated with the given  MemberID  exists  within
438              the  target  Domain,  this operation connects the given PullSup‐
439              plier to it. Otherwise, the  #'CosNotifyChannelAdmin_ChannelNot‐
440              Found'{} exception is raised.
441
442       connect_structured_push_consumer_with_id(EventDomain,   Consumer,  Mem‐
443       berID) -> Reply
444
445              Types:
446
447                 EventDomain = #objref
448                 Consumer = CosNotifyComm::StructuredPushConsumer
449                 MemberID = long()
450                 Reply = CosNotifyChannelAdmin::StructuredProxyPushSupplier  |
451                 {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}
452
453              If  a  Channel  associated with the given MemberID exists within
454              the target Domain, this operation connects the given Structured‐
455              PushConsumer to it. Otherwise, the #'CosNotifyChannelAdmin_Chan‐
456              nelNotFound'{} exception is raised.
457
458       connect_structured_pull_consumer_with_id(EventDomain,  Consumer,   Mem‐
459       berID) -> Reply
460
461              Types:
462
463                 EventDomain = #objref
464                 Consumer = CosNotifyComm::StructuredPullConsumer
465                 MemberID = long()
466                 Reply  = CosNotifyChannelAdmin::StructuredProxyPullSupplier |
467                 {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}
468
469              If a Channel associated with the given  MemberID  exists  within
470              the target Domain, this operation connects the given Structured‐
471              PullConsumer to it. Otherwise, the #'CosNotifyChannelAdmin_Chan‐
472              nelNotFound'{} exception is raised.
473
474       connect_structured_push_supplier_with_id(EventDomain,   Supplier,  Mem‐
475       berID) -> Reply
476
477              Types:
478
479                 EventDomain = #objref
480                 Supplier = CosNotifyComm::StructuredPushSupplier
481                 MemberID = long()
482                 Reply = CosNotifyChannelAdmin::StructuredProxyPushConsumer  |
483                 {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}
484
485              If  a  Channel  associated with the given MemberID exists within
486              the target Domain, this operation connects the given Structured‐
487              PushSupplier to it. Otherwise, the #'CosNotifyChannelAdmin_Chan‐
488              nelNotFound'{} exception is raised.
489
490       connect_structured_pull_supplier_with_id(EventDomain,  Supplier,   Mem‐
491       berID) -> Reply
492
493              Types:
494
495                 EventDomain = #objref
496                 Supplier = CosNotifyComm::StructuredPullSupplier
497                 MemberID = long()
498                 Reply  = CosNotifyChannelAdmin::StructuredProxyPullConsumer |
499                 {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}
500
501              If a Channel associated with the given  MemberID  exists  within
502              the target Domain, this operation connects the given Structured‐
503              PullSupplier to it. Otherwise, the #'CosNotifyChannelAdmin_Chan‐
504              nelNotFound'{} exception is raised.
505
506       connect_sequence_push_consumer_with_id(EventDomain, Consumer, MemberID)
507       -> Reply
508
509              Types:
510
511                 EventDomain = #objref
512                 Consumer = CosNotifyComm::SequencePushConsumer
513                 MemberID = long()
514                 Reply  =  CosNotifyChannelAdmin::SequenceProxyPushSupplier  |
515                 {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}
516
517              If  a  Channel  associated with the given MemberID exists within
518              the target Domain, this operation connects the  given  Sequence‐
519              PushConsumer to it. Otherwise, the #'CosNotifyChannelAdmin_Chan‐
520              nelNotFound'{} exception is raised.
521
522       connect_sequence_pull_consumer_with_id(EventDomain, Consumer, MemberID)
523       -> Reply
524
525              Types:
526
527                 EventDomain = #objref
528                 Consumer = CosNotifyComm::SequencePullConsumer
529                 MemberID = long()
530                 Reply  =  CosNotifyChannelAdmin::SequenceProxyPullSupplier  |
531                 {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}
532
533              If a Channel associated with the given  MemberID  exists  within
534              the  target  Domain,  this  operation connects the given Sequen‐
535              cePullConsumer  to  it.  Otherwise,  the   #'CosNotifyChannelAd‐
536              min_ChannelNotFound'{} exception is raised.
537
538       connect_sequence_push_supplier_with_id(EventDomain, Supplier, MemberID)
539       -> Reply
540
541              Types:
542
543                 EventDomain = #objref
544                 Supplier = CosNotifyComm::SequencePushSupplier
545                 MemberID = long()
546                 Reply  =  CosNotifyChannelAdmin::SequenceProxyPushConsumer  |
547                 {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}
548
549              If  a  Channel  associated with the given MemberID exists within
550              the target Domain, this operation connects the  given  Sequence‐
551              PushSupplier to it. Otherwise, the #'CosNotifyChannelAdmin_Chan‐
552              nelNotFound'{} exception is raised.
553
554       connect_sequence_pull_supplier_with_id(EventDomain, Supplier, MemberID)
555       -> Reply
556
557              Types:
558
559                 EventDomain = #objref
560                 Supplier = CosNotifyComm::SequencePullSupplier
561                 MemberID = long()
562                 Reply  =  CosNotifyChannelAdmin::SequenceProxyPullConsumer  |
563                 {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}
564
565              If a Channel associated with the given  MemberID  exists  within
566              the  target  Domain,  this  operation connects the given Sequen‐
567              cePullSupplier  to  it.  Otherwise,  the   #'CosNotifyChannelAd‐
568              min_ChannelNotFound'{} exception is raised.
569
570
571
572Ericsson AB                  cosEventDomain 5C.o0s.E2ventDomainAdmin_EventDomain(3)