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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
|
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you 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.
-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>qpid::client::SubscriptionSettings Struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#FFFFFF">
<table border="0" width="90%" align="center">
<tr>
<td align="left">
<a title="Apache Qpid Project Page" href="http://qpid.apache.org">Apache Qpid - AMQP Messaging for Java JMS, C++, Python, Ruby, and .NET</a>
</td>
<td align="right">
<a title="Apache Qpid Documentation" href="http://qpid.apache.org/documentation.html">Apache Qpid Documentation</a>
</td>
</tr>
</table>
<!-- Generated by Doxygen 1.7.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a00574.html">qpid</a> </li>
<li class="navelem"><a class="el" href="a00576.html">client</a> </li>
<li class="navelem"><a class="el" href="a00353.html">SubscriptionSettings</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> </div>
<div class="headertitle">
<div class="title">qpid::client::SubscriptionSettings Struct Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="qpid::client::SubscriptionSettings" -->
<p>Settings for a subscription.
<a href="a00353.html#details">More...</a></p>
<p><code>#include <<a class="el" href="a00480_source.html">qpid/client/SubscriptionSettings.h</a>></code></p>
<p><a href="a00701.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00353.html#a980c973a01509fa5e7a1e5ef8e658dfb">SubscriptionSettings</a> (<a class="el" href="a00132.html">FlowControl</a> flow=FlowControl::unlimited(), <a class="el" href="a00586.html#a8d6ab87d62f2c2f1136e10f0a200f436">AcceptMode</a> accept=ACCEPT_MODE_EXPLICIT, <a class="el" href="a00586.html#ad010ae646e0187e26e02b829e77213d8">AcquireMode</a> acquire=ACQUIRE_MODE_PRE_ACQUIRED, unsigned int autoAck_=1, <a class="el" href="a00576.html#a42369ab37a91cfa7cd1702713dd211c8">CompletionMode</a> completion=COMPLETE_ON_DELIVERY)</td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00132.html">FlowControl</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00353.html#a66b49dcd06ffd6edce7d131b2dcc8c26">flowControl</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00586.html#a8d6ab87d62f2c2f1136e10f0a200f436">AcceptMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00353.html#a4b0f5918418310aa290e55acd7791db0">acceptMode</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">< Flow control settings. <a href="#a4b0f5918418310aa290e55acd7791db0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00586.html#ad010ae646e0187e26e02b829e77213d8">AcquireMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00353.html#a17a595e878e283a7cd53d7f7133928f7">acquireMode</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">< ACCEPT_MODE_EXPLICIT or ACCEPT_MODE_NONE <a href="#a17a595e878e283a7cd53d7f7133928f7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00353.html#abd5ab65d583da00e88a26d99e29a04bc">autoAck</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">< ACQUIRE_MODE_PRE_ACQUIRED or ACQUIRE_MODE_NOT_ACQUIRED <a href="#abd5ab65d583da00e88a26d99e29a04bc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00576.html#a42369ab37a91cfa7cd1702713dd211c8">CompletionMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00353.html#a17c7f3ad2e7d1cfd9b215659c9eab282">completionMode</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">In windowing mode, completion of a message will cause the credit used up by that message to be reallocated. <a href="#a17c7f3ad2e7d1cfd9b215659c9eab282"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00353.html#a22c04055189b60293c371d9ef7496222">exclusive</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If set, requests that no other subscriber be allowed to access the queue while this subscription is active. <a href="#a22c04055189b60293c371d9ef7496222"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Settings for a subscription. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a980c973a01509fa5e7a1e5ef8e658dfb"></a><!-- doxytag: member="qpid::client::SubscriptionSettings::SubscriptionSettings" ref="a980c973a01509fa5e7a1e5ef8e658dfb" args="(FlowControl flow=FlowControl::unlimited(), AcceptMode accept=ACCEPT_MODE_EXPLICIT, AcquireMode acquire=ACQUIRE_MODE_PRE_ACQUIRED, unsigned int autoAck_=1, CompletionMode completion=COMPLETE_ON_DELIVERY)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">qpid::client::SubscriptionSettings::SubscriptionSettings </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00132.html">FlowControl</a> </td>
<td class="paramname"><em>flow</em> = <code>FlowControl::unlimited()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00586.html#a8d6ab87d62f2c2f1136e10f0a200f436">AcceptMode</a> </td>
<td class="paramname"><em>accept</em> = <code>ACCEPT_MODE_EXPLICIT</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00586.html#ad010ae646e0187e26e02b829e77213d8">AcquireMode</a> </td>
<td class="paramname"><em>acquire</em> = <code>ACQUIRE_MODE_PRE_ACQUIRED</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>autoAck_</em> = <code>1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00576.html#a42369ab37a91cfa7cd1702713dd211c8">CompletionMode</a> </td>
<td class="paramname"><em>completion</em> = <code>COMPLETE_ON_DELIVERY</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00480_source.html#l00043">43</a> of file <a class="el" href="a00480_source.html">SubscriptionSettings.h</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a4b0f5918418310aa290e55acd7791db0"></a><!-- doxytag: member="qpid::client::SubscriptionSettings::acceptMode" ref="a4b0f5918418310aa290e55acd7791db0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00586.html#a8d6ab87d62f2c2f1136e10f0a200f436">AcceptMode</a> <a class="el" href="a00353.html#a4b0f5918418310aa290e55acd7791db0">qpid::client::SubscriptionSettings::acceptMode</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>< Flow control settings. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00132.html" title="Flow control works by associating a finite amount of "credit" with a subscription.">FlowControl</a> The <a class="el" href="a00353.html#a4b0f5918418310aa290e55acd7791db0" title="< Flow control settings.">acceptMode</a> determines whether the broker should expect delivery of messages to be acknowledged by the <a class="el" href="a00576.html">client</a> indicating that it accepts them. A value of ACCEPT_MODE_EXPLICIT means that messages must be accepted (note: this may be done automatically by the library - see <a class="el" href="a00353.html#abd5ab65d583da00e88a26d99e29a04bc" title="< ACQUIRE_MODE_PRE_ACQUIRED or ACQUIRE_MODE_NOT_ACQUIRED">autoAck</a> - or through an explicit call be the application - see <a class="el" href="a00351.html#ab432864f349dc55c2f49eebc20e134c4" title="Accept messageIds and remove them from the unaccepted set.">Subscription::accept()</a>) before they can be dequeued. A value of ACCEPT_MODE_NONE means that the broker can dequeue a message as soon as it is acquired. </dd></dl>
<p>Definition at line <a class="el" href="a00480_source.html#l00063">63</a> of file <a class="el" href="a00480_source.html">SubscriptionSettings.h</a>.</p>
</div>
</div>
<a class="anchor" id="a17a595e878e283a7cd53d7f7133928f7"></a><!-- doxytag: member="qpid::client::SubscriptionSettings::acquireMode" ref="a17a595e878e283a7cd53d7f7133928f7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00586.html#ad010ae646e0187e26e02b829e77213d8">AcquireMode</a> <a class="el" href="a00353.html#a17a595e878e283a7cd53d7f7133928f7">qpid::client::SubscriptionSettings::acquireMode</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>< ACCEPT_MODE_EXPLICIT or ACCEPT_MODE_NONE </p>
<p>The acquireMode determines whether messages are locked for the subscriber when delivered, and thus are not delivered to any other subscriber unless this subscriber releases them.</p>
<p>The default is ACQUIRE_MODE_PRE_ACQUIRED meaning that the subscriber expects to have been given that message exclusively (i.e. the message will not be given to any other subscriber unless released explicitly or by this subscribers session failing without having accepted the message).</p>
<p>Delivery of message in ACQUIRE_MODE_NOT_ACQUIRED mode means the message will still be available for other subscribers to receive. The application can if desired acquire a (set of) messages through an explicit acquire call - see <a class="el" href="a00351.html#ae876d4b0b942d0873d17d64655d683f4" title="Acquire messageIds and remove them from the unacquired set.">Subscription::acquire()</a>. </p>
<p>Definition at line <a class="el" href="a00480_source.html#l00081">81</a> of file <a class="el" href="a00480_source.html">SubscriptionSettings.h</a>.</p>
</div>
</div>
<a class="anchor" id="abd5ab65d583da00e88a26d99e29a04bc"></a><!-- doxytag: member="qpid::client::SubscriptionSettings::autoAck" ref="abd5ab65d583da00e88a26d99e29a04bc" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int <a class="el" href="a00353.html#abd5ab65d583da00e88a26d99e29a04bc">qpid::client::SubscriptionSettings::autoAck</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>< ACQUIRE_MODE_PRE_ACQUIRED or ACQUIRE_MODE_NOT_ACQUIRED </p>
<p>Configures the frequency at which messages are automatically accepted (e.g. a value of 5 means that messages are accepted in batches of 5). A value of 0 means no automatic acknowledgement will occur and the application will itself be responsible for accepting messages. </p>
<p>Definition at line <a class="el" href="a00480_source.html#l00090">90</a> of file <a class="el" href="a00480_source.html">SubscriptionSettings.h</a>.</p>
</div>
</div>
<a class="anchor" id="a17c7f3ad2e7d1cfd9b215659c9eab282"></a><!-- doxytag: member="qpid::client::SubscriptionSettings::completionMode" ref="a17c7f3ad2e7d1cfd9b215659c9eab282" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00576.html#a42369ab37a91cfa7cd1702713dd211c8">CompletionMode</a> <a class="el" href="a00353.html#a17c7f3ad2e7d1cfd9b215659c9eab282">qpid::client::SubscriptionSettings::completionMode</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>In windowing mode, completion of a message will cause the credit used up by that message to be reallocated. </p>
<p>The subscriptions completion mode controls how completion is managed.</p>
<p>If set to COMPLETE_ON_DELIVERY (which is the default), messages will be marked as completed once they have been received. The server will be explicitly notified of all completed messages for the session when the next accept is sent through the subscription (either explictly or through autAck). However the server may also periodically request information on the completed messages.</p>
<p>If set to COMPLETE_ON_ACCEPT, messages will be marked as completed once they are accepted (via the <a class="el" href="a00351.html" title="A handle to an active subscription.">Subscription</a> class) and the server will also be notified of all completed messages for the session.</p>
<p>If set to MANUAL_COMPLETION the application is responsible for completing messages (</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00328.html#a71b6f8e5c01c5ab1d8dba353f0c2dc6e">Session::markCompleted()</a>). </dd></dl>
<p>Definition at line <a class="el" href="a00480_source.html#l00113">113</a> of file <a class="el" href="a00480_source.html">SubscriptionSettings.h</a>.</p>
</div>
</div>
<a class="anchor" id="a22c04055189b60293c371d9ef7496222"></a><!-- doxytag: member="qpid::client::SubscriptionSettings::exclusive" ref="a22c04055189b60293c371d9ef7496222" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="a00353.html#a22c04055189b60293c371d9ef7496222">qpid::client::SubscriptionSettings::exclusive</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If set, requests that no other subscriber be allowed to access the queue while this subscription is active. </p>
<p>Definition at line <a class="el" href="a00480_source.html#l00118">118</a> of file <a class="el" href="a00480_source.html">SubscriptionSettings.h</a>.</p>
</div>
</div>
<a class="anchor" id="a66b49dcd06ffd6edce7d131b2dcc8c26"></a><!-- doxytag: member="qpid::client::SubscriptionSettings::flowControl" ref="a66b49dcd06ffd6edce7d131b2dcc8c26" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00132.html">FlowControl</a> <a class="el" href="a00353.html#a66b49dcd06ffd6edce7d131b2dcc8c26">qpid::client::SubscriptionSettings::flowControl</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00480_source.html#l00051">51</a> of file <a class="el" href="a00480_source.html">SubscriptionSettings.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>qpid/client/<a class="el" href="a00480_source.html">SubscriptionSettings.h</a></li>
</ul>
</div>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you 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.
-->
<hr size="1">
<address style="text-align: left;"><small>
Qpid C++ API Reference</small></address>
<address style="text-align: right;">
<small>
Generated on Thu May 10 2012 for Qpid C++ Client API by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.7.5</small>
</address>
</body>
</html>
|
