/usr/share/proton-0.7/docs/api-c/a00057.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 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 | <!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: Terminus</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="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Terminus<div class="ingroups"><a class="el" href="a00046.html">Engine</a> » <a class="el" href="a00048.html">Link</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gad202baf5c904d6991e13521b7c93fdc2"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a></td></tr>
<tr class="memdesc:gad202baf5c904d6991e13521b7c93fdc2"><td class="mdescLeft"> </td><td class="mdescRight">Encapsulates the endpoint state associated with an AMQP Terminus. <a href="#gad202baf5c904d6991e13521b7c93fdc2">More...</a><br /></td></tr>
<tr class="separator:gad202baf5c904d6991e13521b7c93fdc2"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga3cb9c86d1e2bb024de2658f9def098e7"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#ga3cb9c86d1e2bb024de2658f9def098e7">pn_terminus_type_t</a> { <a class="el" href="a00057.html#gga3cb9c86d1e2bb024de2658f9def098e7accee852b0d609496d88d91d683784216">PN_UNSPECIFIED</a> = 0,
<a class="el" href="a00057.html#gga3cb9c86d1e2bb024de2658f9def098e7a7fd70c48647a2edc5167bce3ade8f2f0">PN_SOURCE</a> = 1,
<a class="el" href="a00057.html#gga3cb9c86d1e2bb024de2658f9def098e7a760e5ca8afcbee9f43a72cfd09b7c54e">PN_TARGET</a> = 2,
<a class="el" href="a00057.html#gga3cb9c86d1e2bb024de2658f9def098e7a75bb94f03973a939835d98e9b1999aae">PN_COORDINATOR</a> = 3
}</td></tr>
<tr class="memdesc:ga3cb9c86d1e2bb024de2658f9def098e7"><td class="mdescLeft"> </td><td class="mdescRight">Type of an AMQP terminus. <a href="a00057.html#ga3cb9c86d1e2bb024de2658f9def098e7">More...</a><br /></td></tr>
<tr class="separator:ga3cb9c86d1e2bb024de2658f9def098e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga213267363be45848f3299471ea93089b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#ga213267363be45848f3299471ea93089b">pn_durability_t</a> { <a class="el" href="a00057.html#gga213267363be45848f3299471ea93089ba403e259f8d858d6a12f463dbd7e5dc6b">PN_NONDURABLE</a> = 0,
<a class="el" href="a00057.html#gga213267363be45848f3299471ea93089ba95b1d5b60c47569e0358258305de1d58">PN_CONFIGURATION</a> = 1,
<a class="el" href="a00057.html#gga213267363be45848f3299471ea93089bac2e0a9f773faf4ee8fd43f77855933d2">PN_DELIVERIES</a> = 2
}</td></tr>
<tr class="memdesc:ga213267363be45848f3299471ea93089b"><td class="mdescLeft"> </td><td class="mdescRight">Durability mode of an AMQP terminus. <a href="a00057.html#ga213267363be45848f3299471ea93089b">More...</a><br /></td></tr>
<tr class="separator:ga213267363be45848f3299471ea93089b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab4089b27ee99a348deab776f3d4931f0"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#gab4089b27ee99a348deab776f3d4931f0">pn_expiry_policy_t</a> { <a class="el" href="a00057.html#ggab4089b27ee99a348deab776f3d4931f0aa52e78e7aa50c404d4dc3a529dec7c1f">PN_LINK_CLOSE</a>,
<a class="el" href="a00057.html#ggab4089b27ee99a348deab776f3d4931f0a01cb1cdf349e91566be0329dbe52dbd9">PN_SESSION_CLOSE</a>,
<a class="el" href="a00057.html#ggab4089b27ee99a348deab776f3d4931f0a83f67d82b89afce886c8f23dc2950660">PN_CONNECTION_CLOSE</a>,
<a class="el" href="a00057.html#ggab4089b27ee99a348deab776f3d4931f0ae5382be173a3747b89cf15d843f60774">PN_NEVER</a>
}</td></tr>
<tr class="memdesc:gab4089b27ee99a348deab776f3d4931f0"><td class="mdescLeft"> </td><td class="mdescRight">Expiry policy of an AMQP terminus. <a href="a00057.html#gab4089b27ee99a348deab776f3d4931f0">More...</a><br /></td></tr>
<tr class="separator:gab4089b27ee99a348deab776f3d4931f0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac6fb89a5fa96476db51b60f10dc785d0"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#gac6fb89a5fa96476db51b60f10dc785d0">pn_distribution_mode_t</a> { <a class="el" href="a00057.html#ggac6fb89a5fa96476db51b60f10dc785d0a74d3ae9ce3ad50e5c5cc71164a2a8aac">PN_DIST_MODE_UNSPECIFIED</a> = 0,
<a class="el" href="a00057.html#ggac6fb89a5fa96476db51b60f10dc785d0a914fec87d6b3211d5f2eeb780819e523">PN_DIST_MODE_COPY</a> = 1,
<a class="el" href="a00057.html#ggac6fb89a5fa96476db51b60f10dc785d0a9e076691930f95f32c850ea01a808b92">PN_DIST_MODE_MOVE</a> = 2
}</td></tr>
<tr class="memdesc:gac6fb89a5fa96476db51b60f10dc785d0"><td class="mdescLeft"> </td><td class="mdescRight">Distribution mode of an AMQP terminus. <a href="a00057.html#gac6fb89a5fa96476db51b60f10dc785d0">More...</a><br /></td></tr>
<tr class="separator:gac6fb89a5fa96476db51b60f10dc785d0"><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:gaaef31d25eb233aace7be1e0174fbf55e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00057.html#ga3cb9c86d1e2bb024de2658f9def098e7">pn_terminus_type_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#gaaef31d25eb233aace7be1e0174fbf55e">pn_terminus_get_type</a> (<a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus)</td></tr>
<tr class="memdesc:gaaef31d25eb233aace7be1e0174fbf55e"><td class="mdescLeft"> </td><td class="mdescRight">Get the type of a terminus object. <a href="#gaaef31d25eb233aace7be1e0174fbf55e">More...</a><br /></td></tr>
<tr class="separator:gaaef31d25eb233aace7be1e0174fbf55e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafe106dcd053dd04b0fdbc9b40b58e23d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#gafe106dcd053dd04b0fdbc9b40b58e23d">pn_terminus_set_type</a> (<a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus, <a class="el" href="a00057.html#ga3cb9c86d1e2bb024de2658f9def098e7">pn_terminus_type_t</a> type)</td></tr>
<tr class="memdesc:gafe106dcd053dd04b0fdbc9b40b58e23d"><td class="mdescLeft"> </td><td class="mdescRight">Set the type of a terminus object. <a href="#gafe106dcd053dd04b0fdbc9b40b58e23d">More...</a><br /></td></tr>
<tr class="separator:gafe106dcd053dd04b0fdbc9b40b58e23d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf7ce75acdf855eaf7637abcd4131d6b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#gaf7ce75acdf855eaf7637abcd4131d6b3">pn_terminus_get_address</a> (<a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus)</td></tr>
<tr class="memdesc:gaf7ce75acdf855eaf7637abcd4131d6b3"><td class="mdescLeft"> </td><td class="mdescRight">Get the address of a terminus object. <a href="#gaf7ce75acdf855eaf7637abcd4131d6b3">More...</a><br /></td></tr>
<tr class="separator:gaf7ce75acdf855eaf7637abcd4131d6b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae55a8e0c226942c3ce122fa1e453148c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#gae55a8e0c226942c3ce122fa1e453148c">pn_terminus_set_address</a> (<a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus, const char *address)</td></tr>
<tr class="memdesc:gae55a8e0c226942c3ce122fa1e453148c"><td class="mdescLeft"> </td><td class="mdescRight">Set the address of a terminus object. <a href="#gae55a8e0c226942c3ce122fa1e453148c">More...</a><br /></td></tr>
<tr class="separator:gae55a8e0c226942c3ce122fa1e453148c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga575d3d03d45453bce10392b120e35a50"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00057.html#gac6fb89a5fa96476db51b60f10dc785d0">pn_distribution_mode_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#ga575d3d03d45453bce10392b120e35a50">pn_terminus_get_distribution_mode</a> (const <a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus)</td></tr>
<tr class="memdesc:ga575d3d03d45453bce10392b120e35a50"><td class="mdescLeft"> </td><td class="mdescRight">Get the distribution mode of a terminus object. <a href="#ga575d3d03d45453bce10392b120e35a50">More...</a><br /></td></tr>
<tr class="separator:ga575d3d03d45453bce10392b120e35a50"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad4abc043078d14aeeaef3116500d62e1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#gad4abc043078d14aeeaef3116500d62e1">pn_terminus_set_distribution_mode</a> (<a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus, <a class="el" href="a00057.html#gac6fb89a5fa96476db51b60f10dc785d0">pn_distribution_mode_t</a> mode)</td></tr>
<tr class="memdesc:gad4abc043078d14aeeaef3116500d62e1"><td class="mdescLeft"> </td><td class="mdescRight">Set the distribution mode of a terminus object. <a href="#gad4abc043078d14aeeaef3116500d62e1">More...</a><br /></td></tr>
<tr class="separator:gad4abc043078d14aeeaef3116500d62e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabaa9f17714567505f194d6fbb3ad785c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00057.html#ga213267363be45848f3299471ea93089b">pn_durability_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#gabaa9f17714567505f194d6fbb3ad785c">pn_terminus_get_durability</a> (<a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus)</td></tr>
<tr class="memdesc:gabaa9f17714567505f194d6fbb3ad785c"><td class="mdescLeft"> </td><td class="mdescRight">Get the durability mode of a terminus object. <a href="#gabaa9f17714567505f194d6fbb3ad785c">More...</a><br /></td></tr>
<tr class="separator:gabaa9f17714567505f194d6fbb3ad785c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga386428e4d1742649fffa112f231a3bf8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#ga386428e4d1742649fffa112f231a3bf8">pn_terminus_set_durability</a> (<a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus, <a class="el" href="a00057.html#ga213267363be45848f3299471ea93089b">pn_durability_t</a> durability)</td></tr>
<tr class="memdesc:ga386428e4d1742649fffa112f231a3bf8"><td class="mdescLeft"> </td><td class="mdescRight">Set the durability mode of a terminus object. <a href="#ga386428e4d1742649fffa112f231a3bf8">More...</a><br /></td></tr>
<tr class="separator:ga386428e4d1742649fffa112f231a3bf8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4ea6ce82047f3fab63e70a29b74b5fcf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00057.html#gab4089b27ee99a348deab776f3d4931f0">pn_expiry_policy_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#ga4ea6ce82047f3fab63e70a29b74b5fcf">pn_terminus_get_expiry_policy</a> (<a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus)</td></tr>
<tr class="memdesc:ga4ea6ce82047f3fab63e70a29b74b5fcf"><td class="mdescLeft"> </td><td class="mdescRight">Get the expiry policy of a terminus object. <a href="#ga4ea6ce82047f3fab63e70a29b74b5fcf">More...</a><br /></td></tr>
<tr class="separator:ga4ea6ce82047f3fab63e70a29b74b5fcf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gace5b1ae5c177b3d072d619567e20c2a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#gace5b1ae5c177b3d072d619567e20c2a3">pn_terminus_set_expiry_policy</a> (<a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus, <a class="el" href="a00057.html#gab4089b27ee99a348deab776f3d4931f0">pn_expiry_policy_t</a> policy)</td></tr>
<tr class="memdesc:gace5b1ae5c177b3d072d619567e20c2a3"><td class="mdescLeft"> </td><td class="mdescRight">Set the expiry policy of a terminus object. <a href="#gace5b1ae5c177b3d072d619567e20c2a3">More...</a><br /></td></tr>
<tr class="separator:gace5b1ae5c177b3d072d619567e20c2a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadf6f4e80e36b70803acab67b12a35a14"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00060.html#gafdede9be0526a8d0b9ab5d3149069af1">pn_seconds_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#gadf6f4e80e36b70803acab67b12a35a14">pn_terminus_get_timeout</a> (<a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus)</td></tr>
<tr class="memdesc:gadf6f4e80e36b70803acab67b12a35a14"><td class="mdescLeft"> </td><td class="mdescRight">Get the timeout of a terminus object. <a href="#gadf6f4e80e36b70803acab67b12a35a14">More...</a><br /></td></tr>
<tr class="separator:gadf6f4e80e36b70803acab67b12a35a14"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafe5932e60e778827a0b6c27e7748a814"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#gafe5932e60e778827a0b6c27e7748a814">pn_terminus_set_timeout</a> (<a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus, <a class="el" href="a00060.html#gafdede9be0526a8d0b9ab5d3149069af1">pn_seconds_t</a> timeout)</td></tr>
<tr class="memdesc:gafe5932e60e778827a0b6c27e7748a814"><td class="mdescLeft"> </td><td class="mdescRight">Set the timeout of a terminus object. <a href="#gafe5932e60e778827a0b6c27e7748a814">More...</a><br /></td></tr>
<tr class="separator:gafe5932e60e778827a0b6c27e7748a814"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga66ac0a6b680d16588f6e95e0804c64f5"><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="a00057.html#ga66ac0a6b680d16588f6e95e0804c64f5">pn_terminus_is_dynamic</a> (<a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus)</td></tr>
<tr class="memdesc:ga66ac0a6b680d16588f6e95e0804c64f5"><td class="mdescLeft"> </td><td class="mdescRight">Get the dynamic flag for a terminus object. <a href="#ga66ac0a6b680d16588f6e95e0804c64f5">More...</a><br /></td></tr>
<tr class="separator:ga66ac0a6b680d16588f6e95e0804c64f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8600194fb12e709bb165249996d3d136"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#ga8600194fb12e709bb165249996d3d136">pn_terminus_set_dynamic</a> (<a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus, bool dynamic)</td></tr>
<tr class="memdesc:ga8600194fb12e709bb165249996d3d136"><td class="mdescLeft"> </td><td class="mdescRight">Set the dynamic flag for a terminus object. <a href="#ga8600194fb12e709bb165249996d3d136">More...</a><br /></td></tr>
<tr class="separator:ga8600194fb12e709bb165249996d3d136"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga166a84223f2e17a8d122bf19e5ebe0e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00011.html#a5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#ga166a84223f2e17a8d122bf19e5ebe0e3">pn_terminus_properties</a> (<a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus)</td></tr>
<tr class="memdesc:ga166a84223f2e17a8d122bf19e5ebe0e3"><td class="mdescLeft"> </td><td class="mdescRight">Access/modify the AMQP properties data for a terminus object. <a href="#ga166a84223f2e17a8d122bf19e5ebe0e3">More...</a><br /></td></tr>
<tr class="separator:ga166a84223f2e17a8d122bf19e5ebe0e3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga31429fed465bdf8c393196f3dfbf4d2f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00011.html#a5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#ga31429fed465bdf8c393196f3dfbf4d2f">pn_terminus_capabilities</a> (<a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus)</td></tr>
<tr class="memdesc:ga31429fed465bdf8c393196f3dfbf4d2f"><td class="mdescLeft"> </td><td class="mdescRight">Access/modify the AMQP capabilities data for a terminus object. <a href="#ga31429fed465bdf8c393196f3dfbf4d2f">More...</a><br /></td></tr>
<tr class="separator:ga31429fed465bdf8c393196f3dfbf4d2f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab27e5d1e2e0d1610ff9d9819d89f4bed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00011.html#a5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#gab27e5d1e2e0d1610ff9d9819d89f4bed">pn_terminus_outcomes</a> (<a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus)</td></tr>
<tr class="memdesc:gab27e5d1e2e0d1610ff9d9819d89f4bed"><td class="mdescLeft"> </td><td class="mdescRight">Access/modify the AMQP outcomes for a terminus object. <a href="#gab27e5d1e2e0d1610ff9d9819d89f4bed">More...</a><br /></td></tr>
<tr class="separator:gab27e5d1e2e0d1610ff9d9819d89f4bed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga91a7d1ca890c3171220ea7d1eaa57b86"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00011.html#a5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#ga91a7d1ca890c3171220ea7d1eaa57b86">pn_terminus_filter</a> (<a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus)</td></tr>
<tr class="memdesc:ga91a7d1ca890c3171220ea7d1eaa57b86"><td class="mdescLeft"> </td><td class="mdescRight">Access/modify the AMQP filter set for a terminus object. <a href="#ga91a7d1ca890c3171220ea7d1eaa57b86">More...</a><br /></td></tr>
<tr class="separator:ga91a7d1ca890c3171220ea7d1eaa57b86"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabf6c265040dd7233bddbb4efcf314999"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#gabf6c265040dd7233bddbb4efcf314999">pn_terminus_copy</a> (<a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus, <a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *src)</td></tr>
<tr class="memdesc:gabf6c265040dd7233bddbb4efcf314999"><td class="mdescLeft"> </td><td class="mdescRight">Copy a terminus object. <a href="#gabf6c265040dd7233bddbb4efcf314999">More...</a><br /></td></tr>
<tr class="separator:gabf6c265040dd7233bddbb4efcf314999"><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="gad202baf5c904d6991e13521b7c93fdc2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> <a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Encapsulates the endpoint state associated with an AMQP Terminus. </p>
<p>An AMQP Terminus acts as either a source or target for messages, but never both. Every AMQP link is associated with both a source terminus and a target terminus that is negotiated during link establishment. A terminus consists of an AMQP address, along with a number of other properties defining the quality of service and behaviour of the link. </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="gac6fb89a5fa96476db51b60f10dc785d0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="a00057.html#gac6fb89a5fa96476db51b60f10dc785d0">pn_distribution_mode_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Distribution mode of an AMQP terminus. </p>
<p>The distribution mode of a source terminus defines the behaviour when multiple receiving links provide addresses that resolve to the same node. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggac6fb89a5fa96476db51b60f10dc785d0a74d3ae9ce3ad50e5c5cc71164a2a8aac"></a>PN_DIST_MODE_UNSPECIFIED </td><td class="fielddoc">
<p>the behaviour is defined by the node </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggac6fb89a5fa96476db51b60f10dc785d0a914fec87d6b3211d5f2eeb780819e523"></a>PN_DIST_MODE_COPY </td><td class="fielddoc">
<p>the receiver gets all messages </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggac6fb89a5fa96476db51b60f10dc785d0a9e076691930f95f32c850ea01a808b92"></a>PN_DIST_MODE_MOVE </td><td class="fielddoc">
<p>the receiver competes for messages </p>
</td></tr>
</table>
</div>
</div>
<a class="anchor" id="ga213267363be45848f3299471ea93089b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="a00057.html#ga213267363be45848f3299471ea93089b">pn_durability_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Durability mode of an AMQP terminus. </p>
<p>An AMQP terminus may provide durable storage for its state, thereby permitting link recovery in the event of endpoint failures. This durability may be applied to the configuration of the terminus only, or to all delivery state as well. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga213267363be45848f3299471ea93089ba403e259f8d858d6a12f463dbd7e5dc6b"></a>PN_NONDURABLE </td><td class="fielddoc">
<p>indicates a non durable terminus </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga213267363be45848f3299471ea93089ba95b1d5b60c47569e0358258305de1d58"></a>PN_CONFIGURATION </td><td class="fielddoc">
<p>indicates a terminus with durably held configuration, but not delivery state </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga213267363be45848f3299471ea93089bac2e0a9f773faf4ee8fd43f77855933d2"></a>PN_DELIVERIES </td><td class="fielddoc">
<p>indicates a terminus with both durably held configuration and durably held delivery state. </p>
</td></tr>
</table>
</div>
</div>
<a class="anchor" id="gab4089b27ee99a348deab776f3d4931f0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="a00057.html#gab4089b27ee99a348deab776f3d4931f0">pn_expiry_policy_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Expiry policy of an AMQP terminus. </p>
<p>An orphaned terminus can only exist for the timeout configured by <a class="el" href="a00057.html#gafe5932e60e778827a0b6c27e7748a814" title="Set the timeout of a terminus object. ">pn_terminus_set_timeout</a>. The expiry policy determins when a terminus is considered orphaned, i.e. when the expiry timer starts counting down. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggab4089b27ee99a348deab776f3d4931f0aa52e78e7aa50c404d4dc3a529dec7c1f"></a>PN_LINK_CLOSE </td><td class="fielddoc">
<p>the terminus is orphaned when the parent link is closed </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggab4089b27ee99a348deab776f3d4931f0a01cb1cdf349e91566be0329dbe52dbd9"></a>PN_SESSION_CLOSE </td><td class="fielddoc">
<p>the terminus is orphaned when the parent session is closed </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggab4089b27ee99a348deab776f3d4931f0a83f67d82b89afce886c8f23dc2950660"></a>PN_CONNECTION_CLOSE </td><td class="fielddoc">
<p>the terminus is orphaned when the parent connection is closed </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggab4089b27ee99a348deab776f3d4931f0ae5382be173a3747b89cf15d843f60774"></a>PN_NEVER </td><td class="fielddoc">
<p>the terminus is never considered orphaned </p>
</td></tr>
</table>
</div>
</div>
<a class="anchor" id="ga3cb9c86d1e2bb024de2658f9def098e7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="a00057.html#ga3cb9c86d1e2bb024de2658f9def098e7">pn_terminus_type_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of an AMQP terminus. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga3cb9c86d1e2bb024de2658f9def098e7accee852b0d609496d88d91d683784216"></a>PN_UNSPECIFIED </td><td class="fielddoc">
<p>indicates a nonexistent terminus, may used as a source or target </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga3cb9c86d1e2bb024de2658f9def098e7a7fd70c48647a2edc5167bce3ade8f2f0"></a>PN_SOURCE </td><td class="fielddoc">
<p>indicates a source of messages </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga3cb9c86d1e2bb024de2658f9def098e7a760e5ca8afcbee9f43a72cfd09b7c54e"></a>PN_TARGET </td><td class="fielddoc">
<p>indicates a target for messages </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga3cb9c86d1e2bb024de2658f9def098e7a75bb94f03973a939835d98e9b1999aae"></a>PN_COORDINATOR </td><td class="fielddoc">
<p>a special target identifying a transaction coordinator </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga31429fed465bdf8c393196f3dfbf4d2f"></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="a00011.html#a5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a>* pn_terminus_capabilities </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td>
<td class="paramname"><em>terminus</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Access/modify the AMQP capabilities data for a terminus object. </p>
<p>This operation will return a pointer to a <a class="el" href="a00011.html#a5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> object that is valid until the terminus object is freed due to its parent link being freed. Any data contained by the <a class="el" href="a00011.html#a5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> object will be sent as the AMQP capabilities for the parent terminus object. Note that this MUST take the form of an array of symbols to be valid.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to a pn_data_t representing the terminus capabilities </dd></dl>
</div>
</div>
<a class="anchor" id="gabf6c265040dd7233bddbb4efcf314999"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int pn_terminus_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td>
<td class="paramname"><em>terminus</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td>
<td class="paramname"><em>src</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy a terminus object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>the terminus object to be copied into </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>the terminus to be copied from </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </dd></dl>
</div>
</div>
<a class="anchor" id="ga91a7d1ca890c3171220ea7d1eaa57b86"></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="a00011.html#a5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a>* pn_terminus_filter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td>
<td class="paramname"><em>terminus</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Access/modify the AMQP filter set for a terminus object. </p>
<p>This operation will return a pointer to a <a class="el" href="a00011.html#a5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> object that is valid until the terminus object is freed due to its parent link being freed. Any data contained by the <a class="el" href="a00011.html#a5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> object will be sent as the AMQP filter set for the parent terminus object. Note that this MUST take the form of a symbol keyed map to be valid.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a source terminus object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to a pn_data_t representing the terminus filter set </dd></dl>
</div>
</div>
<a class="anchor" id="gaf7ce75acdf855eaf7637abcd4131d6b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> const char* pn_terminus_get_address </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td>
<td class="paramname"><em>terminus</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the address of a terminus object. </p>
<p>The pointer returned by this operation is valid until <a class="el" href="a00057.html#gae55a8e0c226942c3ce122fa1e453148c" title="Set the address of a terminus object. ">pn_terminus_set_address</a> is called or until the terminus is freed due to its parent link being freed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the address </dd></dl>
</div>
</div>
<a class="anchor" id="ga575d3d03d45453bce10392b120e35a50"></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="a00057.html#gac6fb89a5fa96476db51b60f10dc785d0">pn_distribution_mode_t</a> pn_terminus_get_distribution_mode </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td>
<td class="paramname"><em>terminus</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the distribution mode of a terminus object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the distribution mode of the terminus </dd></dl>
</div>
</div>
<a class="anchor" id="gabaa9f17714567505f194d6fbb3ad785c"></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="a00057.html#ga213267363be45848f3299471ea93089b">pn_durability_t</a> pn_terminus_get_durability </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td>
<td class="paramname"><em>terminus</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the durability mode of a terminus object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the terminus durability mode </dd></dl>
</div>
</div>
<a class="anchor" id="ga4ea6ce82047f3fab63e70a29b74b5fcf"></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="a00057.html#gab4089b27ee99a348deab776f3d4931f0">pn_expiry_policy_t</a> pn_terminus_get_expiry_policy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td>
<td class="paramname"><em>terminus</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the expiry policy of a terminus object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the expiry policy of the terminus </dd></dl>
</div>
</div>
<a class="anchor" id="gadf6f4e80e36b70803acab67b12a35a14"></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="a00060.html#gafdede9be0526a8d0b9ab5d3149069af1">pn_seconds_t</a> pn_terminus_get_timeout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td>
<td class="paramname"><em>terminus</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the timeout of a terminus object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the timeout of the terminus </dd></dl>
</div>
</div>
<a class="anchor" id="gaaef31d25eb233aace7be1e0174fbf55e"></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="a00057.html#ga3cb9c86d1e2bb024de2658f9def098e7">pn_terminus_type_t</a> pn_terminus_get_type </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td>
<td class="paramname"><em>terminus</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the type of a terminus object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the terminus type </dd></dl>
</div>
</div>
<a class="anchor" id="ga66ac0a6b680d16588f6e95e0804c64f5"></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_terminus_is_dynamic </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td>
<td class="paramname"><em>terminus</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the dynamic flag for a terminus object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the dynamic flag is set for the terminus, false otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="gab27e5d1e2e0d1610ff9d9819d89f4bed"></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="a00011.html#a5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a>* pn_terminus_outcomes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td>
<td class="paramname"><em>terminus</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Access/modify the AMQP outcomes for a terminus object. </p>
<p>This operation will return a pointer to a <a class="el" href="a00011.html#a5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> object that is valid until the terminus object is freed due to its parent link being freed. Any data contained by the <a class="el" href="a00011.html#a5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> object will be sent as the AMQP outcomes for the parent terminus object. Note that this MUST take the form of an array of symbols to be valid.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to a pn_data_t representing the terminus outcomes </dd></dl>
</div>
</div>
<a class="anchor" id="ga166a84223f2e17a8d122bf19e5ebe0e3"></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="a00011.html#a5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a>* pn_terminus_properties </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td>
<td class="paramname"><em>terminus</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Access/modify the AMQP properties data for a terminus object. </p>
<p>This operation will return a pointer to a <a class="el" href="a00011.html#a5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> object that is valid until the terminus object is freed due to its parent link being freed. Any data contained by the <a class="el" href="a00011.html#a5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> object will be sent as the AMQP properties for the parent terminus object. Note that this MUST take the form of a symbol keyed map to be valid.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to a pn_data_t representing the terminus properties </dd></dl>
</div>
</div>
<a class="anchor" id="gae55a8e0c226942c3ce122fa1e453148c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int pn_terminus_set_address </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td>
<td class="paramname"><em>terminus</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>address</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the address of a terminus object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">address</td><td>an AMQP address string </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </dd></dl>
</div>
</div>
<a class="anchor" id="gad4abc043078d14aeeaef3116500d62e1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int pn_terminus_set_distribution_mode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td>
<td class="paramname"><em>terminus</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00057.html#gac6fb89a5fa96476db51b60f10dc785d0">pn_distribution_mode_t</a> </td>
<td class="paramname"><em>mode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the distribution mode of a terminus object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>the distribution mode for the terminus </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </dd></dl>
</div>
</div>
<a class="anchor" id="ga386428e4d1742649fffa112f231a3bf8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int pn_terminus_set_durability </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td>
<td class="paramname"><em>terminus</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00057.html#ga213267363be45848f3299471ea93089b">pn_durability_t</a> </td>
<td class="paramname"><em>durability</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the durability mode of a terminus object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">durability</td><td>the terminus durability mode </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </dd></dl>
</div>
</div>
<a class="anchor" id="ga8600194fb12e709bb165249996d3d136"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int pn_terminus_set_dynamic </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td>
<td class="paramname"><em>terminus</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>dynamic</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the dynamic flag for a terminus object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dynamic</td><td>the dynamic flag for the terminus </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </dd></dl>
</div>
</div>
<a class="anchor" id="gace5b1ae5c177b3d072d619567e20c2a3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int pn_terminus_set_expiry_policy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td>
<td class="paramname"><em>terminus</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00057.html#gab4089b27ee99a348deab776f3d4931f0">pn_expiry_policy_t</a> </td>
<td class="paramname"><em>policy</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the expiry policy of a terminus object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">policy</td><td>the expiry policy for the terminus </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </dd></dl>
</div>
</div>
<a class="anchor" id="gafe5932e60e778827a0b6c27e7748a814"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int pn_terminus_set_timeout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td>
<td class="paramname"><em>terminus</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00060.html#gafdede9be0526a8d0b9ab5d3149069af1">pn_seconds_t</a> </td>
<td class="paramname"><em>timeout</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the timeout of a terminus object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>the timeout for the terminus </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </dd></dl>
</div>
</div>
<a class="anchor" id="gafe106dcd053dd04b0fdbc9b40b58e23d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int pn_terminus_set_type </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td>
<td class="paramname"><em>terminus</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00057.html#ga3cb9c86d1e2bb024de2658f9def098e7">pn_terminus_type_t</a> </td>
<td class="paramname"><em>type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the type of a terminus object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>the terminus type </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </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>
|