1CosEventChannelAdmin_ProxyPuElrllSaunpgplMioedruC(lo3es)EDveefnitnCihtainonnelAdmin_ProxyPullSupplier(3)
2
3
4

NAME

6       CosEventChannelAdmin_ProxyPullSupplier - This module implements a Prox‐
7       yPullSupplier interface which acts as a middleman between pull consumer
8       and the event channel.
9

DESCRIPTION

11       The  ProxyPullSupplier interface defines the second step for connecting
12       pull consumers to the event channel. A proxy supplier is similar  to  a
13       normal  supplier,  but  includes  an additional method for connecting a
14       consumer to the proxy supplier.
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       PullSupplier interface can perform the following operations:
22

EXPORTS

24       connect_pull_consumer(Object, PullConsumer) -> Return
25
26              Types:
27
28                 Object = #objref
29                 PullConsumer = #objref of PullConsumer type
30                 Return = ok |  {'EXCEPTION',  #'CosEventChannelAdmin_Already‐
31                 Connected'{}}
32
33              This operation connects PullConsumer object to the ProxyPullSup‐
34              plier object. A nil object reference can be passed to this oper‐
35              ation.  If  so  a channel cannot invoke the disconnect_pull_con‐
36              sumer operation on the consumer; the  consumer  may  be  discon‐
37              nected  from  the  channel without being informed. If the Proxy‐
38              PullSupplier is already connected to a  PullConsumer,  then  the
39              CosEventChannelAdmin_AlreadyConnected exception is raised.
40
41       disconnect_pull_supplier(Object) -> Return
42
43              Types:
44
45                 Object = #objref
46                 Return = ok
47
48              This  operation  disconnects  proxy pull supplier from the event
49              channel. It sends a notification about the loss of  the  connec‐
50              tion to the pull consumer attached to it, unless nil object ref‐
51              erence was passed at the connection time.
52
53       pull(Object) -> Return
54
55              Types:
56
57                 Object = #objref
58                 Return = any
59
60              This operation blocks until the event data is available  or  the
61              CosEventComm_Disconnected  exception  is  raised. It returns the
62              event data to the consumer.
63
64       try_pull(Object) -> Return
65
66              Types:
67
68                 Object = #objref
69                 Return = {any, bool()}
70
71              This operation does not block: if the event data  is  available,
72              it returns the event data and sets the data availability flag to
73              true; otherwise it returns a long with an  undefined  value  and
74              sets  the data availability to false. If the event communication
75              has already been disconnected, the CosEventComm_Disconnected ex‐
76              ception is raised.
77
78
79
80Ericsson AB                      cosEvCeonstEv5e.n1tChannelAdmin_ProxyPullSupplier(3)
Impressum