/usr/share/proton-0.7/docs/api-c/a00044.html is in libqpid-proton2-dev-doc 0.7-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 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 | <!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.8"/>
<title>proton: Delivery</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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 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.8 -->
<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><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)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></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="#groups">Modules</a> |
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Delivery<div class="ingroups"><a class="el" href="a00046.html">Engine</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:a00045"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html">Disposition</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html">pn_delivery_tag_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An AMQP delivery tag. <a href="a00005.html#details">More...</a><br /></td></tr>
<tr class="separator:"><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:gad49cacb1adfac5c7c36e389d6528be1f"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a00005.html">pn_delivery_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#gad49cacb1adfac5c7c36e389d6528be1f">pn_delivery_tag_t</a></td></tr>
<tr class="memdesc:gad49cacb1adfac5c7c36e389d6528be1f"><td class="mdescLeft"> </td><td class="mdescRight">An AMQP delivery tag. <a href="#gad49cacb1adfac5c7c36e389d6528be1f">More...</a><br /></td></tr>
<tr class="separator:gad49cacb1adfac5c7c36e389d6528be1f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacdfce854066c0a4ff4db9f9a0478f340"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a></td></tr>
<tr class="memdesc:gacdfce854066c0a4ff4db9f9a0478f340"><td class="mdescLeft"> </td><td class="mdescRight">An AMQP Delivery object. <a href="#gacdfce854066c0a4ff4db9f9a0478f340">More...</a><br /></td></tr>
<tr class="separator:gacdfce854066c0a4ff4db9f9a0478f340"><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:gad7ac1f5356fa3fb1639e25ad1d05933b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#gad7ac1f5356fa3fb1639e25ad1d05933b">pn_delivery</a> (<a class="el" href="a00048.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link, <a class="el" href="a00005.html">pn_delivery_tag_t</a> tag)</td></tr>
<tr class="memdesc:gad7ac1f5356fa3fb1639e25ad1d05933b"><td class="mdescLeft"> </td><td class="mdescRight">Create a delivery on a link. <a href="#gad7ac1f5356fa3fb1639e25ad1d05933b">More...</a><br /></td></tr>
<tr class="separator:gad7ac1f5356fa3fb1639e25ad1d05933b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga58503daa93d897b69e34de1b32cfc384"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga58503daa93d897b69e34de1b32cfc384">pn_delivery_get_context</a> (<a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr>
<tr class="memdesc:ga58503daa93d897b69e34de1b32cfc384"><td class="mdescLeft"> </td><td class="mdescRight">Get the application context that is associated with a delivery object. <a href="#ga58503daa93d897b69e34de1b32cfc384">More...</a><br /></td></tr>
<tr class="separator:ga58503daa93d897b69e34de1b32cfc384"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga511920cc2f9f2030ce398f4a4813c046"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga511920cc2f9f2030ce398f4a4813c046">pn_delivery_set_context</a> (<a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery, void *context)</td></tr>
<tr class="memdesc:ga511920cc2f9f2030ce398f4a4813c046"><td class="mdescLeft"> </td><td class="mdescRight">Set a new application context for a delivery object. <a href="#ga511920cc2f9f2030ce398f4a4813c046">More...</a><br /></td></tr>
<tr class="separator:ga511920cc2f9f2030ce398f4a4813c046"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa49ff925476e5ed5027c59e58e088f50"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00005.html">pn_delivery_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#gaa49ff925476e5ed5027c59e58e088f50">pn_delivery_tag</a> (<a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr>
<tr class="memdesc:gaa49ff925476e5ed5027c59e58e088f50"><td class="mdescLeft"> </td><td class="mdescRight">Get the tag for a delivery object. <a href="#gaa49ff925476e5ed5027c59e58e088f50">More...</a><br /></td></tr>
<tr class="separator:gaa49ff925476e5ed5027c59e58e088f50"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga96e7f26b4b6776297602194c1d8f5c6f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00048.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga96e7f26b4b6776297602194c1d8f5c6f">pn_delivery_link</a> (<a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr>
<tr class="memdesc:ga96e7f26b4b6776297602194c1d8f5c6f"><td class="mdescLeft"> </td><td class="mdescRight">Get the parent link for a delivery object. <a href="#ga96e7f26b4b6776297602194c1d8f5c6f">More...</a><br /></td></tr>
<tr class="separator:ga96e7f26b4b6776297602194c1d8f5c6f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga10647ef832705827cafd2e3162f97b73"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00045.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga10647ef832705827cafd2e3162f97b73">pn_delivery_local</a> (<a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr>
<tr class="memdesc:ga10647ef832705827cafd2e3162f97b73"><td class="mdescLeft"> </td><td class="mdescRight">Get the local disposition for a delivery. <a href="#ga10647ef832705827cafd2e3162f97b73">More...</a><br /></td></tr>
<tr class="separator:ga10647ef832705827cafd2e3162f97b73"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga22f4c1f220816cefafb250dd5c2b92f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga22f4c1f220816cefafb250dd5c2b92f4">pn_delivery_local_state</a> (<a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr>
<tr class="memdesc:ga22f4c1f220816cefafb250dd5c2b92f4"><td class="mdescLeft"> </td><td class="mdescRight">Get the local disposition state for a delivery. <a href="#ga22f4c1f220816cefafb250dd5c2b92f4">More...</a><br /></td></tr>
<tr class="separator:ga22f4c1f220816cefafb250dd5c2b92f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad971053ebf742d3ae023c7cf0e89d88b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00045.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#gad971053ebf742d3ae023c7cf0e89d88b">pn_delivery_remote</a> (<a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr>
<tr class="memdesc:gad971053ebf742d3ae023c7cf0e89d88b"><td class="mdescLeft"> </td><td class="mdescRight">Get the remote disposition for a delivery. <a href="#gad971053ebf742d3ae023c7cf0e89d88b">More...</a><br /></td></tr>
<tr class="separator:gad971053ebf742d3ae023c7cf0e89d88b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga82b9bb95f0ddb25937d5438d81b7f16f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga82b9bb95f0ddb25937d5438d81b7f16f">pn_delivery_remote_state</a> (<a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr>
<tr class="memdesc:ga82b9bb95f0ddb25937d5438d81b7f16f"><td class="mdescLeft"> </td><td class="mdescRight">Get the remote disposition state for a delivery. <a href="#ga82b9bb95f0ddb25937d5438d81b7f16f">More...</a><br /></td></tr>
<tr class="separator:ga82b9bb95f0ddb25937d5438d81b7f16f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1e57daeae02237fa168b0b35bc4fe198"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga1e57daeae02237fa168b0b35bc4fe198">pn_delivery_settled</a> (<a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr>
<tr class="memdesc:ga1e57daeae02237fa168b0b35bc4fe198"><td class="mdescLeft"> </td><td class="mdescRight">Check if a delivery is remotely settled. <a href="#ga1e57daeae02237fa168b0b35bc4fe198">More...</a><br /></td></tr>
<tr class="separator:ga1e57daeae02237fa168b0b35bc4fe198"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6ad7ae3286b0a4f553b33ea9ce5bb172"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga6ad7ae3286b0a4f553b33ea9ce5bb172">pn_delivery_pending</a> (<a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr>
<tr class="memdesc:ga6ad7ae3286b0a4f553b33ea9ce5bb172"><td class="mdescLeft"> </td><td class="mdescRight">Get the amount of pending message data for a delivery. <a href="#ga6ad7ae3286b0a4f553b33ea9ce5bb172">More...</a><br /></td></tr>
<tr class="separator:ga6ad7ae3286b0a4f553b33ea9ce5bb172"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad3cdc28f24b74b71e547881b16c6c20b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#gad3cdc28f24b74b71e547881b16c6c20b">pn_delivery_partial</a> (<a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr>
<tr class="memdesc:gad3cdc28f24b74b71e547881b16c6c20b"><td class="mdescLeft"> </td><td class="mdescRight">Check if a delivery only has partial message data. <a href="#gad3cdc28f24b74b71e547881b16c6c20b">More...</a><br /></td></tr>
<tr class="separator:gad3cdc28f24b74b71e547881b16c6c20b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2865b95666ff6ca6e9ed9623844c15bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga2865b95666ff6ca6e9ed9623844c15bf">pn_delivery_writable</a> (<a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr>
<tr class="memdesc:ga2865b95666ff6ca6e9ed9623844c15bf"><td class="mdescLeft"> </td><td class="mdescRight">Check if a delivery is writable. <a href="#ga2865b95666ff6ca6e9ed9623844c15bf">More...</a><br /></td></tr>
<tr class="separator:ga2865b95666ff6ca6e9ed9623844c15bf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5d9fd7f307a6e68bbcfa3aab1c93b81a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga5d9fd7f307a6e68bbcfa3aab1c93b81a">pn_delivery_readable</a> (<a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr>
<tr class="memdesc:ga5d9fd7f307a6e68bbcfa3aab1c93b81a"><td class="mdescLeft"> </td><td class="mdescRight">Check if a delivery is readable. <a href="#ga5d9fd7f307a6e68bbcfa3aab1c93b81a">More...</a><br /></td></tr>
<tr class="separator:ga5d9fd7f307a6e68bbcfa3aab1c93b81a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4e302349ed7e71b2311549e53a65ae0d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga4e302349ed7e71b2311549e53a65ae0d">pn_delivery_updated</a> (<a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr>
<tr class="memdesc:ga4e302349ed7e71b2311549e53a65ae0d"><td class="mdescLeft"> </td><td class="mdescRight">Check if a delivery is updated. <a href="#ga4e302349ed7e71b2311549e53a65ae0d">More...</a><br /></td></tr>
<tr class="separator:ga4e302349ed7e71b2311549e53a65ae0d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga11803f844e1521b2ccaabb0259186308"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga11803f844e1521b2ccaabb0259186308">pn_delivery_update</a> (<a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery, uint64_t state)</td></tr>
<tr class="memdesc:ga11803f844e1521b2ccaabb0259186308"><td class="mdescLeft"> </td><td class="mdescRight">Update the disposition of a delivery. <a href="#ga11803f844e1521b2ccaabb0259186308">More...</a><br /></td></tr>
<tr class="separator:ga11803f844e1521b2ccaabb0259186308"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6b90bcc2dcacdb24983c66479d610325"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga6b90bcc2dcacdb24983c66479d610325">pn_delivery_clear</a> (<a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr>
<tr class="memdesc:ga6b90bcc2dcacdb24983c66479d610325"><td class="mdescLeft"> </td><td class="mdescRight">Clear the updated flag for a delivery. <a href="#ga6b90bcc2dcacdb24983c66479d610325">More...</a><br /></td></tr>
<tr class="separator:ga6b90bcc2dcacdb24983c66479d610325"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8b3a1e6da2acabf21fedea60198d4cdb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga8b3a1e6da2acabf21fedea60198d4cdb">pn_delivery_settle</a> (<a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr>
<tr class="memdesc:ga8b3a1e6da2acabf21fedea60198d4cdb"><td class="mdescLeft"> </td><td class="mdescRight">Settle a delivery. <a href="#ga8b3a1e6da2acabf21fedea60198d4cdb">More...</a><br /></td></tr>
<tr class="separator:ga8b3a1e6da2acabf21fedea60198d4cdb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaca0dbead0ad90a228dffcad5da5cfa5d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#gaca0dbead0ad90a228dffcad5da5cfa5d">pn_delivery_dump</a> (<a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr>
<tr class="memdesc:gaca0dbead0ad90a228dffcad5da5cfa5d"><td class="mdescLeft"> </td><td class="mdescRight">Utility function for printing details of a delivery. <a href="#gaca0dbead0ad90a228dffcad5da5cfa5d">More...</a><br /></td></tr>
<tr class="separator:gaca0dbead0ad90a228dffcad5da5cfa5d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafcd07b42d1380f30e6fdee1e4423b6a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#gafcd07b42d1380f30e6fdee1e4423b6a3">pn_delivery_buffered</a> (<a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr>
<tr class="memdesc:gafcd07b42d1380f30e6fdee1e4423b6a3"><td class="mdescLeft"> </td><td class="mdescRight">Check if a delivery is buffered. <a href="#gafcd07b42d1380f30e6fdee1e4423b6a3">More...</a><br /></td></tr>
<tr class="separator:gafcd07b42d1380f30e6fdee1e4423b6a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaeae1603ad26c10678175beb423733b67"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#gaeae1603ad26c10678175beb423733b67">pn_work_head</a> (<a class="el" href="a00042.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr>
<tr class="memdesc:gaeae1603ad26c10678175beb423733b67"><td class="mdescLeft"> </td><td class="mdescRight">Extracts the first delivery on the connection that has pending operations. <a href="#gaeae1603ad26c10678175beb423733b67">More...</a><br /></td></tr>
<tr class="separator:gaeae1603ad26c10678175beb423733b67"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaebe6684c2f07fe6928a817b8f8dab0db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#gaebe6684c2f07fe6928a817b8f8dab0db">pn_work_next</a> (<a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr>
<tr class="memdesc:gaebe6684c2f07fe6928a817b8f8dab0db"><td class="mdescLeft"> </td><td class="mdescRight">Get the next delivery on the connection that needs has pending operations. <a href="#gaebe6684c2f07fe6928a817b8f8dab0db">More...</a><br /></td></tr>
<tr class="separator:gaebe6684c2f07fe6928a817b8f8dab0db"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gacdfce854066c0a4ff4db9f9a0478f340"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> <a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An AMQP Delivery object. </p>
<p>A pn_delivery_t object encapsulates all of the endpoint state associated with an AMQP Delivery. Every delivery exists within the context of a <a class="el" href="a00048.html#ga89dad3aa7934329a7ff467c636687bc0" title="An AMQP Link object. ">pn_link_t</a> object.</p>
<p>The AMQP model for settlement is based on the lifecycle of a delivery at an endpoint. At each end of a link, a delivery is created, it exists for some period of time, and finally it is forgotten, aka settled. Note that because this lifecycle happens independently at both the sender and the receiver, there are actually four events of interest in the combined lifecycle of a given delivery:</p>
<ul>
<li>created at sender</li>
<li>created at receiver</li>
<li>settled at sender</li>
<li>settled at receiver</li>
</ul>
<p>Because the sender and receiver are operating concurrently, these events can occur in a variety of different orders, and the order of these events impacts the types of failures that may occur when transferring a delivery. Eliminating scenarios where the receiver creates the delivery first, we have the following possible sequences of interest:</p>
<h2>Sender presettles (aka at-most-once): </h2>
<ol type="1">
<li>created at sender</li>
<li>settled at sender</li>
<li>created at receiver</li>
<li>settled at receiver</li>
</ol>
<p>In this configuration the sender settles (i.e. forgets about) the delivery before it even reaches the receiver, and if anything should happen to the delivery in-flight, there is no way to recover, hence the "at most once" semantics.</p>
<h2>Receiver settles first (aka at-least-once): </h2>
<ol type="1">
<li>created at sender</li>
<li>created at receiver</li>
<li>settled at receiver</li>
<li>settled at sender</li>
</ol>
<p>In this configuration the receiver settles the delivery first, and the sender settles once it sees the receiver has settled. Should anything happen to the delivery in-flight, the sender can resend, however the receiver may have already forgotten the delivery and so it could interpret the resend as a new delivery, hence the "at
least once" semantics.</p>
<h2>Receiver settles second (aka exactly-once): </h2>
<ol type="1">
<li>created at sender</li>
<li>created at receiver</li>
<li>settled at sender</li>
<li>settled at receiver</li>
</ol>
<p>In this configuration the receiver settles only once it has seen that the sender has settled. This provides the sender the option to retransmit, and the receiver has the option to recognize (and discard) duplicates, allowing for exactly once semantics.</p>
<p>Note that in the last scenario the sender needs some way to know when it is safe to settle. This is where delivery state comes in. In addition to these lifecycle related events surrounding deliveries there is also the notion of a delivery state that can change over the lifetime of a delivery, e.g. it might start out as nothing, transition to <a class="el" href="a00045.html#gaae349c977b37b584aa62fff6515802ca" title="The PN_RECEIVED delivery state is a non terminal state indicating how much (if any) message data has ...">PN_RECEIVED</a> and then transition to <a class="el" href="a00045.html#gac64952b813a707586c6b3898e09552e4" title="The PN_ACCEPTED delivery state is a terminal state indicating that the delivery was successfully proc...">PN_ACCEPTED</a>. In the first two scenarios the delivery state isn't required, however in final scenario the sender would typically trigger settlement based on seeing the delivery state transition to a terminal state like <a class="el" href="a00045.html#gac64952b813a707586c6b3898e09552e4" title="The PN_ACCEPTED delivery state is a terminal state indicating that the delivery was successfully proc...">PN_ACCEPTED</a> or <a class="el" href="a00045.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>In practice settlement is controlled by application policy, so there may well be more options here, e.g. a sender might not settle strictly based on what has happened at the receiver, it might also choose to impose some time limit and settle after that period has expired, or it could simply have a sliding window of the last N deliveries and settle the oldest whenever a new one comes along. </p>
</div>
</div>
<a class="anchor" id="gad49cacb1adfac5c7c36e389d6528be1f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="a00005.html">pn_delivery_tag_t</a> <a class="el" href="a00005.html">pn_delivery_tag_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An AMQP delivery tag. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gad7ac1f5356fa3fb1639e25ad1d05933b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a>* pn_delivery </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00048.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td>
<td class="paramname"><em>link</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00005.html">pn_delivery_tag_t</a> </td>
<td class="paramname"><em>tag</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a delivery on a link. </p>
<p>Every delivery object within a link must be supplied with a unique tag. Links maintain a sequence of delivery object in the order that they are created.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>the delivery tag </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a newly created delivery, or NULL if there was an error </dd></dl>
</div>
</div>
<a class="anchor" id="gafcd07b42d1380f30e6fdee1e4423b6a3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool pn_delivery_buffered </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td>
<td class="paramname"><em>delivery</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a delivery is buffered. </p>
<p>A delivery that is buffered has not yet been written to the wire.</p>
<p>Note that returning false does not imply that a delivery was definitely written to the wire. If false is returned, it is not known whether the delivery was actually written to the wire or not.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the delivery is buffered </dd></dl>
</div>
</div>
<a class="anchor" id="ga6b90bcc2dcacdb24983c66479d610325"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_delivery_clear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td>
<td class="paramname"><em>delivery</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clear the updated flag for a delivery. </p>
<p>See <a class="el" href="a00044.html#ga4e302349ed7e71b2311549e53a65ae0d" title="Check if a delivery is updated. ">pn_delivery_updated</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaca0dbead0ad90a228dffcad5da5cfa5d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_delivery_dump </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td>
<td class="paramname"><em>delivery</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Utility function for printing details of a delivery. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga58503daa93d897b69e34de1b32cfc384"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void* pn_delivery_get_context </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td>
<td class="paramname"><em>delivery</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the application context that is associated with a delivery object. </p>
<p>The application context for a delivery may be set using <a class="el" href="a00044.html#ga511920cc2f9f2030ce398f4a4813c046" title="Set a new application context for a delivery object. ">pn_delivery_set_context</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>the delivery whose context is to be returned. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the application context for the delivery object </dd></dl>
</div>
</div>
<a class="anchor" id="ga96e7f26b4b6776297602194c1d8f5c6f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00048.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a>* pn_delivery_link </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td>
<td class="paramname"><em>delivery</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the parent link for a delivery object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the parent link </dd></dl>
</div>
</div>
<a class="anchor" id="ga10647ef832705827cafd2e3162f97b73"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00045.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a>* pn_delivery_local </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td>
<td class="paramname"><em>delivery</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the local disposition for a delivery. </p>
<p>The pointer returned by this object is valid until the delivery is settled.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the local disposition </dd></dl>
</div>
</div>
<a class="anchor" id="ga22f4c1f220816cefafb250dd5c2b92f4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> uint64_t pn_delivery_local_state </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td>
<td class="paramname"><em>delivery</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the local disposition state for a delivery. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the local disposition state </dd></dl>
</div>
</div>
<a class="anchor" id="gad3cdc28f24b74b71e547881b16c6c20b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool pn_delivery_partial </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td>
<td class="paramname"><em>delivery</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a delivery only has partial message data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the delivery only contains part of a message, false otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="ga6ad7ae3286b0a4f553b33ea9ce5bb172"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> size_t pn_delivery_pending </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td>
<td class="paramname"><em>delivery</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the amount of pending message data for a delivery. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the amount of pending message data in bytes </dd></dl>
</div>
</div>
<a class="anchor" id="ga5d9fd7f307a6e68bbcfa3aab1c93b81a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool pn_delivery_readable </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td>
<td class="paramname"><em>delivery</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a delivery is readable. </p>
<p>A delivery is considered readable if it is the current delivery on an incoming link.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the delivery is readable, false otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="gad971053ebf742d3ae023c7cf0e89d88b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00045.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a>* pn_delivery_remote </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td>
<td class="paramname"><em>delivery</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the remote disposition for a delivery. </p>
<p>The pointer returned by this object is valid until the delivery is settled.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the remote disposition </dd></dl>
</div>
</div>
<a class="anchor" id="ga82b9bb95f0ddb25937d5438d81b7f16f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> uint64_t pn_delivery_remote_state </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td>
<td class="paramname"><em>delivery</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the remote disposition state for a delivery. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the remote disposition state </dd></dl>
</div>
</div>
<a class="anchor" id="ga511920cc2f9f2030ce398f4a4813c046"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_delivery_set_context </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td>
<td class="paramname"><em>delivery</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>context</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a new application context for a delivery object. </p>
<p>The application context for a delivery object may be retrieved using <a class="el" href="a00044.html#ga58503daa93d897b69e34de1b32cfc384" title="Get the application context that is associated with a delivery object. ">pn_delivery_get_context</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>the delivery object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>the application context </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga8b3a1e6da2acabf21fedea60198d4cdb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_delivery_settle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td>
<td class="paramname"><em>delivery</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Settle a delivery. </p>
<p>A settled delivery can never be used again.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga1e57daeae02237fa168b0b35bc4fe198"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool pn_delivery_settled </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td>
<td class="paramname"><em>delivery</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a delivery is remotely settled. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the delivery is settled at the remote endpoint, false otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="gaa49ff925476e5ed5027c59e58e088f50"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00005.html">pn_delivery_tag_t</a> pn_delivery_tag </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td>
<td class="paramname"><em>delivery</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the tag for a delivery object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the delivery tag </dd></dl>
</div>
</div>
<a class="anchor" id="ga11803f844e1521b2ccaabb0259186308"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_delivery_update </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td>
<td class="paramname"><em>delivery</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>state</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Update the disposition of a delivery. </p>
<p>When update is invoked the updated disposition of the delivery will be communicated to the peer.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>the updated delivery state </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga4e302349ed7e71b2311549e53a65ae0d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool pn_delivery_updated </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td>
<td class="paramname"><em>delivery</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a delivery is updated. </p>
<p>A delivery is considered updated whenever the peer communicates a new disposition for the delivery. Once a delivery becomes updated, it will remain so until <a class="el" href="a00044.html#ga6b90bcc2dcacdb24983c66479d610325" title="Clear the updated flag for a delivery. ">pn_delivery_clear</a> is called.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the delivery is updated, false otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="ga2865b95666ff6ca6e9ed9623844c15bf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool pn_delivery_writable </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td>
<td class="paramname"><em>delivery</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a delivery is writable. </p>
<p>A delivery is considered writable if it is the current delivery on an outgoing link, and the link has positive credit.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the delivery is writable, false otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="gaeae1603ad26c10678175beb423733b67"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a>* pn_work_head </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00042.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td>
<td class="paramname"><em>connection</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts the first delivery on the connection that has pending operations. </p>
<p>Retrieves the first delivery on the Connection that has pending operations. A readable delivery indicates message data is waiting to be read. A writable delivery indicates that message data may be sent. An updated delivery indicates that the delivery's disposition has changed. A delivery will never be both readable and writible, but it may be both readable and updated or both writiable and updated.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the first delivery object that needs to be serviced, else NULL if none </dd></dl>
</div>
</div>
<a class="anchor" id="gaebe6684c2f07fe6928a817b8f8dab0db"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a>* pn_work_next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00044.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td>
<td class="paramname"><em>delivery</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the next delivery on the connection that needs has pending operations. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>the previous delivery retrieved from either pn_work_head or pn_work_next </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the next delivery that has pending operations, else NULL if none </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Nov 17 2014 10:28:04 for proton by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
|