From 84adefa331c4159d432d22840663c38f155cd4c1 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Fri, 20 Nov 2009 14:54:40 +0000 Subject: The R13B03 release. --- .../src/CosEventChannelAdmin_ProxyPushConsumer.xml | 99 ++++++++++++++++++++++ 1 file changed, 99 insertions(+) create mode 100644 lib/cosEvent/doc/src/CosEventChannelAdmin_ProxyPushConsumer.xml (limited to 'lib/cosEvent/doc/src/CosEventChannelAdmin_ProxyPushConsumer.xml') diff --git a/lib/cosEvent/doc/src/CosEventChannelAdmin_ProxyPushConsumer.xml b/lib/cosEvent/doc/src/CosEventChannelAdmin_ProxyPushConsumer.xml new file mode 100644 index 0000000000..2b50f8858a --- /dev/null +++ b/lib/cosEvent/doc/src/CosEventChannelAdmin_ProxyPushConsumer.xml @@ -0,0 +1,99 @@ + + + + +
+ + 1997 + 2007 + Ericsson AB, All Rights Reserved + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + The Initial Developer of the Original Code is Ericsson AB. + + + CosEventChannelAdmin_­ProxyPushConsumer + ..._ProxyPushConsumer + + + + + + 1997-11-13 + PA1 + CosEventChannelAdmin_ProxyPushConsumer.xml +
+ CosEventChannelAdmin_ProxyPushConsumer + This module implements a ProxyPushConsumer interface which acts as a middleman between push supplier and the event channel. + +

The ProxyPushConsumer interface defines the second step for connecting push + suppliers to the event channel. A proxy consumer is similar to a normal consumer, + but includes an additional method for connecting a supplier to the proxy + consumer.

+

To get access to all definitions, e.g., exceptions, + include necessary files by using:

+

Any object that possesses an object reference that supports the ProxyPushConsumer + interface can perform the following operations:

+ + + + connect_push_supplier(Object, PushSupplier) -> Return + Connect the push supplier to the proxy push consumer + + Object = #objref + PushSupplier = #objref of PushSupplier type + Return = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}} + + +

This operation connects PushSupplier object to the ProxyPushConsumer object. + A nil object reference can be passed to this operation. If so a channel + cannot invoke the disconnect_push_supplier operation on the supplier; + the supplier may be disconnected from the channel without being + informed. If the ProxyPushConsumer is already connected to a + PushSupplier, then the + exception is raised.

+ + + + disconnect_push_consumer(Object) -> Return + Disconnect the ProxyPushConsumer object from the event channel. + + Object = #objref + Return = ok + + +

This operation disconnects proxy push consumer from the event channel. + Sends a notification about the loss of the connection to the push supplier + attached to it, unless nil object reference was passed at the connection + time.

+ + + + push(Object, Data) -> Return + Communicate event data to the consumers. + + Object = #objref + Data = any + Return = ok | {'EXCEPTION', #'CosEventComm_Disconnected'{}} + + +

This operation sends event data to all connected consumers via the + event channel. If the event communication has already been disconnected, + the is raised.

+ + + + + + -- cgit v1.2.3