Erlang logo
User's Guide
Reference Manual
Release Notes
PDF
Top

cosNotification
Reference Manual
Version 1.1.12


Expand All
Contract All

Table of Contents

CosNotifyChannelAdmin_ProxyPushSupplier

MODULE

CosNotifyChannelAdmin_ProxyPushSupplier

MODULE SUMMARY

This module implements the OMG CosNotifyChannelAdmin::ProxyPushSupplier 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:

EXPORTS

connect_any_push_consumer(ProxyPushSupplier, PushConsumer) -> Reply

Types:

ProxyPushSupplier = #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 given client does not support the operation push an exception, AlreadyConnected and TypeError respectively, is raised.

suspend_connection(ProxyPushSupplier) -> Reply

Types:

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

This operation suspends the connection with the client object. If the connection already is suspended or no client have been associated an exception is raised.

resume_connection(ProxyPushSupplier) -> Reply

Types:

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

If a connection have been suspended earlier, calling this operation will resume the connection. If the connection already is active or no client have been connected an exception is raised.

disconnect_push_supplier(ProxyPushSupplier) -> ok

Types:

ProxyPushSupplier = #objref

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