~rdoering/ubuntu/karmic/erlang/fix-535090

<?xml version="1.0" encoding="latin1" ?>

<!DOCTYPE erlref SYSTEM "erlref.dtd">

 

<erlref>

  <header>

    <copyright>

      <year>2000</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>CosNotifyChannelAdmin_&shy;ProxyPullConsumer</title>

    <shorttitle>..._ProxyPullConsumer</shorttitle>

    <prepared>Niclas Eklund</prepared>

    <responsible>Niclas Eklund</responsible>

    <docno></docno>

    <approved>Niclas Eklund</approved>

    <checked></checked>

    <date>2000-02-01</date>

    <rev>1.0</rev>

  </header>

  <module>CosNotifyChannelAdmin_ProxyPullConsumer</module>

  <modulesummary>This module implements the OMG  CosNotifyChannelAdmin::ProxyPullConsumer interface.</modulesummary>

  <description>

    <p>To get access to the record definitions for the structures use:      <br></br>

<c>-include_lib("cosNotification/include/*.hrl").</c></p>

    <p>This module also exports the functions described in:</p>

    <list type="bulleted">

      <item>

        <p><seealso marker="CosNotifyComm_NotifyPublish">CosNotifyComm_NotifyPublish</seealso></p>

      </item>

      <item>

        <p><seealso marker="CosNotification_QoSAdmin">CosNotification_QoSAdmin</seealso></p>

      </item>

      <item>

        <p><seealso marker="CosNotifyFilter_FilterAdmin">CosNotifyFilter_FilterAdmin</seealso></p>

      </item>

      <item>

        <p><seealso marker="CosNotifyChannelAdmin_ProxyConsumer">CosNotifyChannelAdmin_ProxyConsumer</seealso></p>

      </item>

    </list>

  </description>

  <funcs>

    <func>

      <name>connect_any_pull_supplier(ProxyPullConsumer, PullSupplier) -> Reply</name>

      <fsummary>Connect a supplier to the proxy</fsummary>

      <type>

        <v>ProxyPullConsumer = #objref</v>

        <v>PullSupplier = #objref</v>

        <v>Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}} | {'EXCEPTION', #'CosEventChannelAdmin_TypeError'{}}</v>

      </type>

      <desc>

        <p>This operation connects the given <c>PullSupplier</c> to the target object.

          If a client is already connected the <c>AlreadyConnected</c> exception 

          will be raised. The client must support the operations <c>pull</c> and

          <c>try_pull</c>, otherwise the <c>TypeError</c> exception is raised.</p>

      </desc>

    </func>

    <func>

      <name>suspend_connection(ProxyPullConsumer) -> Reply</name>

      <fsummary>Suspend the connection between the client and the proxy</fsummary>

      <type>

        <v>ProxyPullConsumer = #objref</v>

        <v>Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ConnectionAlreadyInactive'{}} | {'EXCEPTION', #'CosNotifyChannelAdmin_NotConnected'{}}</v>

      </type>

      <desc>

        <p>If we want to temporarily suspend the connection with the target object this

          operation must be sued. If the connection already have been suspended or

          no client have been connected an exception is raised.</p>

      </desc>

    </func>

    <func>

      <name>resume_connection(ProxyPullConsumer) -> Reply</name>

      <fsummary>Resume a previously suspended connection with the proxy</fsummary>

      <type>

        <v>ProxyPullConsumer = #objref</v>

        <v>Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ConnectionAlreadyActive'{}} | {'EXCEPTION', #'CosNotifyChannelAdmin_NotConnected'{}}</v>

      </type>

      <desc>

        <p>If The connection have been suspended earlier we can invoke this operation to

          reinstate the connection. If the connection already is active or no client 

          have been connected to the target object an exception is raised.</p>

      </desc>

    </func>

    <func>

      <name>disconnect_pull_consumer(ProxyPullConsumer) -> ok</name>

      <fsummary>Close the connection and terminate the proxy</fsummary>

      <type>

        <v>ProxyPullConsumer = #objref</v>

      </type>

      <desc>

        <p>Invoking this operation disconnects the client from the target object which

          then terminates and inform its administrative parent.</p>

      </desc>

    </func>

  </funcs>

  

</erlref>