coseventchanneladmin(3erl) [linux man page]

CosEventChannelAdmin(3erl)				     Erlang Module Definition					CosEventChannelAdmin(3erl)

NAME

       CosEventChannelAdmin  -	The CosEventChannelAdmin defines a set if event service interfaces that  enables decoupled asynchronous communica-
       tion between objects and implements generic (untyped) version of the OMG COSS standard event service.

DESCRIPTION

       The event service defines two roles for objects: the supplier role and the consumer role. Suppliers supply event data to the event  channel
       and  consumers  receive event data from the channel. Suppliers do not need to know the identity of the consumers, and vice versa. Consumers
       and suppliers are connected to the event channel via proxies, which are managed by ConsumerAdmin and SupplierAdmin objects.

       There are four general models of communication. These are:

	 * The canonical push model. It allows the suppliers of events to initiate the transfer of event data to consumers.  Event  channels  play
	   the role of Notifier . Active suppliers use event channel to push data to passive consumers registered with the event channel.

	 * The canonical pull model. It allows consumers to request events from suppliers. Event channels play the role of Procure since they pro-
	   cure events on behalf of consumers. Active consumers can explicitly pull data from passive suppliers via the event channels.

	 * The hybrid push/pull model. It allows consumers request events queued at a channel by suppliers. Event channels play the role of  Queue
	   . Active consumers explicitly pull data deposited by active suppliers via the event channels.

	 * The	hybrid	pull/push  model.  It allows the channel to pull events from suppliers and push them to consumers. Event channels play the
	   role of Intelligent agent . Active event channels can pull data from passive suppliers to push it to passive consumers.

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

       There are seven different interfaces supported in the service:

	 * ProxyPushConsumer

	 * ProxyPullSupplier

	 * ProxyPullConsumer

	 * ProxyPushSupplier

	 * ConsumerAdmin

	 * SupplierAdmin

	 * EventChannel

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