1CosEventChannelAdmin_ProxyPuEsrhlCaonngsuMmoedruC(lo3es)EDveefnitnCihtainonnelAdmin_ProxyPushConsumer(3)
2
3
4

NAME

6       CosEventChannelAdmin_ProxyPushConsumer - This module implements a Prox‐
7       yPushConsumer interface which acts as a middleman between push supplier
8       and the event channel.
9

DESCRIPTION

11       The  ProxyPushConsumer interface defines the second step for connecting
12       push suppliers to the event channel. A proxy consumer is similar  to  a
13       normal  consumer,  but  includes  an additional method for connecting a
14       supplier to the proxy consumer.
15
16       To get access to all definitions, e.g., exceptions,  include  necessary
17       hrl files by using:
18       -include_lib("cosEvent/include/*.hrl").
19
20       Any  object that possesses an object reference that supports the Proxy‐
21       PushConsumer interface can perform the following operations:
22

EXPORTS

24       connect_push_supplier(Object, PushSupplier) -> Return
25
26              Types:
27
28                 Object = #objref
29                 PushSupplier = #objref of PushSupplier type
30                 Return = ok |  {'EXCEPTION',  #'CosEventChannelAdmin_Already‐
31                 Connected'{}}
32
33              This operation connects PushSupplier object to the ProxyPushCon‐
34              sumer object. A nil object reference can be passed to this oper‐
35              ation.  If  so  a channel cannot invoke the disconnect_push_sup‐
36              plier operation on the supplier; the  supplier  may  be  discon‐
37              nected  from  the  channel without being informed. If the Proxy‐
38              PushConsumer is already connected to a  PushSupplier,  then  the
39              CosEventChannelAdmin_AlreadyConnected exception is raised.
40
41       disconnect_push_consumer(Object) -> Return
42
43              Types:
44
45                 Object = #objref
46                 Return = ok
47
48              This  operation  disconnects  proxy push consumer from the event
49              channel. Sends a notification about the loss of  the  connection
50              to the push supplier attached to it, unless nil object reference
51              was passed at the connection time.
52
53       push(Object, Data) -> Return
54
55              Types:
56
57                 Object = #objref
58                 Data = any
59                 Return = ok | {'EXCEPTION', #'CosEventComm_Disconnected'{}}
60
61              This operation sends event data to all connected  consumers  via
62              the  event  channel. If the event communication has already been
63              disconnected, the CosEventComm_Disconnected is raised.
64
65
66
67Ericsson AB                      cosEvCeonstEv5e.n0tChannelAdmin_ProxyPushConsumer(3)
Impressum