User's Guide
Reference Manual
Release Notes
PDF
Top

cosEvent
Reference Manual
Version 2.1.8

Expand All
Contract All

Table of Contents

# CosEventChannelAdmin_ProxyPushSupplier

### MODULE

CosEventChannelAdmin_ProxyPushSupplier

### MODULE SUMMARY

This module implements a ProxyPushSupplier interface which acts as a middleman between push consumer and the event channel.

### DESCRIPTION

The ProxyPushSupplier interface defines the second step for connecting push 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 ProxyPushSupplier interface can perform the following operations:

### EXPORTS

connect_push_consumer(Object, PushConsumer) -> Return

Types:

Object = #objref
PushConsumer = #objref of PushConsumer type
Return = ok | {'EXCEPTION', E}
E = #'CosEventChannelAdmin_AlreadyConnected'{} | #'CosEventChannelAdmin_TypeError'{}

This operation connects PushConsumer object to the ProxyPushSupplier object. If a nil object reference is passed CORBA standard BAD_PARAM exception is raised. If the ProxyPushSupplier is already connected to a PushConsumer, then the CosEventChannelAdmin_AlreadyConnected exception is raised. Implementations of ProxyPushSuppliers may require additional interface functionality; if these requirements are not met the CosEventChannelAdmin_TypeError exception will be raised.

disconnect_push_supplier(Object) -> Return

Types:

Object = #objref
Return = ok

This operation disconnects proxy push supplier from the event channel and sends a notification about the loss of the connection to the push consumer attached to it.