path: root/lib/cosNotification/doc/src/CosNotification.xml

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

<erlref>
  <header>
    <copyright>
      <year>2002</year>
      <year>2013</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>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>