1
<?xml version="1.0" encoding="latin1" ?>
2
<!DOCTYPE erlref SYSTEM "erlref.dtd">
9
<holder>Ericsson AB, All Rights Reserved</holder>
12
The contents of this file are subject to the Erlang Public License,
13
Version 1.1, (the "License"); you may not use this file except in
14
compliance with the License. You should have received a copy of the
15
Erlang Public License along with this software. If not, it can be
16
retrieved online at http://www.erlang.org/.
18
Software distributed under the License is distributed on an "AS IS"
19
basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
20
the License for the specific language governing rights and limitations
23
The Initial Developer of the Original Code is Ericsson AB.
26
<title>CosEventDomainAdmin_­EventDomain</title>
27
<shorttitle>..._EventDomain</shorttitle>
30
<approved>Niclas Eklund</approved>
32
<date>2001-08-20</date>
35
<module>CosEventDomainAdmin_EventDomain</module>
36
<modulesummary>This module implements the Event Domain interface.</modulesummary>
38
<p>To get access to all definitions include necessary <c><![CDATA[hrl]]></c> files by using:<br></br><c><![CDATA[-include_lib("cosEventDomain/include/*.hrl").]]></c></p>
39
<p>This module also exports the functions described in:</p>
40
<list type="bulleted">
41
<item><em>CosNotification_QoSAdmin</em></item>
42
<item><em>CosNotification_AdminPropertiesAdmin</em></item>
47
<name>add_channel(EventDomain, Channel) -> MemberID</name>
48
<fsummary>Add a new channel to the EventDomain</fsummary>
50
<v>EventDomain = Channel = #objref</v>
51
<v>MemberID = long()</v>
54
<p>Adds the given channel to the target domain. The channel
55
must be a <c><![CDATA[CosNotifyChannelAdmin::EventChannel]]></c>.</p>
59
<name>get_all_channels(EventDomain) -> MemberIDSeq</name>
60
<fsummary>Return all channel id's associated with target object</fsummary>
62
<v>EventDomain = #objref</v>
63
<v>MemberIDSeq = [long()]</v>
66
<p>Returns a a sequence of all channels associated with
67
the target object.</p>
71
<name>get_channel(EventDomain, MemberID) -> Reply</name>
72
<fsummary>Return the channel associated with the given id</fsummary>
74
<v>EventDomain = #objref</v>
75
<v>MemberID = long()</v>
76
<v>Reply = Channel | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
77
<v>Channel = #objref</v>
80
<p>If the target domain have a <c><![CDATA[CosNotifyChannelAdmin::EventChannel]]></c>
81
represented by the given id this channel is returned. Otherwise,
82
an exception is raised.</p>
86
<name>remove_channel(EventDomain, MemberID) -> Reply</name>
87
<fsummary>Remove the channel associated with the given id and remove all connections of that channel</fsummary>
89
<v>EventDomain = #objref</v>
90
<v>MemberID = long()</v>
91
<v>Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
94
<p>If a <c><![CDATA[CosNotifyChannelAdmin::EventChannel]]></c> with the
95
<c><![CDATA[MemberID]]></c> exists it will removed and all its <c><![CDATA[Connections]]></c>
96
terminated. Otherwise an exception is raised.</p>
100
<name>add_connection(EventDomain, Connection) -> Reply</name>
101
<fsummary>If possible, setup a connection described by the <c><![CDATA[#'CosEventDomainAdmin_Connection'{}]]></c>struct</fsummary>
103
<v>EventDomain = #objref</v>
104
<v>Connection = 'CosEventDomainAdmin_Connection'{supplier_id=MemberID, consumer_id=MemberID, ctype=Type, notification_style=Style}</v>
105
<v>MemberID = long()</v>
106
<v>Type = 'ANY_EVENT' | 'STRUCTURED_EVENT' | 'SEQUENCE_EVENT'</v>
107
<v>Style = 'Pull' | 'Push'</v>
108
<v>Reply = ConnectionID | {'EXCEPTION', Exc}</v>
109
<v>ConnectionID = long()</v>
110
<v>Exc = #'CosNotifyChannelAdmin_ChannelNotFound'{} | #'CosNotifyChannelAdmin_TypeError'{} | #'CosEventDomainAdmin_AlreadyExists'{} | #'CosEventDomainAdmin_DiamondCreationForbidden'{diam=RouteSeq} | #'CosEventDomainAdmin_CycleCreationForbidden'{cyc=MemberIDSeq}</v>
111
<v>RouteSeq = [MemberIDSeq]</v>
112
<v>MemberIDSeq = [long()]</v>
115
<p>The Connection parameter must contain valid data to enable
116
the target domain to setup a connection between two channels.
117
The struct members <c><![CDATA[supplier_id]]></c> and <c><![CDATA[consumer_id]]></c>
118
determines which channel should produce and consume events.
119
which type of events and if the supplier should push or the
120
consumer pull events is determined by <c><![CDATA[ctype]]></c> and
121
<c><![CDATA[notification_style]]></c> respectively.</p>
122
<p>If the target domain is not able to setup the connection
123
the appropriate exception is raised.</p>
127
<name>get_all_connections(EventDomain) -> ConnectionIDSeq</name>
128
<fsummary>Return a sequence of all connections within the target domain</fsummary>
130
<v>EventDomain = #objref</v>
131
<v>ConnectionIDSeq = [long()]</v>
134
<p>This operation returns a sequnce of all connections within
135
the target domain.</p>
139
<name>get_connection(EventDomain, ConnectionID) -> Reply</name>
140
<fsummary>Return a <c><![CDATA[#'CosEventDomainAdmin_Connection'{}]]></c>struct describing the connection associated with the given id within the target domain</fsummary>
142
<v>EventDomain = #objref</v>
143
<v>ConnectionID = long()</v>
144
<v>Reply = Connection | {'EXCEPTION', #'CosEventDomainAdmin_ConnectionNotFound'{}}</v>
145
<v>Connection = 'CosEventDomainAdmin_Connection'{supplier_id=MemberID, consumer_id=MemberID, ctype=Type, notification_style=Style}</v>
146
<v>MemberID = long()</v>
147
<v>Type = 'ANY_EVENT' | 'STRUCTURED_EVENT' | 'SEQUENCE_EVENT'</v>
148
<v>Style = 'Pull' | 'Push'</v>
151
<p>If a connection identified by the given id exists within the
152
target domain, a <c><![CDATA[#'CosEventDomainAdmin_Connection'{}]]></c> which
153
describe the connection is returned. Otherwise, an exception
158
<name>remove_connection(EventDomain, ConnectionID) -> Reply</name>
159
<fsummary>Remove the connection identified by the given id from the target domain</fsummary>
161
<v>EventDomain = #objref</v>
162
<v>ConnectionID = long()</v>
163
<v>Reply = ok | {'EXCEPTION', #'CosEventDomainAdmin_ConnectionNotFound'{}}</v>
166
<p>If the supplied connection id exists, the connection the
167
id represents is terminated. Otherwise, an exception is raised.</p>
171
<name>get_offer_channels(EventDomain, MemberID) -> Reply</name>
172
<fsummary>Return all id's of the channels which produce events received by the channel identified by the given id</fsummary>
174
<v>EventDomain = #objref</v>
175
<v>MemberID = long()</v>
176
<v>Reply = MemberIDSeq | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
179
<p>This operation returns a sequence, containing the member id's
180
of all channels within the target domain which will supply events
181
to the channel identified by the given id. But, if no such
182
id exists in this domain, an exception is raised.</p>
186
<name>get_subscription_channels(EventDomain, MemberID) -> Reply</name>
187
<fsummary>Return all id's of the channels which consume events supplied by the channel identified by the given id</fsummary>
189
<v>EventDomain = #objref</v>
190
<v>Reply = MemberIDSeq | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
193
<p>This operations behaves like <c><![CDATA[get_subscription_channels]]></c>;
194
the difference is that the id's returned identifies channels
195
which will consume events supplied by the channel associated
196
with the given id.</p>
200
<name>destroy(EventDomain) -> ok</name>
201
<fsummary>Destroy the event domain and all connections within it</fsummary>
203
<v>EventDomain = #objref</v>
206
<p>Calling this operation will terminate all connections
207
within the target domain. The domain will terminate but
208
all channels will not be affected.</p>
212
<name>get_cycles(EventDomain) -> RouteSeq</name>
213
<fsummary>Return a list of all cycles which exists within the target domain</fsummary>
215
<v>EventDomain = #objref</v>
216
<v>RouteSeq = [MemberIDSeq]</v>
217
<v>MemberIDSeq = [long()]</v>
220
<p>Returns a list of all cycles within the target domain.</p>
224
<name>get_diamonds(EventDomain) -> DiamondSeq</name>
225
<fsummary>Return a list of all diamonds which exists within the target domain</fsummary>
227
<v>EventDomain = #objref</v>
228
<v>DiamondSeq = [RouteSeq]</v>
229
<v>RouteSeq = [MemberIDSeq]</v>
230
<v>MemberIDSeq = [long()]</v>
233
<p>Returns a list of all diamonds within the target domain</p>
237
<name>set_default_consumer_channel(EventDomain, MemberID) -> Reply</name>
238
<fsummary>Set the channel represented by the given id as default for supplier clients</fsummary>
240
<v>EventDomain = #objref</v>
241
<v>Reply = MemberID | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
242
<v>MemberID = long()</v>
245
<p>If the given id represents a channel within the target domain,
246
this channel will be used when connection a supplier client
247
without specifying a certain channel. If no such channel exists
248
an exceptions is raised.</p>
252
<name>set_default_supplier_channel(EventDomain, MemberID) -> Reply</name>
253
<fsummary>Set the channel represented by the given id as default for supplier clients</fsummary>
255
<v>EventDomain = #objref</v>
256
<v>Reply = MemberID | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
257
<v>MemberID = long()</v>
260
<p>If the given id represents a channel within the target domain,
261
this channel will be used when connection a consumer client
262
without specifying a certain channel. If no such channel exists
263
an exceptions is raised.</p>
267
<name>connect_push_consumer(EventDomain, Consumer) -> Reply</name>
268
<fsummary>Connect the PushConsumer to the default Channel</fsummary>
270
<v>EventDomain = #objref</v>
271
<v>Consumer = CosEventComm::PushConsumer</v>
272
<v>Reply = CosNotifyChannelAdmin::ProxyPushSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
275
<p>If a default Channel have been set, this operation connects the given
276
PushConsumer to it. Otherwise, the
277
<c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> exception is raised.</p>
281
<name>connect_pull_consumer(EventDomain, Consumer) -> Reply</name>
282
<fsummary>Connect the PullConsumer to the default Channel</fsummary>
284
<v>EventDomain = #objref</v>
285
<v>Consumer = CosEventComm::PullConsumer</v>
286
<v>Reply = CosNotifyChannelAdmin::ProxyPullSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
289
<p>If a default Channel have been set, this operation connects the given
290
PullConsumer to it. Otherwise, the
291
<c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> exception is raised.</p>
295
<name>connect_push_supplier(EventDomain, Supplier) -> Reply</name>
296
<fsummary>Connect the PushSupplier to the default Channel</fsummary>
298
<v>EventDomain = #objref</v>
299
<v>Supplier = CosEventComm::PushSupplier</v>
300
<v>Reply = CosNotifyChannelAdmin::ProxyPushConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
303
<p>If a default Channel have been set, this operation connects the given
304
PushSupplier to it. Otherwise, the
305
<c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> exception is raised.</p>
309
<name>connect_pull_supplier(EventDomain, Supplier) -> Reply</name>
310
<fsummary>Connect the PullSupplier to the default Channel</fsummary>
312
<v>EventDomain = #objref</v>
313
<v>Supplier = CosEventComm::PullSupplier</v>
314
<v>Reply = CosNotifyChannelAdmin::ProxyPushConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
317
<p>If a default Channel have been set, this operation connects the given
318
PullSupplier to it. Otherwise, the
319
<c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> exception is raised.</p>
323
<name>connect_structured_push_consumer(EventDomain, Consumer) -> Reply</name>
324
<fsummary>Connect the StructuredPushConsumer to the default Channel</fsummary>
326
<v>EventDomain = #objref</v>
327
<v>Consumer = CosNotifyComm::StructuredPushConsumer</v>
328
<v>Reply = CosNotifyChannelAdmin::StructuredProxyPushSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
331
<p>If a default Channel have been set, this operation connects the given
332
StructuredPushConsumer to it. Otherwise, the
333
<c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> exception is raised.</p>
337
<name>connect_structured_pull_consumer(EventDomain, Consumer) -> Reply</name>
338
<fsummary>Connect the StructuredPullConsumer to the default Channel</fsummary>
340
<v>EventDomain = #objref</v>
341
<v>Consumer = CosNotifyComm::StructuredPullConsumer</v>
342
<v>Reply = CosNotifyChannelAdmin::StructuredProxyPullSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
345
<p>If a default Channel have been set, this operation connects the given
346
StructuredPullConsumer to it. Otherwise, the
347
<c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> exception is raised.</p>
351
<name>connect_structured_push_supplier(EventDomain, Supplier) -> Reply</name>
352
<fsummary>Connect the StructuredPushSupplier to the default Channel</fsummary>
354
<v>EventDomain = #objref</v>
355
<v>Supplier = CosNotifyComm::StructuredPushSupplier</v>
356
<v>Reply = CosNotifyChannelAdmin::StructuredProxyPushConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
359
<p>If a default Channel have been set, this operation connects the given
360
StructuredPushSupplier to it. Otherwise, the
361
<c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> exception is raised.</p>
365
<name>connect_structured_pull_supplier(EventDomain, Supplier) -> Reply</name>
366
<fsummary>Connect the StructuredPullSupplier to the default Channel</fsummary>
368
<v>EventDomain = #objref</v>
369
<v>Supplier = CosNotifyComm::StructuredPullSupplier</v>
370
<v>Reply = CosNotifyChannelAdmin::StructuredProxyPullConsume | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
373
<p>If a default Channel have been set, this operation connects the given
374
StructuredPullSupplier to it. Otherwise, the
375
<c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> exception is raised.</p>
379
<name>connect_sequence_push_consumer(EventDomain, Consumer) -> Reply</name>
380
<fsummary>Connect the SequencePushConsumer to the default Channel</fsummary>
382
<v>EventDomain = #objref</v>
383
<v>Consumer = CosNotifyComm::SequencePushConsumer</v>
384
<v>Reply = CosNotifyChannelAdmin::SequenceProxyPushSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
387
<p>If a default Channel have been set, this operation connects the given
388
SequencePushConsumer to it. Otherwise, the
389
<c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> exception is raised.</p>
393
<name>connect_sequence_pull_consumer(EventDomain, Consumer) -> Reply</name>
394
<fsummary>Connect the SequencePullConsumer to the default Channel</fsummary>
396
<v>EventDomain = #objref</v>
397
<v>Consumer = CosNotifyComm::SequencePullConsumer</v>
398
<v>Reply = CosNotifyChannelAdmin::SequenceProxyPullSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
401
<p>If a default Channel have been set, this operation connects the given
402
SequencePullConsumer to it. Otherwise, the
403
<c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> exception is raised.</p>
407
<name>connect_sequence_push_supplier(EventDomain, Supplier) -> Reply</name>
408
<fsummary>Connect the SequencePushSupplier to the default Channel</fsummary>
410
<v>EventDomain = #objref</v>
411
<v>Supplier = CosNotifyComm::SequencePushSupplier</v>
412
<v>Reply = CosNotifyChannelAdmin::SequenceProxyPushConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
415
<p>If a default Channel have been set, this operation connects the given
416
SequencePushSupplier to it. Otherwise, the
417
<c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> exception is raised.</p>
421
<name>connect_sequence_pull_supplier(EventDomain, Supplier) -> Reply</name>
422
<fsummary>Connect the SequencePullSupplier to the default Channel</fsummary>
424
<v>EventDomain = #objref</v>
425
<v>Supplier = CosNotifyComm::SequencePullSupplier</v>
426
<v>Reply = CosNotifyChannelAdmin::SequenceProxyPullConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
429
<p>If a default Channel have been set, this operation connects the given
430
SequencePullSupplier to it. Otherwise, the
431
<c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> exception is raised.</p>
435
<name>connect_push_consumer_with_id(EventDomain, Consumer, MemberID) -> Reply</name>
436
<fsummary>Connect the PushConsumer to the Channel with the given MemberID</fsummary>
438
<v>EventDomain = #objref</v>
439
<v>Consumer = CosEventComm::PushConsumer</v>
440
<v>MemberID = long()</v>
441
<v>Reply = CosNotifyChannelAdmin::ProxyPushSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
444
<p>If a Channel associated with the given MemberID exists within the
445
target Domain, this operation connects the given PushConsumer
446
to it. Otherwise, the <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c>
447
exception is raised.</p>
451
<name>connect_pull_consumer_with_id(EventDomain, Consumer, MemberID) -> Reply</name>
452
<fsummary>Connect the PullConsumer to the Channel with the given MemberID</fsummary>
454
<v>EventDomain = #objref</v>
455
<v>Consumer = CosEventComm::PullConsumer</v>
456
<v>MemberID = long()</v>
457
<v>Reply = CosNotifyChannelAdmin::ProxyPullSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
460
<p>If a Channel associated with the given MemberID exists within the
461
target Domain, this operation connects the given PullConsumer
462
to it. Otherwise, the <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c>
463
exception is raised.</p>
467
<name>connect_push_supplier_with_id(EventDomain, Supplier, MemberID) -> Reply</name>
468
<fsummary>Connect the PushSupplier to the Channel with the given MemberID</fsummary>
470
<v>EventDomain = #objref</v>
471
<v>Supplier = CosEventComm::PushSupplier</v>
472
<v>MemberID = long()</v>
473
<v>Reply = CosNotifyChannelAdmin::ProxyPushConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
476
<p>If a Channel associated with the given MemberID exists within the
477
target Domain, this operation connects the given PushSupplier
478
to it. Otherwise, the <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c>
479
exception is raised.</p>
483
<name>connect_pull_supplier_with_id(EventDomain, Supplier, MemberID) -> Reply</name>
484
<fsummary>Connect the PullSupplier to the Channel with the given MemberID</fsummary>
486
<v>EventDomain = #objref</v>
487
<v>Supplier = CosEventComm::PullSupplier</v>
488
<v>MemberID = long()</v>
489
<v>Reply = CosNotifyChannelAdmin::ProxyPushConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
492
<p>If a Channel associated with the given MemberID exists within the
493
target Domain, this operation connects the given PullSupplier
494
to it. Otherwise, the <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c>
495
exception is raised.</p>
499
<name>connect_structured_push_consumer_with_id(EventDomain, Consumer, MemberID) -> Reply</name>
500
<fsummary>Connect the StructuredPushConsumer to the Channel with the given MemberID</fsummary>
502
<v>EventDomain = #objref</v>
503
<v>Consumer = CosNotifyComm::StructuredPushConsumer</v>
504
<v>MemberID = long()</v>
505
<v>Reply = CosNotifyChannelAdmin::StructuredProxyPushSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
508
<p>If a Channel associated with the given MemberID exists within the
509
target Domain, this operation connects the given StructuredPushConsumer
510
to it. Otherwise, the <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c>
511
exception is raised.</p>
515
<name>connect_structured_pull_consumer_with_id(EventDomain, Consumer, MemberID) -> Reply</name>
516
<fsummary>Connect the StructuredPullConsumer to the Channel with the given MemberID</fsummary>
518
<v>EventDomain = #objref</v>
519
<v>Consumer = CosNotifyComm::StructuredPullConsumer</v>
520
<v>MemberID = long()</v>
521
<v>Reply = CosNotifyChannelAdmin::StructuredProxyPullSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
524
<p>If a Channel associated with the given MemberID exists within the
525
target Domain, this operation connects the given StructuredPullConsumer
526
to it. Otherwise, the <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c>
527
exception is raised.</p>
531
<name>connect_structured_push_supplier_with_id(EventDomain, Supplier, MemberID) -> Reply</name>
532
<fsummary>Connect the StructuredPushSupplier to the Channel with the given MemberID</fsummary>
534
<v>EventDomain = #objref</v>
535
<v>Supplier = CosNotifyComm::StructuredPushSupplier</v>
536
<v>MemberID = long()</v>
537
<v>Reply = CosNotifyChannelAdmin::StructuredProxyPushConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
540
<p>If a Channel associated with the given MemberID exists within the
541
target Domain, this operation connects the given StructuredPushSupplier
542
to it. Otherwise, the <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c>
543
exception is raised.</p>
547
<name>connect_structured_pull_supplier_with_id(EventDomain, Supplier, MemberID) -> Reply</name>
548
<fsummary>Connect the StructuredPullSupplier to the Channel with the given MemberID</fsummary>
550
<v>EventDomain = #objref</v>
551
<v>Supplier = CosNotifyComm::StructuredPullSupplier</v>
552
<v>MemberID = long()</v>
553
<v>Reply = CosNotifyChannelAdmin::StructuredProxyPullConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
556
<p>If a Channel associated with the given MemberID exists within the
557
target Domain, this operation connects the given StructuredPullSupplier
558
to it. Otherwise, the <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c>
559
exception is raised.</p>
563
<name>connect_sequence_push_consumer_with_id(EventDomain, Consumer, MemberID) -> Reply</name>
564
<fsummary>Connect the SequencePushConsumer to the Channel with the given MemberID</fsummary>
566
<v>EventDomain = #objref</v>
567
<v>Consumer = CosNotifyComm::SequencePushConsumer</v>
568
<v>MemberID = long()</v>
569
<v>Reply = CosNotifyChannelAdmin::SequenceProxyPushSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
572
<p>If a Channel associated with the given MemberID exists within the
573
target Domain, this operation connects the given SequencePushConsumer
574
to it. Otherwise, the <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c>
575
exception is raised.</p>
579
<name>connect_sequence_pull_consumer_with_id(EventDomain, Consumer, MemberID) -> Reply</name>
580
<fsummary>Connect the SequencePullConsumer to the Channel with the given MemberID</fsummary>
582
<v>EventDomain = #objref</v>
583
<v>Consumer = CosNotifyComm::SequencePullConsumer</v>
584
<v>MemberID = long()</v>
585
<v>Reply = CosNotifyChannelAdmin::SequenceProxyPullSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
588
<p>If a Channel associated with the given MemberID exists within the
589
target Domain, this operation connects the given SequencePullConsumer
590
to it. Otherwise, the <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c>
591
exception is raised.</p>
595
<name>connect_sequence_push_supplier_with_id(EventDomain, Supplier, MemberID) -> Reply</name>
596
<fsummary>Connect the SequencePushSupplier to the Channel with the given MemberID</fsummary>
598
<v>EventDomain = #objref</v>
599
<v>Supplier = CosNotifyComm::SequencePushSupplier</v>
600
<v>MemberID = long()</v>
601
<v>Reply = CosNotifyChannelAdmin::SequenceProxyPushConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
604
<p>If a Channel associated with the given MemberID exists within the
605
target Domain, this operation connects the given SequencePushSupplier
606
to it. Otherwise, the <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c>
607
exception is raised.</p>
611
<name>connect_sequence_pull_supplier_with_id(EventDomain, Supplier, MemberID) -> Reply</name>
612
<fsummary>Connect the SequencePullSupplier to the Channel with the given MemberID</fsummary>
614
<v>EventDomain = #objref</v>
615
<v>Supplier = CosNotifyComm::SequencePullSupplier</v>
616
<v>MemberID = long()</v>
617
<v>Reply = CosNotifyChannelAdmin::SequenceProxyPullConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
620
<p>If a Channel associated with the given MemberID exists within the
621
target Domain, this operation connects the given SequencePullSupplier
622
to it. Otherwise, the <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c>
623
exception is raised.</p>
added
removed
lib/cosEventDomain/doc/src/CosEventDomainAdmin_EventDomain.xml
