aboutsummaryrefslogtreecommitdiffstats
path: root/lib/cosEvent/doc/src/CosEventChannelAdmin_ConsumerAdmin.xml
diff options
context:
space:
mode:
authorErlang/OTP <[email protected]>2009-11-20 14:54:40 +0000
committerErlang/OTP <[email protected]>2009-11-20 14:54:40 +0000
commit84adefa331c4159d432d22840663c38f155cd4c1 (patch)
treebff9a9c66adda4df2106dfd0e5c053ab182a12bd /lib/cosEvent/doc/src/CosEventChannelAdmin_ConsumerAdmin.xml
downloadotp-84adefa331c4159d432d22840663c38f155cd4c1.tar.gz
otp-84adefa331c4159d432d22840663c38f155cd4c1.tar.bz2
otp-84adefa331c4159d432d22840663c38f155cd4c1.zip
The R13B03 release.OTP_R13B03
Diffstat (limited to 'lib/cosEvent/doc/src/CosEventChannelAdmin_ConsumerAdmin.xml')
-rw-r--r--lib/cosEvent/doc/src/CosEventChannelAdmin_ConsumerAdmin.xml73
1 files changed, 73 insertions, 0 deletions
diff --git a/lib/cosEvent/doc/src/CosEventChannelAdmin_ConsumerAdmin.xml b/lib/cosEvent/doc/src/CosEventChannelAdmin_ConsumerAdmin.xml
new file mode 100644
index 0000000000..e579d6f6f4
--- /dev/null
+++ b/lib/cosEvent/doc/src/CosEventChannelAdmin_ConsumerAdmin.xml
@@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="latin1" ?>
+<!DOCTYPE erlref SYSTEM "erlref.dtd">
+
+<erlref>
+ <header>
+ <copyright>
+ <year>1997</year>
+ <year>2007</year>
+ <holder>Ericsson AB, All Rights Reserved</holder>
+ </copyright>
+ <legalnotice>
+ 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.
+ </legalnotice>
+
+ <title>CosEventChannelAdmin_&shy;ConsumerAdmin</title>
+ <shorttitle>..._ConsumerAdmin</shorttitle>
+ <prepared></prepared>
+ <responsible></responsible>
+ <docno></docno>
+ <approved></approved>
+ <checked></checked>
+ <date>1997-11-13</date>
+ <rev>PA1</rev>
+ <file>CosEventChannelAdmin_ConsumerAdmin.xml</file>
+ </header>
+ <module>CosEventChannelAdmin_ConsumerAdmin</module>
+ <modulesummary>This module implements a ConsumerAdmin interface, which allows consumers to be connected to the event channel.</modulesummary>
+ <description>
+ <p>The ConsumerAdmin interface defines the first step for connecting consumers
+ to the event channel. It acts as a factory for creating proxy suppliers.
+ Both consumer administration and supplier administration are defined as separate
+ objects so that the creator of the channel can control the addition of
+ suppliers and consumers. </p>
+ <p>To get access to all definitions include necessary <c><![CDATA[hrl]]></c> files by using:<br></br><c><![CDATA[-include_lib("cosEvent/include/*.hrl").]]></c></p>
+ </description>
+ <funcs>
+ <func>
+ <name>obtain_push_supplier(Object) -> Return</name>
+ <fsummary>Create a ProxyPushSupplier object</fsummary>
+ <type>
+ <v>Object = #objref</v>
+ <v>Return = #objref</v>
+ </type>
+ <desc>
+ <p>This operation returns a ProxyPushSupplier object reference.</p>
+ </desc>
+ </func>
+ <func>
+ <name>obtain_pull_supplier(Object) -> Return</name>
+ <fsummary>Create a ProxyPullSupplier object</fsummary>
+ <type>
+ <v>Object = #objref</v>
+ <v>Return = #objref</v>
+ </type>
+ <desc>
+ <p>This operation returns a ProxyPullSupplier object reference.</p>
+ </desc>
+ </func>
+ </funcs>
+
+</erlref>
+