CosNotifyChannelAdmin_StructuredProxyPullConsumer

This module implements the OMG CosNotifyChannelAdmin::StructuredProxyPullConsumer interface.

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

Functions

connect_structured_pull_supplier(StructuredProxyPullConsumer, PullSupplier) -> Reply

  • StructuredProxyPullConsumer = #objref
  • PullSupplier = #objref
  • Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}} | {'EXCEPTION', #'CosEventChannelAdmin_TypeError'{}}

This operation connects a PullSupplier to the target object. If a connection already exists or the given client object does not support the functions pull_structured_event and try_pull_structured_event an exception is raised.

suspend_connection(StructuredProxyPullConsumer) -> Reply

  • StructuredProxyPullConsumer = #objref
  • Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ConnectionAlreadyInactive'{}} | {'EXCEPTION', #'CosNotifyChannelAdmin_NotConnected'{}}

This operation suspends the connection between the target object and its client. If no connection exists or already suspended an exception is raised.

resume_connection(StructuredProxyPullConsumer) -> Reply

  • StructuredProxyPullConsumer = #objref
  • Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ConnectionAlreadyInactive'{}} | {'EXCEPTION', #'CosNotifyChannelAdmin_NotConnected'{}}

If the connection have been suspended this operation must be used if we want to resume the connection. If the connection already are active or no connection have been created an exception is raised.

disconnect_structured_pull_consumer(StructuredProxyPullConsumer) -> ok

  • StructuredProxyPullConsumer = #objref

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