bionic (3) CosEventChannelAdmin_ProxyPullConsumer.3erl.gz

NAME

       CosEventChannelAdmin_ProxyPullConsumer  - This module implements a ProxyPullConsumer interface which acts
       as a middleman between pull supplier and the event channel.

DESCRIPTION

       The ProxyPullConsumer interface defines the second step  for  connecting  pull  suppliers  to  the  event
       channel.  A  proxy  consumer  is  similar  to  a  normal  consumer, but includes an additional method for
       connecting a supplier to the proxy consumer.

       To get access to all definitions, e.g., exceptions, include necessary hrl files by using:
       -include_lib("cosEvent/include/*.hrl").

       Any object that possesses an object reference that supports the ProxyPullConsumer interface  can  perform
       the following operations:

EXPORTS

       connect_pull_supplier(Object, PullSupplier) -> Return

              Types:

                 Object = #objref
                 PullSupplier = #objref of PullSupplier type
                 Return = ok | {'EXCEPTION', E}
                 E = #'CosEventChannelAdmin_AlreadyConnected'{} | #'CosEventChannelAdmin_TypeError'{}

              This  operation  connects  PullSupplier  object  to  the ProxyPullConsumer object. If a nil object
              reference is passed CORBA standard BAD_PARAM exception is  raised.  If  the  ProxyPullConsumer  is
              already  connected  to a PullSupplier, then the CosEventChannelAdmin_AlreadyConnected exception is
              raised. Implementations of ProxyPullConsumers may require additional interface  functionality;  if
              these requirements are not met the CosEventChannelAdmin_TypeError exception will be raised.

       disconnect_pull_consumer(Object) -> Return

              Types:

                 Object = #objref
                 Return = ok

              This  operation  disconnects  proxy  pull consumer from the event channel and sends a notification
              about the loss of the connection to the pull supplier attached to it.