/usr/share/proton-0.10/docs/api-c/a00047.html is in libqpid-proton2-dev-doc 0.10-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>proton: Disposition</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">proton
 <span id="projectnumber">0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Disposition<div class="ingroups"><a class="el" href="a00048.html">Engine</a> » <a class="el" href="a00046.html">Delivery</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaae349c977b37b584aa62fff6515802ca"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#gaae349c977b37b584aa62fff6515802ca">PN_RECEIVED</a>   (0x0000000000000023)</td></tr>
<tr class="memdesc:gaae349c977b37b584aa62fff6515802ca"><td class="mdescLeft"> </td><td class="mdescRight">The PN_RECEIVED delivery state is a non terminal state indicating how much (if any) message data has been received for a delivery. <a href="#gaae349c977b37b584aa62fff6515802ca">More...</a><br /></td></tr>
<tr class="separator:gaae349c977b37b584aa62fff6515802ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac64952b813a707586c6b3898e09552e4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#gac64952b813a707586c6b3898e09552e4">PN_ACCEPTED</a>   (0x0000000000000024)</td></tr>
<tr class="memdesc:gac64952b813a707586c6b3898e09552e4"><td class="mdescLeft"> </td><td class="mdescRight">The PN_ACCEPTED delivery state is a terminal state indicating that the delivery was successfully processed. <a href="#gac64952b813a707586c6b3898e09552e4">More...</a><br /></td></tr>
<tr class="separator:gac64952b813a707586c6b3898e09552e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga44a2635392fe2e6f8869a7e1cd64db2f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga44a2635392fe2e6f8869a7e1cd64db2f">PN_REJECTED</a>   (0x0000000000000025)</td></tr>
<tr class="memdesc:ga44a2635392fe2e6f8869a7e1cd64db2f"><td class="mdescLeft"> </td><td class="mdescRight">The PN_REJECTED delivery state is a terminal state indicating that the delivery could not be processed due to some error condition. <a href="#ga44a2635392fe2e6f8869a7e1cd64db2f">More...</a><br /></td></tr>
<tr class="separator:ga44a2635392fe2e6f8869a7e1cd64db2f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga628179c16c4a5f5fd7734bc1bfc6edc3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga628179c16c4a5f5fd7734bc1bfc6edc3">PN_RELEASED</a>   (0x0000000000000026)</td></tr>
<tr class="memdesc:ga628179c16c4a5f5fd7734bc1bfc6edc3"><td class="mdescLeft"> </td><td class="mdescRight">The PN_RELEASED delivery state is a terminal state indicating that the delivery is being returned to the sender. <a href="#ga628179c16c4a5f5fd7734bc1bfc6edc3">More...</a><br /></td></tr>
<tr class="separator:ga628179c16c4a5f5fd7734bc1bfc6edc3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga247e3d1ac7c9096cdd28424353582962"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga247e3d1ac7c9096cdd28424353582962">PN_MODIFIED</a>   (0x0000000000000027)</td></tr>
<tr class="memdesc:ga247e3d1ac7c9096cdd28424353582962"><td class="mdescLeft"> </td><td class="mdescRight">The PN_MODIFIED delivery state is a terminal state indicating that the delivery is being returned to the sender and should be annotated by the sender prior to further delivery attempts. <a href="#ga247e3d1ac7c9096cdd28424353582962">More...</a><br /></td></tr>
<tr class="separator:ga247e3d1ac7c9096cdd28424353582962"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga4b28f6cd033babd8a7595fc5d292dca1"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a></td></tr>
<tr class="memdesc:ga4b28f6cd033babd8a7595fc5d292dca1"><td class="mdescLeft"> </td><td class="mdescRight">Dispositions record the current state and/or final outcome of a transfer. <a href="#ga4b28f6cd033babd8a7595fc5d292dca1">More...</a><br /></td></tr>
<tr class="separator:ga4b28f6cd033babd8a7595fc5d292dca1"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga56f357a15193cfb221ce497d1f48022d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga56f357a15193cfb221ce497d1f48022d">pn_disposition_type</a> (<a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *disposition)</td></tr>
<tr class="memdesc:ga56f357a15193cfb221ce497d1f48022d"><td class="mdescLeft"> </td><td class="mdescRight">Get the type of a disposition. <a href="#ga56f357a15193cfb221ce497d1f48022d">More...</a><br /></td></tr>
<tr class="separator:ga56f357a15193cfb221ce497d1f48022d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabd35f46e997ed687d715302480d011e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00043.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#gabd35f46e997ed687d715302480d011e2">pn_disposition_condition</a> (<a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *disposition)</td></tr>
<tr class="memdesc:gabd35f46e997ed687d715302480d011e2"><td class="mdescLeft"> </td><td class="mdescRight">Access the condition object associated with a disposition. <a href="#gabd35f46e997ed687d715302480d011e2">More...</a><br /></td></tr>
<tr class="separator:gabd35f46e997ed687d715302480d011e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga451f0c749032dad08b6f960aba3416da"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00042.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga451f0c749032dad08b6f960aba3416da">pn_disposition_data</a> (<a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *disposition)</td></tr>
<tr class="memdesc:ga451f0c749032dad08b6f960aba3416da"><td class="mdescLeft"> </td><td class="mdescRight">Access the disposition as a raw pn_data_t. <a href="#ga451f0c749032dad08b6f960aba3416da">More...</a><br /></td></tr>
<tr class="separator:ga451f0c749032dad08b6f960aba3416da"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabcf704fae3e555374ab180befc5b8278"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#gabcf704fae3e555374ab180befc5b8278">pn_disposition_get_section_number</a> (<a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *disposition)</td></tr>
<tr class="memdesc:gabcf704fae3e555374ab180befc5b8278"><td class="mdescLeft"> </td><td class="mdescRight">Get the section number associated with a disposition. <a href="#gabcf704fae3e555374ab180befc5b8278">More...</a><br /></td></tr>
<tr class="separator:gabcf704fae3e555374ab180befc5b8278"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0b9c83f249965f9588ee0fd41ce77ced"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga0b9c83f249965f9588ee0fd41ce77ced">pn_disposition_set_section_number</a> (<a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *disposition, uint32_t section_number)</td></tr>
<tr class="memdesc:ga0b9c83f249965f9588ee0fd41ce77ced"><td class="mdescLeft"> </td><td class="mdescRight">Set the section number associated with a disposition. <a href="#ga0b9c83f249965f9588ee0fd41ce77ced">More...</a><br /></td></tr>
<tr class="separator:ga0b9c83f249965f9588ee0fd41ce77ced"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga55e4389018c1dc7b026938d2a95eb0c1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga55e4389018c1dc7b026938d2a95eb0c1">pn_disposition_get_section_offset</a> (<a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *disposition)</td></tr>
<tr class="memdesc:ga55e4389018c1dc7b026938d2a95eb0c1"><td class="mdescLeft"> </td><td class="mdescRight">Get the section offset associated with a disposition. <a href="#ga55e4389018c1dc7b026938d2a95eb0c1">More...</a><br /></td></tr>
<tr class="separator:ga55e4389018c1dc7b026938d2a95eb0c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga900c1f88996063c495e4a370c14d5105"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga900c1f88996063c495e4a370c14d5105">pn_disposition_set_section_offset</a> (<a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *disposition, uint64_t section_offset)</td></tr>
<tr class="memdesc:ga900c1f88996063c495e4a370c14d5105"><td class="mdescLeft"> </td><td class="mdescRight">Set the section offset associated with a disposition. <a href="#ga900c1f88996063c495e4a370c14d5105">More...</a><br /></td></tr>
<tr class="separator:ga900c1f88996063c495e4a370c14d5105"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga52d49cfa7973e052b25343f5b150dcac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga52d49cfa7973e052b25343f5b150dcac">pn_disposition_is_failed</a> (<a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *disposition)</td></tr>
<tr class="memdesc:ga52d49cfa7973e052b25343f5b150dcac"><td class="mdescLeft"> </td><td class="mdescRight">Check if a disposition has the failed flag set. <a href="#ga52d49cfa7973e052b25343f5b150dcac">More...</a><br /></td></tr>
<tr class="separator:ga52d49cfa7973e052b25343f5b150dcac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae4fe77f776c68cadf36ce1d11bed30b1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#gae4fe77f776c68cadf36ce1d11bed30b1">pn_disposition_set_failed</a> (<a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *disposition, bool failed)</td></tr>
<tr class="memdesc:gae4fe77f776c68cadf36ce1d11bed30b1"><td class="mdescLeft"> </td><td class="mdescRight">Set the failed flag on a disposition. <a href="#gae4fe77f776c68cadf36ce1d11bed30b1">More...</a><br /></td></tr>
<tr class="separator:gae4fe77f776c68cadf36ce1d11bed30b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3bc9fc23bc5c67fe0704af901739afe6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga3bc9fc23bc5c67fe0704af901739afe6">pn_disposition_is_undeliverable</a> (<a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *disposition)</td></tr>
<tr class="memdesc:ga3bc9fc23bc5c67fe0704af901739afe6"><td class="mdescLeft"> </td><td class="mdescRight">Check if a disposition has the undeliverable flag set. <a href="#ga3bc9fc23bc5c67fe0704af901739afe6">More...</a><br /></td></tr>
<tr class="separator:ga3bc9fc23bc5c67fe0704af901739afe6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf82a7d54887104bdced67a2e95510e38"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#gaf82a7d54887104bdced67a2e95510e38">pn_disposition_set_undeliverable</a> (<a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *disposition, bool undeliverable)</td></tr>
<tr class="memdesc:gaf82a7d54887104bdced67a2e95510e38"><td class="mdescLeft"> </td><td class="mdescRight">Set the undeliverable flag on a disposition. <a href="#gaf82a7d54887104bdced67a2e95510e38">More...</a><br /></td></tr>
<tr class="separator:gaf82a7d54887104bdced67a2e95510e38"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab1bf2bc1a4a3dff731b486267cf4ef67"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00042.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#gab1bf2bc1a4a3dff731b486267cf4ef67">pn_disposition_annotations</a> (<a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *disposition)</td></tr>
<tr class="memdesc:gab1bf2bc1a4a3dff731b486267cf4ef67"><td class="mdescLeft"> </td><td class="mdescRight">Access the annotations associated with a disposition. <a href="#gab1bf2bc1a4a3dff731b486267cf4ef67">More...</a><br /></td></tr>
<tr class="separator:gab1bf2bc1a4a3dff731b486267cf4ef67"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gac64952b813a707586c6b3898e09552e4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PN_ACCEPTED   (0x0000000000000024)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The PN_ACCEPTED delivery state is a terminal state indicating that the delivery was successfully processed. </p>
<p>Once in this state there will be no further state changes prior to the delivery being settled. </p>
</div>
</div>
<a class="anchor" id="ga247e3d1ac7c9096cdd28424353582962"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PN_MODIFIED   (0x0000000000000027)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The PN_MODIFIED delivery state is a terminal state indicating that the delivery is being returned to the sender and should be annotated by the sender prior to further delivery attempts. </p>
<p>Once in this state there will be no further state changes prior to the delivery being settled. </p>
</div>
</div>
<a class="anchor" id="gaae349c977b37b584aa62fff6515802ca"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PN_RECEIVED   (0x0000000000000023)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The PN_RECEIVED delivery state is a non terminal state indicating how much (if any) message data has been received for a delivery. </p>
</div>
</div>
<a class="anchor" id="ga44a2635392fe2e6f8869a7e1cd64db2f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PN_REJECTED   (0x0000000000000025)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The PN_REJECTED delivery state is a terminal state indicating that the delivery could not be processed due to some error condition. </p>
<p>Once in this state there will be no further state changes prior to the delivery being settled. </p>
</div>
</div>
<a class="anchor" id="ga628179c16c4a5f5fd7734bc1bfc6edc3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PN_RELEASED   (0x0000000000000026)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The PN_RELEASED delivery state is a terminal state indicating that the delivery is being returned to the sender. </p>
<p>Once in this state there will be no further state changes prior to the delivery being settled. </p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga4b28f6cd033babd8a7595fc5d292dca1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> <a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Dispositions record the current state and/or final outcome of a transfer. </p>
<p>Every delivery contains both a local and remote disposition. The local disposition holds the local state of the delivery, and the remote disposition holds the last known remote state of the delivery. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gab1bf2bc1a4a3dff731b486267cf4ef67"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00042.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a>* pn_disposition_annotations </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td>
<td class="paramname"><em>disposition</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Access the annotations associated with a disposition. </p>
<p>The <a class="el" href="a00042.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object. ">pn_data_t</a> object retrieved by this operation may be modified prior to updating a delivery. When a delivery is updated, the annotations described by the <a class="el" href="a00042.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object. ">pn_data_t</a> are reported to the peer if applicable to the current delivery state, e.g. states such as <a class="el" href="a00047.html#ga247e3d1ac7c9096cdd28424353582962" title="The PN_MODIFIED delivery state is a terminal state indicating that the delivery is being returned to ...">PN_MODIFIED</a>. The <a class="el" href="a00042.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object. ">pn_data_t</a> must be empty or contain a symbol keyed map.</p>
<p>The pointer returned by this operation is valid until the parent delivery is settled.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">disposition</td><td>a disposition object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the annotations associated with the disposition </dd></dl>
</div>
</div>
<a class="anchor" id="gabd35f46e997ed687d715302480d011e2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00043.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a>* pn_disposition_condition </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td>
<td class="paramname"><em>disposition</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Access the condition object associated with a disposition. </p>
<p>The <a class="el" href="a00043.html#ga11eb7db7d2c205169fe3d47c996a95a5" title="An AMQP Condition object. ">pn_condition_t</a> object retrieved by this operation may be modified prior to updating a delivery. When a delivery is updated, the condition described by the disposition is reported to the peer if applicable to the current delivery state, e.g. states such as <a class="el" href="a00047.html#ga44a2635392fe2e6f8869a7e1cd64db2f" title="The PN_REJECTED delivery state is a terminal state indicating that the delivery could not be processe...">PN_REJECTED</a>.</p>
<p>The pointer returned by this operation is valid until the parent delivery is settled.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">disposition</td><td>a disposition object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the disposition condition </dd></dl>
</div>
</div>
<a class="anchor" id="ga451f0c749032dad08b6f960aba3416da"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00042.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a>* pn_disposition_data </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td>
<td class="paramname"><em>disposition</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Access the disposition as a raw pn_data_t. </p>
<p>Dispositions are an extension point in the AMQP protocol. The disposition interface provides setters/getters for those dispositions that are predefined by the specification, however access to the raw disposition data is provided so that other dispositions can be used.</p>
<p>The <a class="el" href="a00042.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object. ">pn_data_t</a> pointer returned by this operation is valid until the parent delivery is settled.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">disposition</td><td>a disposition object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the raw disposition data </dd></dl>
</div>
</div>
<a class="anchor" id="gabcf704fae3e555374ab180befc5b8278"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> uint32_t pn_disposition_get_section_number </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td>
<td class="paramname"><em>disposition</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the section number associated with a disposition. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">disposition</td><td>a disposition object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a section number </dd></dl>
</div>
</div>
<a class="anchor" id="ga55e4389018c1dc7b026938d2a95eb0c1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> uint64_t pn_disposition_get_section_offset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td>
<td class="paramname"><em>disposition</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the section offset associated with a disposition. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">disposition</td><td>a disposition object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a section offset </dd></dl>
</div>
</div>
<a class="anchor" id="ga52d49cfa7973e052b25343f5b150dcac"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool pn_disposition_is_failed </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td>
<td class="paramname"><em>disposition</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a disposition has the failed flag set. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">disposition</td><td>a disposition object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the disposition has the failed flag set, false otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="ga3bc9fc23bc5c67fe0704af901739afe6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool pn_disposition_is_undeliverable </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td>
<td class="paramname"><em>disposition</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a disposition has the undeliverable flag set. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">disposition</td><td>a disposition object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the disposition has the undeliverable flag set, false otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="gae4fe77f776c68cadf36ce1d11bed30b1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_disposition_set_failed </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td>
<td class="paramname"><em>disposition</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>failed</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the failed flag on a disposition. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">disposition</td><td>a disposition object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">failed</td><td>the value of the failed flag </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga0b9c83f249965f9588ee0fd41ce77ced"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_disposition_set_section_number </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td>
<td class="paramname"><em>disposition</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>section_number</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the section number associated with a disposition. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">disposition</td><td>a disposition object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">section_number</td><td>a section number </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga900c1f88996063c495e4a370c14d5105"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_disposition_set_section_offset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td>
<td class="paramname"><em>disposition</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>section_offset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the section offset associated with a disposition. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">disposition</td><td>a disposition object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">section_offset</td><td>a section offset </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaf82a7d54887104bdced67a2e95510e38"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_disposition_set_undeliverable </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td>
<td class="paramname"><em>disposition</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>undeliverable</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the undeliverable flag on a disposition. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">disposition</td><td>a disposition object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">undeliverable</td><td>the value of the undeliverable flag </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga56f357a15193cfb221ce497d1f48022d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> uint64_t pn_disposition_type </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00047.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td>
<td class="paramname"><em>disposition</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the type of a disposition. </p>
<p>Defined values are:</p>
<ul>
<li><a class="el" href="a00047.html#gaae349c977b37b584aa62fff6515802ca" title="The PN_RECEIVED delivery state is a non terminal state indicating how much (if any) message data has ...">PN_RECEIVED</a></li>
<li><a class="el" href="a00047.html#gac64952b813a707586c6b3898e09552e4" title="The PN_ACCEPTED delivery state is a terminal state indicating that the delivery was successfully proc...">PN_ACCEPTED</a></li>
<li><a class="el" href="a00047.html#ga44a2635392fe2e6f8869a7e1cd64db2f" title="The PN_REJECTED delivery state is a terminal state indicating that the delivery could not be processe...">PN_REJECTED</a></li>
<li><a class="el" href="a00047.html#ga628179c16c4a5f5fd7734bc1bfc6edc3" title="The PN_RELEASED delivery state is a terminal state indicating that the delivery is being returned to ...">PN_RELEASED</a></li>
<li><a class="el" href="a00047.html#ga247e3d1ac7c9096cdd28424353582962" title="The PN_MODIFIED delivery state is a terminal state indicating that the delivery is being returned to ...">PN_MODIFIED</a></li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">disposition</td><td>a disposition object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the type of the disposition </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Apr 4 2016 09:18:57 for proton by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
|