cosnotifychanneladmin_proxypullsupplier(3erl) [linux man page]

CosNotifyChannelAdmin_ProxyPullSupplier(3erl)		     Erlang Module Definition		     CosNotifyChannelAdmin_ProxyPullSupplier(3erl)

NAME

       CosNotifyChannelAdmin_ProxyPullSupplier - This module implements the OMG  CosNotifyChannelAdmin::ProxyPullSupplier 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_NotifySubscribe

	 * CosNotification_QoSAdmin

	 * CosNotifyFilter_FilterAdmin

	 * CosNotifyChannelAdmin_ProxySupplier

EXPORTS

       connect_any_pull_consumer(ProxyPullSupplier, PullConsumer) -> Reply

	      Types  ProxyPullSupplier = #objref
		     PullConsumer = #objref
		     Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}}

	      This  operation  connects the given PullConsumer to the target object. If a connection already exists the AlreadyConnected exception
	      is raised.

       pull(ProxyPullSupplier) -> Reply

	      Types  ProxyPullSupplier = #objref
		     Reply = #any | {'EXCEPTION', #'CosEventChannelAdmin_Disconnected'{}}

	      This operation pulls next #any{} event, and blocks, if the target object have no events to forward, until an event can be delivered.
	      If no client have been connected the Disconnected exception is raised.

       try_pull(ProxyPullSupplier) -> Reply

	      Types  ProxyPullSupplier = #objref
		     Reply = {#any, HasEvent} | {'EXCEPTION', #'CosEventChannelAdmin_Disconnected'{}}
		     HasEvent = boolean()

	      This  operation  pulls  next event, but do not block if the target object have no event to forward. If no client have been connected
	      the Disconnected exception is raised.

       disconnect_pull_supplier(ProxyPullSupplier) -> ok

	      Types  ProxyPullSupplier = #objref

	      Invoking this operation will cause the target object to close the connection and terminate.

Ericsson AB						      cosNotification 1.1.16		     CosNotifyChannelAdmin_ProxyPullSupplier(3erl)

CosEventChannelAdmin_ProxyPullSupplier(3erl)		     Erlang Module Definition		      CosEventChannelAdmin_ProxyPullSupplier(3erl)

NAME

       CosEventChannelAdmin_ProxyPullSupplier  -  This module implements a ProxyPullSupplier interface which acts as a middleman between pull con-
       sumer and the event channel.

DESCRIPTION

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

       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 ProxyPullSupplier interface can perform the following operations:

EXPORTS

       connect_pull_consumer(Object, PullConsumer) -> Return

	      Types  Object = #objref
		     PullConsumer = #objref of PullConsumer type
		     Return = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}}

	      This operation connects PullConsumer object to the ProxyPullSupplier object. A nil object reference can be passed to this operation.
	      If so a channel cannot invoke the disconnect_pull_consumer operation on the consumer; the consumer  may  be  disconnected  from  the
	      channel  without	being  informed.  If  the  ProxyPullSupplier  is  already connected to a PullConsumer, then the CosEventChannelAd-
	      min_AlreadyConnected exception is raised.

       disconnect_pull_supplier(Object) -> Return

	      Types  Object = #objref
		     Return = ok

	      This operation disconnects proxy pull supplier from the event channel. It sends a notification about the loss of the  connection	to
	      the pull consumer attached to it, unless nil object reference was passed at the connection time.

       pull(Object) -> Return

	      Types  Object = #objref
		     Return = any

	      This  operation  blocks until the event data is available or the CosEventComm_Disconnected exception is raised. It returns the event
	      data to the consumer.

       try_pull(Object) -> Return

	      Types  Object = #objref
		     Return = {any, bool()}

	      This operation does not block: if the event data is available, it returns the event data and sets  the  data  availability  flag	to
	      true;  otherwise	it  returns a long with an undefined value and sets the data availability to false. If the event communication has
	      already been disconnected, the CosEventComm_Disconnected exception is raised.

Ericsson AB							  cosEvent 2.1.10		      CosEventChannelAdmin_ProxyPullSupplier(3erl)