aboutsummaryrefslogtreecommitdiffstats
path: root/lib/cosNotification/doc/src/CosNotification.xml
blob: 6aac312d5e037653ef334cc9bfc440a146037733 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

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