User's Guide
Reference Manual
Release Notes
PDF
Top

cosNotification
Reference Manual
Version 1.1.17

Expand All
Contract All

Table of Contents

# CosNotifyChannelAdmin_SequenceProxyPushSupplier

### MODULE

CosNotifyChannelAdmin_SequenceProxyPushSupplier

### MODULE SUMMARY

This module implements the OMG CosNotifyChannelAdmin::SequenceProxyPushSupplier 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_sequence_push_consumer(SequenceProxyPushSupplier, PushConsumer) -> Reply

Types:

SequenceProxyPushSupplier = #objref
PushConsumer = #objref
Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}} | {'EXCEPTION', #'CosEventChannelAdmin_TypeError'{}}

This operation connects a PushConsumer to the target object. If a connection already exists or the function psuh_structured_events is not supported the exceptions AlreadyConnected or TypeError will be raised respectively.

suspend_connection(SequenceProxyPushSupplier) -> Reply

Types:

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

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

resume_connection(SequenceProxyPushSupplier) -> Reply

Types:

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

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

disconnect_sequence_push_supplier(SequenceProxyPushSupplier) -> ok

Types:

SequenceProxyPushSupplier = #objref

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