/usr/share/proton-0.14.0/docs/api-c/group__session.html is in libqpid-proton8-dev-doc 0.14.0-5.1ubuntu1.
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 | <!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>proton: Session</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">proton
 <span id="projectnumber">0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Session<div class="ingroups"><a class="el" href="group__engine.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="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga38ccb93b8f5c2892adafce5d5f0fbcd9"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a></td></tr>
<tr class="memdesc:ga38ccb93b8f5c2892adafce5d5f0fbcd9"><td class="mdescLeft"> </td><td class="mdescRight">An AMQP Session object. <a href="#ga38ccb93b8f5c2892adafce5d5f0fbcd9">More...</a><br /></td></tr>
<tr class="separator:ga38ccb93b8f5c2892adafce5d5f0fbcd9"><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:ga9ca2a8dae71d761598016798b9e13fc3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#ga9ca2a8dae71d761598016798b9e13fc3">pn_session</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr>
<tr class="memdesc:ga9ca2a8dae71d761598016798b9e13fc3"><td class="mdescLeft"> </td><td class="mdescRight">Factory for creating a new session on a given connection object. <a href="#ga9ca2a8dae71d761598016798b9e13fc3">More...</a><br /></td></tr>
<tr class="separator:ga9ca2a8dae71d761598016798b9e13fc3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0a431d267919f7bda16a9a91f8889c01"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#ga0a431d267919f7bda16a9a91f8889c01">pn_session_free</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr>
<tr class="memdesc:ga0a431d267919f7bda16a9a91f8889c01"><td class="mdescLeft"> </td><td class="mdescRight">Free a session object. <a href="#ga0a431d267919f7bda16a9a91f8889c01">More...</a><br /></td></tr>
<tr class="separator:ga0a431d267919f7bda16a9a91f8889c01"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf14527da4f91c8a4b6e383764fc6880f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#gaf14527da4f91c8a4b6e383764fc6880f">pn_session_get_context</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr>
<tr class="separator:gaf14527da4f91c8a4b6e383764fc6880f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7d906124c5cda5da5014e0e770d32223"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#ga7d906124c5cda5da5014e0e770d32223">pn_session_set_context</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session, void *context)</td></tr>
<tr class="separator:ga7d906124c5cda5da5014e0e770d32223"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6769d95e6fa34c61b9f4e0b504aabd77"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="object_8h.html#a70655c422210ccf8f4616e4c28a8b1d4">pn_record_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#ga6769d95e6fa34c61b9f4e0b504aabd77">pn_session_attachments</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr>
<tr class="memdesc:ga6769d95e6fa34c61b9f4e0b504aabd77"><td class="mdescLeft"> </td><td class="mdescRight">Get the attachments that are associated with a session object. <a href="#ga6769d95e6fa34c61b9f4e0b504aabd77">More...</a><br /></td></tr>
<tr class="separator:ga6769d95e6fa34c61b9f4e0b504aabd77"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga379badfc53a04a4ffa1262ec829a0d1e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">pn_state_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#ga379badfc53a04a4ffa1262ec829a0d1e">pn_session_state</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr>
<tr class="memdesc:ga379badfc53a04a4ffa1262ec829a0d1e"><td class="mdescLeft"> </td><td class="mdescRight">Get the endpoint state flags for a session. <a href="#ga379badfc53a04a4ffa1262ec829a0d1e">More...</a><br /></td></tr>
<tr class="separator:ga379badfc53a04a4ffa1262ec829a0d1e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadca7de4fef037bee39dec8e46d3b6633"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="error_8h.html#a24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#gadca7de4fef037bee39dec8e46d3b6633">pn_session_error</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr>
<tr class="memdesc:gadca7de4fef037bee39dec8e46d3b6633"><td class="mdescLeft"> </td><td class="mdescRight">Get additional error information associated with the session. <a href="#gadca7de4fef037bee39dec8e46d3b6633">More...</a><br /></td></tr>
<tr class="separator:gadca7de4fef037bee39dec8e46d3b6633"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae4be841a30fa987e5294b8225f7acf5e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#gae4be841a30fa987e5294b8225f7acf5e">pn_session_condition</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr>
<tr class="memdesc:gae4be841a30fa987e5294b8225f7acf5e"><td class="mdescLeft"> </td><td class="mdescRight">Get the local condition associated with the session endpoint. <a href="#gae4be841a30fa987e5294b8225f7acf5e">More...</a><br /></td></tr>
<tr class="separator:gae4be841a30fa987e5294b8225f7acf5e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga984a4465c17870a99f8dd33f2e03f8ff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#ga984a4465c17870a99f8dd33f2e03f8ff">pn_session_remote_condition</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr>
<tr class="memdesc:ga984a4465c17870a99f8dd33f2e03f8ff"><td class="mdescLeft"> </td><td class="mdescRight">Get the remote condition associated with the session endpoint. <a href="#ga984a4465c17870a99f8dd33f2e03f8ff">More...</a><br /></td></tr>
<tr class="separator:ga984a4465c17870a99f8dd33f2e03f8ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga427dff7259c2361931cdcd4d66073348"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#ga427dff7259c2361931cdcd4d66073348">pn_session_connection</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr>
<tr class="memdesc:ga427dff7259c2361931cdcd4d66073348"><td class="mdescLeft"> </td><td class="mdescRight">Get the parent connection for a session object. <a href="#ga427dff7259c2361931cdcd4d66073348">More...</a><br /></td></tr>
<tr class="separator:ga427dff7259c2361931cdcd4d66073348"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga050c0473324175a9a451e9d3e2766fac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#ga050c0473324175a9a451e9d3e2766fac">pn_session_open</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr>
<tr class="memdesc:ga050c0473324175a9a451e9d3e2766fac"><td class="mdescLeft"> </td><td class="mdescRight">Open a session. <a href="#ga050c0473324175a9a451e9d3e2766fac">More...</a><br /></td></tr>
<tr class="separator:ga050c0473324175a9a451e9d3e2766fac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadc22e0e15181526ac3119793f42cb2a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#gadc22e0e15181526ac3119793f42cb2a8">pn_session_close</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr>
<tr class="memdesc:gadc22e0e15181526ac3119793f42cb2a8"><td class="mdescLeft"> </td><td class="mdescRight">Close a session. <a href="#gadc22e0e15181526ac3119793f42cb2a8">More...</a><br /></td></tr>
<tr class="separator:gadc22e0e15181526ac3119793f42cb2a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac69e202dd7e6b3da142fcd715af2ae5c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#gac69e202dd7e6b3da142fcd715af2ae5c">pn_session_get_incoming_capacity</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr>
<tr class="memdesc:gac69e202dd7e6b3da142fcd715af2ae5c"><td class="mdescLeft"> </td><td class="mdescRight">Get the incoming capacity of the session measured in bytes. <a href="#gac69e202dd7e6b3da142fcd715af2ae5c">More...</a><br /></td></tr>
<tr class="separator:gac69e202dd7e6b3da142fcd715af2ae5c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga667f7da4fb4859e2ecef6e16d53e27cf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#ga667f7da4fb4859e2ecef6e16d53e27cf">pn_session_set_incoming_capacity</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session, size_t capacity)</td></tr>
<tr class="memdesc:ga667f7da4fb4859e2ecef6e16d53e27cf"><td class="mdescLeft"> </td><td class="mdescRight">Set the incoming capacity for a session object. <a href="#ga667f7da4fb4859e2ecef6e16d53e27cf">More...</a><br /></td></tr>
<tr class="separator:ga667f7da4fb4859e2ecef6e16d53e27cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8c0a63afcc6f41df1c7b548aee64ee58"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#ga8c0a63afcc6f41df1c7b548aee64ee58">pn_session_get_outgoing_window</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr>
<tr class="memdesc:ga8c0a63afcc6f41df1c7b548aee64ee58"><td class="mdescLeft"> </td><td class="mdescRight">Get the outgoing window for a session object. <a href="#ga8c0a63afcc6f41df1c7b548aee64ee58">More...</a><br /></td></tr>
<tr class="separator:ga8c0a63afcc6f41df1c7b548aee64ee58"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga59b64771b7bad4304aa92d76378e8baf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#ga59b64771b7bad4304aa92d76378e8baf">pn_session_set_outgoing_window</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session, size_t window)</td></tr>
<tr class="memdesc:ga59b64771b7bad4304aa92d76378e8baf"><td class="mdescLeft"> </td><td class="mdescRight">Set the outgoing window for a session object. <a href="#ga59b64771b7bad4304aa92d76378e8baf">More...</a><br /></td></tr>
<tr class="separator:ga59b64771b7bad4304aa92d76378e8baf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadc79b7203e0c3b0c71f808bf9b8ac357"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#gadc79b7203e0c3b0c71f808bf9b8ac357">pn_session_outgoing_bytes</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr>
<tr class="memdesc:gadc79b7203e0c3b0c71f808bf9b8ac357"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of outgoing bytes currently buffered by a session. <a href="#gadc79b7203e0c3b0c71f808bf9b8ac357">More...</a><br /></td></tr>
<tr class="separator:gadc79b7203e0c3b0c71f808bf9b8ac357"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga22c5eca3f2a55cd921878cc43808bba6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#ga22c5eca3f2a55cd921878cc43808bba6">pn_session_incoming_bytes</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr>
<tr class="memdesc:ga22c5eca3f2a55cd921878cc43808bba6"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of incoming bytes currently buffered by a session. <a href="#ga22c5eca3f2a55cd921878cc43808bba6">More...</a><br /></td></tr>
<tr class="separator:ga22c5eca3f2a55cd921878cc43808bba6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8aea90f33a085de6f9c6404660efbcb7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#ga8aea90f33a085de6f9c6404660efbcb7">pn_session_head</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection, <a class="el" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">pn_state_t</a> state)</td></tr>
<tr class="memdesc:ga8aea90f33a085de6f9c6404660efbcb7"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the first session from a given connection that matches the specified state mask. <a href="#ga8aea90f33a085de6f9c6404660efbcb7">More...</a><br /></td></tr>
<tr class="separator:ga8aea90f33a085de6f9c6404660efbcb7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8cdfa389f82b3f7001ed9f54a2884ad9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#ga8cdfa389f82b3f7001ed9f54a2884ad9">pn_session_next</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session, <a class="el" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">pn_state_t</a> state)</td></tr>
<tr class="memdesc:ga8cdfa389f82b3f7001ed9f54a2884ad9"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the next session from a given connection that matches the specified state mask. <a href="#ga8cdfa389f82b3f7001ed9f54a2884ad9">More...</a><br /></td></tr>
<tr class="separator:ga8cdfa389f82b3f7001ed9f54a2884ad9"><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 id="ga38ccb93b8f5c2892adafce5d5f0fbcd9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga38ccb93b8f5c2892adafce5d5f0fbcd9">◆ </a></span>pn_session_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> <a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An AMQP Session object. </p>
<p>A pn_session_t object encapsulates all of the endpoint state associated with an AMQP Session. A pn_session_t object contains zero or more <a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0" title="An AMQP Link object. ">pn_link_t</a> objects. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga9ca2a8dae71d761598016798b9e13fc3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9ca2a8dae71d761598016798b9e13fc3">◆ </a></span>pn_session()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a>* pn_session </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__connection.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>Factory for creating a new session on a given connection object. </p>
<p>Creates a new session object and adds it to the set of sessions maintained by the connection object.</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 object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the new session </dd></dl>
</div>
</div>
<a id="ga6769d95e6fa34c61b9f4e0b504aabd77"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6769d95e6fa34c61b9f4e0b504aabd77">◆ </a></span>pn_session_attachments()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="object_8h.html#a70655c422210ccf8f4616e4c28a8b1d4">pn_record_t</a>* pn_session_attachments </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the attachments that are associated with a session object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>the session whose attachments are to be returned. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the attachments for the session object </dd></dl>
</div>
</div>
<a id="gadc22e0e15181526ac3119793f42cb2a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadc22e0e15181526ac3119793f42cb2a8">◆ </a></span>pn_session_close()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_session_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close a session. </p>
<p>Once this operation has completed, the PN_LOCAL_CLOSED state flag will be set. This may be called without calling <a class="el" href="group__session.html#ga050c0473324175a9a451e9d3e2766fac" title="Open a session. ">pn_session_open</a>, in this case it is equivalent to calling <a class="el" href="group__session.html#ga050c0473324175a9a451e9d3e2766fac" title="Open a session. ">pn_session_open</a> followed by <a class="el" href="group__session.html#gadc22e0e15181526ac3119793f42cb2a8" title="Close a session. ">pn_session_close</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>a session object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gae4be841a30fa987e5294b8225f7acf5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae4be841a30fa987e5294b8225f7acf5e">◆ </a></span>pn_session_condition()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a>* pn_session_condition </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the local condition associated with the session endpoint. </p>
<p>The <a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5" title="An AMQP Condition object. ">pn_condition_t</a> object retrieved may be modified prior to closing the session in order to indicate a particular condition exists when the session closes. This is normally used to communicate error conditions to the remote peer, however it may also be used in non error cases. See <a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5" title="An AMQP Condition object. ">pn_condition_t</a> for more details.</p>
<p>The pointer returned by this operation is valid until the session object is freed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>the session object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the session's local condition object </dd></dl>
</div>
</div>
<a id="ga427dff7259c2361931cdcd4d66073348"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga427dff7259c2361931cdcd4d66073348">◆ </a></span>pn_session_connection()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a>* pn_session_connection </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the parent connection for a session object. </p>
<p>This operation retrieves the parent pn_connection_t object that contains the given pn_session_t object.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>the session object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the parent connection object </dd></dl>
</div>
</div>
<a id="gadca7de4fef037bee39dec8e46d3b6633"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadca7de4fef037bee39dec8e46d3b6633">◆ </a></span>pn_session_error()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="error_8h.html#a24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a>* pn_session_error </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get additional error information associated with the session. </p>
<p>Whenever a session operation fails (i.e. returns an error code), additional error details can be obtained using this function. The error object that is returned may also be used to clear the error condition.</p>
<p>The pointer returned by this operation is valid until the session object is freed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>the sesion object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the session's error object </dd></dl>
</div>
</div>
<a id="ga0a431d267919f7bda16a9a91f8889c01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0a431d267919f7bda16a9a91f8889c01">◆ </a></span>pn_session_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_session_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a session object. </p>
<p>When a session is freed it will no longer be retained by the connection once any internal references to the session are no longer needed. Freeing a session will free all links on that session and settle any deliveries on those links.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>a session object to free (or NULL) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaf14527da4f91c8a4b6e383764fc6880f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf14527da4f91c8a4b6e383764fc6880f">◆ </a></span>pn_session_get_context()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void* pn_session_get_context </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000008">Deprecated:</a></b></dt><dd>Get the application context that is associated with a session object.</dd></dl>
<p>The application context for a session may be set using <a class="el" href="group__session.html#ga7d906124c5cda5da5014e0e770d32223">pn_session_set_context</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>the session whose context is to be returned. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the application context for the session object </dd></dl>
</div>
</div>
<a id="gac69e202dd7e6b3da142fcd715af2ae5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac69e202dd7e6b3da142fcd715af2ae5c">◆ </a></span>pn_session_get_incoming_capacity()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> size_t pn_session_get_incoming_capacity </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the incoming capacity of the session measured in bytes. </p>
<p>The incoming capacity of a session determines how much incoming message data the session will buffer. Note that if this value is less than the negotiated frame size of the transport, it will be rounded up to one full frame.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>the session object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the incoming capacity of the session in bytes </dd></dl>
</div>
</div>
<a id="ga8c0a63afcc6f41df1c7b548aee64ee58"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8c0a63afcc6f41df1c7b548aee64ee58">◆ </a></span>pn_session_get_outgoing_window()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> size_t pn_session_get_outgoing_window </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the outgoing window for a session object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>the session object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the outgoing window for the session </dd></dl>
</div>
</div>
<a id="ga8aea90f33a085de6f9c6404660efbcb7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8aea90f33a085de6f9c6404660efbcb7">◆ </a></span>pn_session_head()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a>* pn_session_head </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td>
<td class="paramname"><em>connection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">pn_state_t</a> </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>Retrieve the first session from a given connection that matches the specified state mask. </p>
<p>Examines the state of each session owned by the connection, and returns the first session that matches the given state mask. If state contains both local and remote flags, then an exact match against those flags is performed. If state contains only local or only remote flags, then a match occurs if any of the local or remote flags are set respectively.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>to be searched for matching sessions </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>mask to match </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the first session owned by the connection that matches the mask, else NULL if no sessions match </dd></dl>
</div>
</div>
<a id="ga22c5eca3f2a55cd921878cc43808bba6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga22c5eca3f2a55cd921878cc43808bba6">◆ </a></span>pn_session_incoming_bytes()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> size_t pn_session_incoming_bytes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of incoming bytes currently buffered by a session. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>a session object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of incoming bytes currently buffered </dd></dl>
</div>
</div>
<a id="ga8cdfa389f82b3f7001ed9f54a2884ad9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8cdfa389f82b3f7001ed9f54a2884ad9">◆ </a></span>pn_session_next()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a>* pn_session_next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> * </td>
<td class="paramname"><em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">pn_state_t</a> </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>Retrieve the next session from a given connection that matches the specified state mask. </p>
<p>When used with <a class="el" href="group__session.html#ga8aea90f33a085de6f9c6404660efbcb7" title="Retrieve the first session from a given connection that matches the specified state mask...">pn_session_head</a>, application can access all sessions on the connection that match the given state. See <a class="el" href="group__session.html#ga8aea90f33a085de6f9c6404660efbcb7" title="Retrieve the first session from a given connection that matches the specified state mask...">pn_session_head</a> for description of match behavior.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>the previous session obtained from <a class="el" href="group__session.html#ga8aea90f33a085de6f9c6404660efbcb7" title="Retrieve the first session from a given connection that matches the specified state mask...">pn_session_head</a> or <a class="el" href="group__session.html#ga8cdfa389f82b3f7001ed9f54a2884ad9" title="Retrieve the next session from a given connection that matches the specified state mask...">pn_session_next</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>mask to match. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the next session owned by the connection that matches the mask, else NULL if no sessions match </dd></dl>
</div>
</div>
<a id="ga050c0473324175a9a451e9d3e2766fac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga050c0473324175a9a451e9d3e2766fac">◆ </a></span>pn_session_open()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_session_open </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open a session. </p>
<p>Once this operation has completed, the PN_LOCAL_ACTIVE state flag will be set.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>a session object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gadc79b7203e0c3b0c71f808bf9b8ac357"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadc79b7203e0c3b0c71f808bf9b8ac357">◆ </a></span>pn_session_outgoing_bytes()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> size_t pn_session_outgoing_bytes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of outgoing bytes currently buffered by a session. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>a session object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of outgoing bytes currently buffered </dd></dl>
</div>
</div>
<a id="ga984a4465c17870a99f8dd33f2e03f8ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga984a4465c17870a99f8dd33f2e03f8ff">◆ </a></span>pn_session_remote_condition()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a>* pn_session_remote_condition </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the remote condition associated with the session endpoint. </p>
<p>The <a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5" title="An AMQP Condition object. ">pn_condition_t</a> object retrieved may be examined in order to determine whether the remote peer was indicating some sort of exceptional condition when the remote session endpoint was closed. The <a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5" title="An AMQP Condition object. ">pn_condition_t</a> object returned may not be modified.</p>
<p>The pointer returned by this operation is valid until the session object is freed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>the session object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the session's remote condition object </dd></dl>
</div>
</div>
<a id="ga7d906124c5cda5da5014e0e770d32223"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7d906124c5cda5da5014e0e770d32223">◆ </a></span>pn_session_set_context()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_session_set_context </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> * </td>
<td class="paramname"><em>session</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">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000009">Deprecated:</a></b></dt><dd>Set a new application context for a session object.</dd></dl>
<p>The application context for a session object may be retrieved using <a class="el" href="group__session.html#gaf14527da4f91c8a4b6e383764fc6880f">pn_session_get_context</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>the session 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 id="ga667f7da4fb4859e2ecef6e16d53e27cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga667f7da4fb4859e2ecef6e16d53e27cf">◆ </a></span>pn_session_set_incoming_capacity()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_session_set_incoming_capacity </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> * </td>
<td class="paramname"><em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>capacity</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the incoming capacity for a session object. </p>
<p>The incoming capacity of a session determines how much incoming message data the session will buffer. Note that if this value is less than the negotiated frame size of the transport, it will be rounded up to one full frame.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>the session object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">capacity</td><td>the incoming capacity for the session </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga59b64771b7bad4304aa92d76378e8baf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga59b64771b7bad4304aa92d76378e8baf">◆ </a></span>pn_session_set_outgoing_window()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_session_set_outgoing_window </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> * </td>
<td class="paramname"><em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>window</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the outgoing window for a session object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>the session object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">window</td><td>the outgoing window for the session </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga379badfc53a04a4ffa1262ec829a0d1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga379badfc53a04a4ffa1262ec829a0d1e">◆ </a></span>pn_session_state()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">pn_state_t</a> pn_session_state </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the endpoint state flags for a session. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>the session </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the session's state flags </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Feb 4 2018 22:16:50 for proton by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
|