aboutsummaryrefslogblamecommitdiffstats
path: root/lib/cosEvent/doc/src/CosEventChannelAdmin_ConsumerAdmin.xml
blob: 80d36ba5c5da9926c200f8a55ba02c42bde908c5 (plain) (tree)
1
2
3
4
5
6
7
8
                                       





                                     
                       


                                                       




                                                                  
 




                                                                          



                                                            
                                                     













































                                                                                                                                                                       
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<erlref>
  <header>
    <copyright>
      <year>1997</year>
      <year>2016</year>
      <holder>Ericsson AB, All Rights Reserved</holder>
    </copyright>
    <legalnotice>
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at
 
      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

  The Initial Developer of the Original Code is Ericsson AB.
    </legalnotice>

    <title>CosEventChannelAdmin_ConsumerAdmin</title>
    <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>