aboutsummaryrefslogtreecommitdiffstats
path: root/lib/cosNotification/doc/src/CosNotification.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/cosNotification/doc/src/CosNotification.xml
downloadotp-84adefa331c4159d432d22840663c38f155cd4c1.tar.gz
otp-84adefa331c4159d432d22840663c38f155cd4c1.tar.bz2
otp-84adefa331c4159d432d22840663c38f155cd4c1.zip
The R13B03 release.OTP_R13B03
Diffstat (limited to 'lib/cosNotification/doc/src/CosNotification.xml')
-rw-r--r--lib/cosNotification/doc/src/CosNotification.xml234
1 files changed, 234 insertions, 0 deletions
diff --git a/lib/cosNotification/doc/src/CosNotification.xml b/lib/cosNotification/doc/src/CosNotification.xml
new file mode 100644
index 0000000000..22e9bcb27c
--- /dev/null
+++ b/lib/cosNotification/doc/src/CosNotification.xml
@@ -0,0 +1,234 @@
+<?xml version="1.0" encoding="latin1" ?>
+<!DOCTYPE erlref SYSTEM "erlref.dtd">
+
+<erlref>
+ <header>
+ <copyright>
+ <year>2002</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>CosNotification</title>
+ <prepared>Niclas Eklund</prepared>
+ <responsible>Niclas Eklund</responsible>
+ <docno></docno>
+ <approved>Niclas Eklund</approved>
+ <checked></checked>
+ <date>2002-02-05</date>
+ <rev>PA1</rev>
+ </header>
+ <module>CosNotification</module>
+ <modulesummary>This module export functions which return QoS and Admin Properties constants.</modulesummary>
+ <description>
+ <p>To get access to all definitions include necessary <c>hrl</c> files by using: <br></br>
+<c>-include_lib("cosNotification/include/*.hrl").</c></p>
+ </description>
+ <funcs>
+ <func>
+ <name>'EventReliability'() -> string()</name>
+ <fsummary>Return the EventReliability QoS identifier</fsummary>
+ <desc>
+ <p>This function returns the EventReliability QoS identifier</p>
+ </desc>
+ </func>
+ <func>
+ <name>'BestEffort'() -> short()</name>
+ <fsummary>Return the BestEffort QoS value</fsummary>
+ <desc>
+ <p>This function returns the BestEffort QoS value.</p>
+ </desc>
+ </func>
+ <func>
+ <name>'Persistent'() -> short()</name>
+ <fsummary>Return the Persistent QoS value</fsummary>
+ <desc>
+ <p>This function returns the Persistent QoS value.</p>
+ </desc>
+ </func>
+ <func>
+ <name>'ConnectionReliability'() -> string()</name>
+ <fsummary>Return the ConnectionReliability QoS identifier</fsummary>
+ <desc>
+ <p>This function returns the ConnectionReliability QoS identifier.</p>
+ </desc>
+ </func>
+ <func>
+ <name>'Priority'() -> string()</name>
+ <fsummary>Return the Priority QoS identifier</fsummary>
+ <desc>
+ <p>This function returns the Priority QoS identifier.</p>
+ </desc>
+ </func>
+ <func>
+ <name>'LowestPriority'() -> short()</name>
+ <fsummary>Return the LowestPriority QoS value</fsummary>
+ <desc>
+ <p>This function returns the LowestPriority QoS value.</p>
+ </desc>
+ </func>
+ <func>
+ <name>'HighestPriority'() -> short()</name>
+ <fsummary>Return the HighestPriority QoS value</fsummary>
+ <desc>
+ <p>This function returns the HighestPriority QoS value.</p>
+ </desc>
+ </func>
+ <func>
+ <name>'DefaultPriority'() -> short()</name>
+ <fsummary>Return the DefaultPriority QoS value</fsummary>
+ <desc>
+ <p>This function returns the DefaultPriority QoS value.</p>
+ </desc>
+ </func>
+ <func>
+ <name>'StartTime'() -> string()</name>
+ <fsummary>Return the StartTime QoS identifier</fsummary>
+ <desc>
+ <p>This function returns the StartTime QoS identifier.</p>
+ </desc>
+ </func>
+ <func>
+ <name>'StopTime'() -> string()</name>
+ <fsummary>Return the StopTime QoS identifier</fsummary>
+ <desc>
+ <p>This function returns the StopTime QoS identifier.</p>
+ </desc>
+ </func>
+ <func>
+ <name>'Timeout'() -> string()</name>
+ <fsummary>Return the Timeout QoS identifier</fsummary>
+ <desc>
+ <p>This function returns the Timeout QoS identifier.</p>
+ </desc>
+ </func>
+ <func>
+ <name>'OrderPolicy'() -> string()</name>
+ <fsummary>Return the OrderPolicy QoS identifier</fsummary>
+ <desc>
+ <p>This function returns the OrderPolicy QoS identifier.</p>
+ </desc>
+ </func>
+ <func>
+ <name>'AnyOrder'() -> short()</name>
+ <fsummary>Return the AnyOrder QoS value</fsummary>
+ <desc>
+ <p>This function returns the AnyOrder QoS value.</p>
+ </desc>
+ </func>
+ <func>
+ <name>'FifoOrder'() -> short()</name>
+ <fsummary>Return the FifoOrder QoS value</fsummary>
+ <desc>
+ <p>This function returns the FifoOrder QoS value.</p>
+ </desc>
+ </func>
+ <func>
+ <name>'PriorityOrder'() -> short()</name>
+ <fsummary>Return the PriorityOrder QoS value</fsummary>
+ <desc>
+ <p>This function returns the PriorityOrder QoS value.</p>
+ </desc>
+ </func>
+ <func>
+ <name>'DeadlineOrder'() -> short()</name>
+ <fsummary>Return the DeadlineOrder QoS value</fsummary>
+ <desc>
+ <p>This function returns the DeadlineOrder QoS value.</p>
+ </desc>
+ </func>
+ <func>
+ <name>'DiscardPolicy'() -> string()</name>
+ <fsummary>Return the DiscardPolicy QoS identifier</fsummary>
+ <desc>
+ <p>This function returns the DiscardPolicy QoS identifier.</p>
+ </desc>
+ </func>
+ <func>
+ <name>'LifoOrder'() -> short()</name>
+ <fsummary>Return the LifoOrder QoS value</fsummary>
+ <desc>
+ <p>This function returns the LifoOrder QoS value.</p>
+ </desc>
+ </func>
+ <func>
+ <name>'RejectNewEvents'() -> short()</name>
+ <fsummary>Return the RejectNewEvents QoS value</fsummary>
+ <desc>
+ <p>This function returns the RejectNewEvents QoS value.</p>
+ </desc>
+ </func>
+ <func>
+ <name>'MaximumBatchSize'() -> string()</name>
+ <fsummary>Return the MaximumBatchSize QoS identifier</fsummary>
+ <desc>
+ <p>This function returns the MaximumBatchSize QoS identifier.</p>
+ </desc>
+ </func>
+ <func>
+ <name>'PacingInterval'() -> string()</name>
+ <fsummary>Return the PacingInterval QoS identifier</fsummary>
+ <desc>
+ <p>This function returns the PacingInterval QoS identifier.</p>
+ </desc>
+ </func>
+ <func>
+ <name>'StartTimeSupported'() -> string()</name>
+ <fsummary>Return the StartTimeSupported QoS identifier</fsummary>
+ <desc>
+ <p>This function returns the StartTimeSupported QoS identifier.</p>
+ </desc>
+ </func>
+ <func>
+ <name>'StopTimeSupported'() -> string()</name>
+ <fsummary>Return the StopTimeSupported QoS identifier</fsummary>
+ <desc>
+ <p>This function returns the StopTimeSupported QoS identifier.</p>
+ </desc>
+ </func>
+ <func>
+ <name>'MaxEventsPerConsumer'() -> string()</name>
+ <fsummary>Return the MaxEventsPerConsumer QoS identifier</fsummary>
+ <desc>
+ <p>This function returns the MaxEventsPerConsumer QoS identifier.</p>
+ </desc>
+ </func>
+ <func>
+ <name>'MaxQueueLength'() -> string()</name>
+ <fsummary>Return the MaxQueueLength Admin identifier</fsummary>
+ <desc>
+ <p>This function returns the MaxQueueLength Admin identifier.</p>
+ </desc>
+ </func>
+ <func>
+ <name>'MaxConsumers'() -> string()</name>
+ <fsummary>Return the MaxConsumers Admin identifier</fsummary>
+ <desc>
+ <p>This function returns the MaxConsumers Admin identifier.</p>
+ </desc>
+ </func>
+ <func>
+ <name>'MaxSuppliers'() -> string()</name>
+ <fsummary>Return the MaxSuppliers Admin identifier</fsummary>
+ <desc>
+ <p>This function returns the MaxSuppliers Admin identifier.</p>
+ </desc>
+ </func>
+ </funcs>
+
+</erlref>
+