User's Guide
Reference Manual
Release Notes
PDF
Top

cosNotification
Reference Manual
Version 1.1.17

Expand All
Contract All

Table of Contents

# CosNotifyChannelAdmin_SequenceProxyPullConsumer

### MODULE

CosNotifyChannelAdmin_SequenceProxyPullConsumer

### MODULE SUMMARY

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

Types:

SequenceProxyPullConsumer = #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 supplied client does not support the functions pull_structured_events and try_pull_structured_events an exception is raised.

suspend_connection(SequenceProxyPullConsumer) -> Reply

Types:

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

If a connection exist, invoking this operation will suspend the connection until instructed otherwise. Otherwise, no client have been connected or this operation already have been invoked an exception is raised.

resume_connection(SequenceProxyPullConsumer) -> Reply

Types:

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

If an connection have been suspended this operation must be used to resume the connection. If the connection already is active or no client have been connected an exception is raised.

disconnect_sequence_pull_consumer(SequenceProxyPullConsumer) -> ok

Types:

SequenceProxyPullConsumer = #objref

This operation close the connection to the client and terminates the target object.