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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
|
<!--
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::messaging Namespace 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 class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><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="namespaces.html"><span>Namespace List</span></a></li>
<li><a href="namespacemembers.html"><span>Namespace 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="a00591.html">messaging</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">qpid::messaging Namespace Reference</div> </div>
</div>
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html">Address</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Represents an address to which messages can be sent and from which messages can be received. <a href="a00003.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00059.html">Connection</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A connection represents a network connection to a remote endpoint. <a href="a00059.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00104.html">Duration</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A duration is a time in milliseconds. <a href="a00104.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00213.html">MessagingException</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is the base class for all messaging related exceptions thrown by this API. <a href="a00213.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00164.html">InvalidOptionString</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Thrown when the syntax of the option string used to configure a connection in not valid. <a href="a00164.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00184.html">KeyError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Thrown to indicate a failed lookup of some local object. <a href="a00184.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00188.html">LinkError</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html">AddressError</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00279.html">ResolutionError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Thrown when a syntactically correct address cannot be resolved or used. <a href="a00279.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00018.html">AssertionFailed</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Thrown when creating a sender or receiver for an address for which some asserted property of the node is not matched. <a href="a00018.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00227.html">NotFound</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Thrown on attempts to create a sender or receiver to a non-existent node. <a href="a00227.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00196.html">MalformedAddress</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Thrown when an address string with invalid syntax is used. <a href="a00196.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00272.html">ReceiverError</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html">FetchError</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00224.html">NoMessageAvailable</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Thrown by <a class="el" href="a00271.html#ac0819f612dfc58de03cbc95a39420925" title="Retrieves a message for this receivers subscription or waits for up to the specified timeout for one ...">Receiver::fetch()</a>, <a class="el" href="a00271.html#a1d708f9763a9b1f5aefb41002e7446e6" title="Retrieves a message from this receivers local queue, or waits for upto the specified timeout for a me...">Receiver::get()</a> and <a class="el" href="a00325.html#af633ded76d86d312c4114efa8480d3df" title="Retrieves the receiver for the next available message.">Session::nextReceiver()</a> to indicate that there no message was available before the timeout specified. <a href="a00224.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00320.html">SenderError</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00321.html">SendError</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00354.html">TargetCapacityExceeded</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Thrown to indicate that the sender attempted to send a message that would result in the target node on the peer exceeding a preconfigured capacity. <a href="a00354.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00330.html">SessionError</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00358.html">TransactionError</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00357.html">TransactionAborted</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Thrown on <a class="el" href="a00325.html#ad1135088120d995954e782dd5c8889c7" title="Commits the sessions transaction.">Session::commit()</a> if reconnection results in the transaction being automatically aborted. <a href="a00357.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00365.html">UnauthorizedAccess</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Thrown to indicate that the application attempted to do something for which it was not authorised by its peer. <a href="a00365.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html">ConnectionError</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00360.html">TransportFailure</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Thrown to indicate loss of underlying connection. <a href="a00360.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00120.html">FailoverUpdates</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A utility to listen for updates on cluster membership and update the list of known urls for a connection accordingly. <a href="a00120.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00139.html">Handle</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A handle is like a pointer: refers to an underlying implementation object. <a href="a00139.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00205.html">Message</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Representation of a message. <a href="a00205.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html">EncodingException</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00271.html">Receiver</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Interface through which messages are received. <a href="a00271.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00319.html">Sender</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Interface through which messages are sent. <a href="a00319.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00325.html">Session</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A session represents a distinct 'conversation' which can involve sending and receiving messages to and from different addresses. <a href="a00325.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00243.html">std::ostream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00591.html#a7f0b8d91af7827b93bfeba35a843168d">operator<<</a> (<a class="el" href="a00243.html">std::ostream</a> &out, const <a class="el" href="a00003.html">Address</a> &address)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00104.html">Duration</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00591.html#a459c51ff9d1561bacd2bce12548d95c7">operator*</a> (const <a class="el" href="a00104.html">Duration</a> &duration, uint64_t multiplier)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00104.html">Duration</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00591.html#a2b6e28b60be1fb6ca4a74f3d71c603f8">operator*</a> (uint64_t multiplier, const <a class="el" href="a00104.html">Duration</a> &duration)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00591.html#ad6b3c1090c7a9c977547c3b02fb92c21">operator==</a> (const <a class="el" href="a00104.html">Duration</a> &a, const <a class="el" href="a00104.html">Duration</a> &b)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00591.html#a2258913affedf4b9aed1b4c63eb30b20">operator!=</a> (const <a class="el" href="a00104.html">Duration</a> &a, const <a class="el" href="a00104.html">Duration</a> &b)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00591.html#ad37dfc262612bfde8fdc73e3a85ddf95">decode</a> (const <a class="el" href="a00205.html">Message</a> &message, <a class="el" href="a00385.html#ae4e24d890f56397299a6ebadb2dfa7f0">qpid::types::Variant::Map</a> &map, const <a class="el" href="a00345.html">std::string</a> &encoding=<a class="el" href="a00345.html">std::string</a>())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decodes message content into a Variant::Map. <a href="#ad37dfc262612bfde8fdc73e3a85ddf95"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00591.html#a69fce48e522c7cf19d587786512b02d3">decode</a> (const <a class="el" href="a00205.html">Message</a> &message, <a class="el" href="a00385.html#a8603092790e51851bc2166e9562a2e11">qpid::types::Variant::List</a> &list, const <a class="el" href="a00345.html">std::string</a> &encoding=<a class="el" href="a00345.html">std::string</a>())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decodes message content into a Variant::List. <a href="#a69fce48e522c7cf19d587786512b02d3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00591.html#afefbffac1ba55c37a1f7ab3a85ca753b">encode</a> (const <a class="el" href="a00385.html#ae4e24d890f56397299a6ebadb2dfa7f0">qpid::types::Variant::Map</a> &map, <a class="el" href="a00205.html">Message</a> &message, const <a class="el" href="a00345.html">std::string</a> &encoding=<a class="el" href="a00345.html">std::string</a>())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encodes a Variant::Map into a message. <a href="#afefbffac1ba55c37a1f7ab3a85ca753b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00591.html#a4ded93ce7f9698edc896106fef23e7ae">encode</a> (const <a class="el" href="a00385.html#a8603092790e51851bc2166e9562a2e11">qpid::types::Variant::List</a> &list, <a class="el" href="a00205.html">Message</a> &message, const <a class="el" href="a00345.html">std::string</a> &encoding=<a class="el" href="a00345.html">std::string</a>())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encodes a Variant::List into a message. <a href="#a4ded93ce7f9698edc896106fef23e7ae"></a><br/></td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ad37dfc262612bfde8fdc73e3a85ddf95"></a><!-- doxytag: member="qpid::messaging::decode" ref="ad37dfc262612bfde8fdc73e3a85ddf95" args="(const Message &message, qpid::types::Variant::Map &map, const std::string &encoding=std::string())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void qpid::messaging::decode </td>
<td>(</td>
<td class="paramtype">const Message & </td>
<td class="paramname"><em>message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00385.html#ae4e24d890f56397299a6ebadb2dfa7f0">qpid::types::Variant::Map</a> & </td>
<td class="paramname"><em>map</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00345.html">std::string</a> & </td>
<td class="paramname"><em>encoding</em> = <code><a class="el" href="a00345.html">std::string</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decodes message content into a Variant::Map. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">message</td><td>the message whose content should be decoded </td></tr>
<tr><td class="paramname">map</td><td>the map into which the message contents will be decoded </td></tr>
<tr><td class="paramname">encoding</td><td>if specified, the encoding to use - this overrides any encoding specified by the content-type of the message </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00106.html">EncodingException</a></td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a69fce48e522c7cf19d587786512b02d3"></a><!-- doxytag: member="qpid::messaging::decode" ref="a69fce48e522c7cf19d587786512b02d3" args="(const Message &message, qpid::types::Variant::List &list, const std::string &encoding=std::string())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void qpid::messaging::decode </td>
<td>(</td>
<td class="paramtype">const Message & </td>
<td class="paramname"><em>message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00385.html#a8603092790e51851bc2166e9562a2e11">qpid::types::Variant::List</a> & </td>
<td class="paramname"><em>list</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00345.html">std::string</a> & </td>
<td class="paramname"><em>encoding</em> = <code><a class="el" href="a00345.html">std::string</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decodes message content into a Variant::List. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">message</td><td>the message whose content should be decoded </td></tr>
<tr><td class="paramname">list</td><td>the list into which the message contents will be decoded </td></tr>
<tr><td class="paramname">encoding</td><td>if specified, the encoding to use - this overrides any encoding specified by the content-type of the message </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00106.html">EncodingException</a></td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="afefbffac1ba55c37a1f7ab3a85ca753b"></a><!-- doxytag: member="qpid::messaging::encode" ref="afefbffac1ba55c37a1f7ab3a85ca753b" args="(const qpid::types::Variant::Map &map, Message &message, const std::string &encoding=std::string())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void qpid::messaging::encode </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00385.html#ae4e24d890f56397299a6ebadb2dfa7f0">qpid::types::Variant::Map</a> & </td>
<td class="paramname"><em>map</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Message & </td>
<td class="paramname"><em>message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00345.html">std::string</a> & </td>
<td class="paramname"><em>encoding</em> = <code><a class="el" href="a00345.html">std::string</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encodes a Variant::Map into a message. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">map</td><td>the map to be encoded </td></tr>
<tr><td class="paramname">message</td><td>the message whose content should be set to the encoded map </td></tr>
<tr><td class="paramname">encoding</td><td>if specified, the encoding to use - this overrides any encoding specified by the content-type of the message </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00106.html">EncodingException</a></td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4ded93ce7f9698edc896106fef23e7ae"></a><!-- doxytag: member="qpid::messaging::encode" ref="a4ded93ce7f9698edc896106fef23e7ae" args="(const qpid::types::Variant::List &list, Message &message, const std::string &encoding=std::string())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void qpid::messaging::encode </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00385.html#a8603092790e51851bc2166e9562a2e11">qpid::types::Variant::List</a> & </td>
<td class="paramname"><em>list</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Message & </td>
<td class="paramname"><em>message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00345.html">std::string</a> & </td>
<td class="paramname"><em>encoding</em> = <code><a class="el" href="a00345.html">std::string</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encodes a Variant::List into a message. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">list</td><td>the list to be encoded </td></tr>
<tr><td class="paramname">message</td><td>the message whose content should be set to the encoded list </td></tr>
<tr><td class="paramname">encoding</td><td>if specified, the encoding to use - this overrides any encoding specified by the content-type of the message </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00106.html">EncodingException</a></td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2258913affedf4b9aed1b4c63eb30b20"></a><!-- doxytag: member="qpid::messaging::operator!=" ref="a2258913affedf4b9aed1b4c63eb30b20" args="(const Duration &a, const Duration &b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool qpid::messaging::operator!= </td>
<td>(</td>
<td class="paramtype">const Duration & </td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Duration & </td>
<td class="paramname"><em>b</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a459c51ff9d1561bacd2bce12548d95c7"></a><!-- doxytag: member="qpid::messaging::operator*" ref="a459c51ff9d1561bacd2bce12548d95c7" args="(const Duration &duration, uint64_t multiplier)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00104.html">Duration</a> qpid::messaging::operator* </td>
<td>(</td>
<td class="paramtype">const Duration & </td>
<td class="paramname"><em>duration</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>multiplier</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a2b6e28b60be1fb6ca4a74f3d71c603f8"></a><!-- doxytag: member="qpid::messaging::operator*" ref="a2b6e28b60be1fb6ca4a74f3d71c603f8" args="(uint64_t multiplier, const Duration &duration)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00104.html">Duration</a> qpid::messaging::operator* </td>
<td>(</td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>multiplier</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Duration & </td>
<td class="paramname"><em>duration</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a7f0b8d91af7827b93bfeba35a843168d"></a><!-- doxytag: member="qpid::messaging::operator<<" ref="a7f0b8d91af7827b93bfeba35a843168d" args="(std::ostream &out, const Address &address)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00243.html">std::ostream</a>& qpid::messaging::operator<< </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00243.html">std::ostream</a> & </td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Address & </td>
<td class="paramname"><em>address</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ad6b3c1090c7a9c977547c3b02fb92c21"></a><!-- doxytag: member="qpid::messaging::operator==" ref="ad6b3c1090c7a9c977547c3b02fb92c21" args="(const Duration &a, const Duration &b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool qpid::messaging::operator== </td>
<td>(</td>
<td class="paramtype">const Duration & </td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Duration & </td>
<td class="paramname"><em>b</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
</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>
|
