coseventchanneladmin_eventchannel(3erl) [linux man page]

CosEventChannelAdmin_EventChannel(3erl) 		     Erlang Module Definition			   CosEventChannelAdmin_EventChannel(3erl)

NAME

       CosEventChannelAdmin_EventChannel  -  This  module  implements an Event Channel interface, which plays the role of a  mediator between con-
       sumers and suppliers.

DESCRIPTION

       An event channel is an object that allows multiple suppliers to communicate with multiple consumers in  a  highly  decoupled,  asynchronous
       manner.	The event channel is built up incrementally. When an event channel is created no suppliers or consumers are connected to it. Event
       Channel can implement group communication by serving as a replicator, broadcaster, or multicaster that forward events from one or more sup-
       pliers to multiple consumers.

       It  is  up to the user to decide when an event channel is created and how references to the event channel are obtained. By representing the
       event channel as an object, it has all of the properties that apply to objects. One way to manage an event channel is to register it  in  a
       naming context, or export it through an operation on an object.

       To get access to all definitions 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

       for_consumers(Object) -> Return

	      Types  Object = #objref
		     Return = #objref

	      This operation returns a ConsumerAdmin object reference. If ConsumerAdmin object does not exist already it creates one.

       for_suppliers(Object) -> Return

	      Types  Object = #objref
		     Return = #objref

	      This operation returns a SupplierAdmin object reference. If SupplierAdmin object does not exist already it creates one.

       destroy(Object) -> Return

	      Types  Object = #objref
		     Return = #objref

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