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)

CosNotifyChannelAdmin_StructuredProxyPushConsumer(3erl)      Erlang Module Definition	   CosNotifyChannelAdmin_StructuredProxyPushConsumer(3erl)

NAME

       CosNotifyChannelAdmin_StructuredProxyPushConsumer  -  This  module  implements  the OMG	CosNotifyChannelAdmin::StructuredProxyPushConsumer
       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_structured_push_supplier(StructuredProxyPushConsumer, PushSupplier) -> Reply

	      Types  StructuredProxyPushConsumer = #objref
		     PushSupplier = #objref
		     Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}}

	      This operation connects a PushSupplier to the target object. If a connection already exists an exception is raised.

       push_structured_event(StructuredProxyPushConsumer, StructuredEvent) -> Reply

	      Types  StructuredProxyPushConsumer = #objref
		     StructuredEvent = #'CosNotification_StructuredEvent'{header, filterable_data, remainder_of_body}
		     header = EventHeader
		     filterable_data = [#'CosNotification_Property'{name, value}]
		     name = string()
		     value = #any
		     remainder_of_body = #any
		     EventHeader = #'CosNotification_EventHeader'{fixed_header, variable_header}
		     fixed_header = FixedEventHeader
		     variable_header = OptionalHeaderFields
		     FixedEventHeader = #'CosNotification_FixedEventHeader'{event_type, event_name}
		     event_type = EventType
		     event_name = string()
		     EventType = #'CosNotification_EventType'{domain_name, type_name}
		     domain_name = type_name = string()
		     OptionalHeaderFields = [#'CosNotification_Property'{name, value}]
		     Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_Disconnected'{}}

	      When a client want to push a new event to the target object this operation must be used.

       disconnect_structured_push_consumer(StructuredProxyPushConsumer) -> ok

	      Types  StructuredProxyPushConsumer = #objref

	      This operation cause the target object to close the connection and terminate.

Ericsson AB						      cosNotification 1.1.16	   CosNotifyChannelAdmin_StructuredProxyPushConsumer(3erl)