The R13B03 release.OTP_R13B03

1 files changed, 110 insertions, 0 deletions

diff --git a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_StructuredProxyPushConsumer.xml b/lib/cosNotification/doc/src/CosNotifyChannelAdmin_StructuredProxyPushConsumer.xml
new file mode 100644
index 0000000000..db7f1ddb44
--- /dev/null
+++ b/lib/cosNotification/doc/src/CosNotifyChannelAdmin_StructuredProxyPushConsumer.xml
@@ -0,0 +1,110 @@
+<?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;StructuredProxyPushConsumer</title>
+    <shorttitle>..._StructuredProxyPushConsumer</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_&shy;StructuredProxyPushConsumer</module>
+  <modulesummary>This module implements the OMG  CosNotifyChannelAdmin::StructuredProxyPushConsumer 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_structured_push_supplier(StructuredProxyPushConsumer, PushSupplier) -> Reply</name>
+      <fsummary>Connect a supplier to the proxy</fsummary>
+      <type>
+        <v>StructuredProxyPushConsumer = #objref</v>
+        <v>PushSupplier = #objref</v>
+        <v>Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}}</v>
+      </type>
+      <desc>
+        <p>This operation connects a <c>PushSupplier</c> to the target object. If a connection
+          already exists an exception is raised.</p>
+      </desc>
+    </func>
+    <func>
+      <name>push_structured_event(StructuredProxyPushConsumer, StructuredEvent) -> Reply</name>
+      <fsummary>Push a structured event to the proxy</fsummary>
+      <type>
+        <v>StructuredProxyPushConsumer = #objref</v>
+        <v>StructuredEvent = #'CosNotification_StructuredEvent'{header, filterable_data, remainder_of_body}</v>
+        <v>header = EventHeader</v>
+        <v>filterable_data = [#'CosNotification_Property'{name, value}]</v>
+        <v>name = string()</v>
+        <v>value = #any</v>
+        <v>remainder_of_body = #any</v>
+        <v>EventHeader = #'CosNotification_EventHeader'{fixed_header, variable_header}</v>
+        <v>fixed_header = FixedEventHeader</v>
+        <v>variable_header = OptionalHeaderFields</v>
+        <v>FixedEventHeader = #'CosNotification_FixedEventHeader'{event_type, event_name}</v>
+        <v>event_type = EventType</v>
+        <v>event_name = string()</v>
+        <v>EventType = #'CosNotification_EventType'{domain_name, type_name}</v>
+        <v>domain_name = type_name = string()</v>
+        <v>OptionalHeaderFields = [#'CosNotification_Property'{name, value}]</v>
+        <v>Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_Disconnected'{}}</v>
+      </type>
+      <desc>
+        <p>When a client want to push a new event to the target object this operation must be used.</p>
+      </desc>
+    </func>
+    <func>
+      <name>disconnect_structured_push_consumer(StructuredProxyPushConsumer) -> ok</name>
+      <fsummary>Close the connection and terminate the proxy</fsummary>
+      <type>
+        <v>StructuredProxyPushConsumer = #objref</v>
+      </type>
+      <desc>
+        <p>This operation cause the target object to close the connection and terminate.</p>
+      </desc>
+    </func>
+  </funcs>
+  
+</erlref>
+