coseventchanneladmin_proxypushconsumer(3erl) [linux man page]

CosEventChannelAdmin_ProxyPushConsumer(3erl)		     Erlang Module Definition		      CosEventChannelAdmin_ProxyPushConsumer(3erl)

NAME

       CosEventChannelAdmin_ProxyPushConsumer  -  This module implements a ProxyPushConsumer interface which acts as a middleman between push sup-
       plier and the event channel.

DESCRIPTION

       The ProxyPushConsumer interface defines the second step for connecting push 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 ProxyPushConsumer interface can perform the following operations:

EXPORTS

       connect_push_supplier(Object, PushSupplier) -> Return

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

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

       disconnect_push_consumer(Object) -> Return

	      Types  Object = #objref
		     Return = ok

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

       push(Object, Data) -> Return

	      Types  Object = #objref
		     Data = any
		     Return = ok | {'EXCEPTION', #'CosEventComm_Disconnected'{}}

	      This  operation  sends event data to all connected consumers via the event channel. If the event communication has already been dis-
	      connected, the CosEventComm_Disconnected is raised.

Ericsson AB							  cosEvent 2.1.10		      CosEventChannelAdmin_ProxyPushConsumer(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)