coseventchanneladmin_proxypullsupplier(3erl) [linux man page]
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)
Check Out this Related Man Page
CosNotifyChannelAdmin_StructuredProxyPullSupplier(3erl) Erlang Module Definition CosNotifyChannelAdmin_StructuredProxyPullSupplier(3erl) NAME
CosNotifyChannelAdmin_StructuredProxyPullSupplier - This module implements the OMG CosNotifyChannelAdmin::StructuredProxyPullSupplier 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_NotifySubscribe * CosNotification_QoSAdmin * CosNotifyFilter_FilterAdmin * CosNotifyChannelAdmin_ProxySupplier EXPORTS
connect_structured_pull_consumer(StructuredProxyPullSupplier, PullConsumer) -> Reply Types StructuredProxyPullSupplier = #objref PullConsumer = #objref Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}} This operation connects a PullConsumer to the target object. If a connection already exists the AlreadyConnected exception is raised. pull_structured_event(StructuredProxyPullSupplier) -> Reply Types StructuredProxyPullSupplier = #objref Reply = StructuredEvent | {'EXCEPTION', #'CosEventChannelAdmin_Disconnected'{}} 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}] This operation pulls next event from the target object; if an event cannot be delivered this function blocks until an event arrives. try_pull_structured_event(StructuredProxyPullSupplier) -> Reply Types StructuredProxyPullSupplier = #objref Reply = {StructuredEvent, HasEvent} | {'EXCEPTION', #'CosEventChannelAdmin_Disconnected'{}} HasEvent = boolean() 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}] This operation try to pull next event from the target object. If no event have arrived an empty event is returned and the out param- eter HasEvent is set to false. Otherwise, the boolean flag is set to true and an valid event is returned. disconnect_structured_pull_supplier(StructuredProxyPullSupplier) -> ok Types StructuredProxyPullSupplier = #objref This operation cause the target object to close the connection and terminate. Ericsson AB cosNotification 1.1.16 CosNotifyChannelAdmin_StructuredProxyPullSupplier(3erl)