cosnotifychanneladmin_structuredproxypushconsumer(3erl) [linux man page]

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)

CosNotifyChannelAdmin_ProxyPullConsumer(3erl)		     Erlang Module Definition		     CosNotifyChannelAdmin_ProxyPullConsumer(3erl)

NAME

       CosNotifyChannelAdmin_ProxyPullConsumer - This module implements the OMG  CosNotifyChannelAdmin::ProxyPullConsumer 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_any_pull_supplier(ProxyPullConsumer, PullSupplier) -> Reply

	      Types  ProxyPullConsumer = #objref
		     PullSupplier = #objref
		     Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}} | {'EXCEPTION', #'CosEventChannelAdmin_TypeError'{}}

	      This operation connects the given PullSupplier to the target object. If a client is already connected the AlreadyConnected exception
	      will be raised. The client must support the operations pull and try_pull , otherwise the TypeError exception is raised.

       suspend_connection(ProxyPullConsumer) -> Reply

	      Types  ProxyPullConsumer = #objref
		     Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ConnectionAlreadyInactive'{}} | {'EXCEPTION', #'CosNotifyChannelAdmin_Not-
		     Connected'{}}

	      If  we want to temporarily suspend the connection with the target object this operation must be sued. If the connection already have
	      been suspended or no client have been connected an exception is raised.

       resume_connection(ProxyPullConsumer) -> Reply

	      Types  ProxyPullConsumer = #objref
		     Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ConnectionAlreadyActive'{}} |  {'EXCEPTION',  #'CosNotifyChannelAdmin_Not-
		     Connected'{}}

	      If The connection have been suspended earlier we can invoke this operation to reinstate the connection. If the connection already is
	      active or no client have been connected to the target object an exception is raised.

       disconnect_pull_consumer(ProxyPullConsumer) -> ok

	      Types  ProxyPullConsumer = #objref

	      Invoking this operation disconnects the client from the target object which then terminates and inform its administrative parent.

Ericsson AB						      cosNotification 1.1.16		     CosNotifyChannelAdmin_ProxyPullConsumer(3erl)