diff options
Diffstat (limited to 'lib/cosNotification/doc/src/CosNotifyChannelAdmin_ProxyPullConsumer.xml')
| -rw-r--r-- | lib/cosNotification/doc/src/CosNotifyChannelAdmin_ProxyPullConsumer.xml | 113 |
1 files changed, 0 insertions, 113 deletions
diff --git a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_ProxyPullConsumer.xml b/lib/cosNotification/doc/src/CosNotifyChannelAdmin_ProxyPullConsumer.xml deleted file mode 100644 index caf572dee8..0000000000 --- a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_ProxyPullConsumer.xml +++ /dev/null @@ -1,113 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotifyChannelAdmin_ProxyPullConsumer</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved></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> - |