bionic (3) CosNotifyChannelAdmin_ProxyPullConsumer.3erl.gz

NAME

       CosNotifyChannelAdmin_ProxyPullConsumer       -       This       module      implements      the      OMG
       CosNotifyChannelAdmin::ProxyPullConsumer interface.

DESCRIPTION

       To get access to the record definitions for the structures use:
       -include_lib("cosNotification/include/*.hrl").

       This module also exports the functions described in:

         * CosNotifyComm_NotifyPublish

         * CosNotification_QoSAdmin

         * CosNotifyFilter_FilterAdmin

         * CosNotifyChannelAdmin_ProxyConsumer

EXPORTS

       connect_any_pull_supplier(ProxyPullConsumer, PullSupplier) -> Reply

              Types:

                 ProxyPullConsumer = #objref
                 PullSupplier = #objref
                 Reply  =  ok  |  {'EXCEPTION',  #'CosEventChannelAdmin_AlreadyConnected'{}}   |   {'EXCEPTION',
                 #'CosEventChannelAdmin_TypeError'{}}

              This  operation  connects  the  given  PullSupplier  to  the target object. If a client is already
              connected the AlreadyConnected exception will be raised. The client must  support  the  operations
              pull and try_pull, otherwise the TypeError exception is raised.

       suspend_connection(ProxyPullConsumer) -> Reply

              Types:

                 ProxyPullConsumer = #objref
                 Reply    =   ok   |   {'EXCEPTION',   #'CosNotifyChannelAdmin_ConnectionAlreadyInactive'{}}   |
                 {'EXCEPTION', #'CosNotifyChannelAdmin_NotConnected'{}}

              If we want to temporarily suspend the connection with the target object  this  operation  must  be
              sued.  If the connection already have been suspended or no client have been connected an exception
              is raised.

       resume_connection(ProxyPullConsumer) -> Reply

              Types:

                 ProxyPullConsumer = #objref
                 Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ConnectionAlreadyActive'{}} |  {'EXCEPTION',
                 #'CosNotifyChannelAdmin_NotConnected'{}}

              If  The  connection  have  been  suspended  earlier  we can invoke this operation to reinstate the
              connection. If the connection already is active or no client have been  connected  to  the  target
              object an exception is raised.

       disconnect_pull_consumer(ProxyPullConsumer) -> ok

              Types:

                 ProxyPullConsumer = #objref

              Invoking  this  operation  disconnects the client from the target object which then terminates and
              inform its administrative parent.