http://git-wip-us.apache.org/repos/asf/qpid-site/blob/ba8436ae/content/releases/qpid-proton-0.24.0/proton/c/api/group__session.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-0.24.0/proton/c/api/group__session.html b/content/releases/qpid-proton-0.24.0/proton/c/api/group__session.html new file mode 100755 index 0000000..57410e0 --- /dev/null +++ b/content/releases/qpid-proton-0.24.0/proton/c/api/group__session.html @@ -0,0 +1,814 @@ +<!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>Qpid Proton C API: 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="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { init_search(); }); +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Qpid Proton C API +  <span id="projectnumber">0.24.0</span> + </div> + </td> + <td> <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> +</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> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('group__session.html','');}); +</script> +<div id="doc-content"> +<!-- 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__core.html">Core</a></div></div> </div> +</div><!--header--> +<div class="contents"> + +<p>A container of links. +<a href="#details">More...</a></p> +<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:ga1feff407b8fe308a14f283d193246f3c"><td class="memItemLeft" align="right" valign="top"><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#ga1feff407b8fe308a14f283d193246f3c">pn_session</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="memdesc:ga1feff407b8fe308a14f283d193246f3c"><td class="mdescLeft"> </td><td class="mdescRight">Factory for creating a new session on a given connection object. <a href="#ga1feff407b8fe308a14f283d193246f3c">More...</a><br /></td></tr> +<tr class="separator:ga1feff407b8fe308a14f283d193246f3c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0f95b5177494a68991d75444c2f6f812"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#ga0f95b5177494a68991d75444c2f6f812">pn_session_free</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr> +<tr class="memdesc:ga0f95b5177494a68991d75444c2f6f812"><td class="mdescLeft"> </td><td class="mdescRight">Free a session object. <a href="#ga0f95b5177494a68991d75444c2f6f812">More...</a><br /></td></tr> +<tr class="separator:ga0f95b5177494a68991d75444c2f6f812"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga07da6cda67bdb37511b0aa9c8a04d532"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#ga07da6cda67bdb37511b0aa9c8a04d532">pn_session_get_context</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr> +<tr class="memdesc:ga07da6cda67bdb37511b0aa9c8a04d532"><td class="mdescLeft"> </td><td class="mdescRight"><b>Deprecated</b> - Use <a class="el" href="group__session.html#ga0128a4413f413569b91e2bc78217728a" title="Get the attachments that are associated with a session object. ">pn_session_attachments()</a>. <a href="#ga07da6cda67bdb37511b0aa9c8a04d532">More...</a><br /></td></tr> +<tr class="separator:ga07da6cda67bdb37511b0aa9c8a04d532"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga31f2e4cc76135f79e96453aa72d441b2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#ga31f2e4cc76135f79e96453aa72d441b2">pn_session_set_context</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session, void *context)</td></tr> +<tr class="memdesc:ga31f2e4cc76135f79e96453aa72d441b2"><td class="mdescLeft"> </td><td class="mdescRight"><b>Deprecated</b> - Use <a class="el" href="group__session.html#ga0128a4413f413569b91e2bc78217728a" title="Get the attachments that are associated with a session object. ">pn_session_attachments()</a>. <a href="#ga31f2e4cc76135f79e96453aa72d441b2">More...</a><br /></td></tr> +<tr class="separator:ga31f2e4cc76135f79e96453aa72d441b2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0128a4413f413569b91e2bc78217728a"><td class="memItemLeft" align="right" valign="top">pn_record_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#ga0128a4413f413569b91e2bc78217728a">pn_session_attachments</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr> +<tr class="memdesc:ga0128a4413f413569b91e2bc78217728a"><td class="mdescLeft"> </td><td class="mdescRight">Get the attachments that are associated with a session object. <a href="#ga0128a4413f413569b91e2bc78217728a">More...</a><br /></td></tr> +<tr class="separator:ga0128a4413f413569b91e2bc78217728a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7e2a4567e3488a225257e4d883a7e78f"><td class="memItemLeft" align="right" valign="top"><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#ga7e2a4567e3488a225257e4d883a7e78f">pn_session_state</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr> +<tr class="memdesc:ga7e2a4567e3488a225257e4d883a7e78f"><td class="mdescLeft"> </td><td class="mdescRight">Get the endpoint state flags for a session. <a href="#ga7e2a4567e3488a225257e4d883a7e78f">More...</a><br /></td></tr> +<tr class="separator:ga7e2a4567e3488a225257e4d883a7e78f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga1685531ca6fb6fb1058d5455a3c3edde"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#ga1685531ca6fb6fb1058d5455a3c3edde">pn_session_error</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr> +<tr class="memdesc:ga1685531ca6fb6fb1058d5455a3c3edde"><td class="mdescLeft"> </td><td class="mdescRight"><b>Deprecated</b> <a href="#ga1685531ca6fb6fb1058d5455a3c3edde">More...</a><br /></td></tr> +<tr class="separator:ga1685531ca6fb6fb1058d5455a3c3edde"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gafdb7b3d530adaaf30aecc73ca6319cf3"><td class="memItemLeft" align="right" valign="top"><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#gafdb7b3d530adaaf30aecc73ca6319cf3">pn_session_condition</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr> +<tr class="memdesc:gafdb7b3d530adaaf30aecc73ca6319cf3"><td class="mdescLeft"> </td><td class="mdescRight">Get the local condition associated with the session endpoint. <a href="#gafdb7b3d530adaaf30aecc73ca6319cf3">More...</a><br /></td></tr> +<tr class="separator:gafdb7b3d530adaaf30aecc73ca6319cf3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae21b3fda1567bad1f8a8fe162ffaeece"><td class="memItemLeft" align="right" valign="top"><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#gae21b3fda1567bad1f8a8fe162ffaeece">pn_session_remote_condition</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr> +<tr class="memdesc:gae21b3fda1567bad1f8a8fe162ffaeece"><td class="mdescLeft"> </td><td class="mdescRight">Get the remote condition associated with the session endpoint. <a href="#gae21b3fda1567bad1f8a8fe162ffaeece">More...</a><br /></td></tr> +<tr class="separator:gae21b3fda1567bad1f8a8fe162ffaeece"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa45a8aa758334528a86cb7914ebe8545"><td class="memItemLeft" align="right" valign="top"><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#gaa45a8aa758334528a86cb7914ebe8545">pn_session_connection</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr> +<tr class="memdesc:gaa45a8aa758334528a86cb7914ebe8545"><td class="mdescLeft"> </td><td class="mdescRight">Get the parent connection for a session object. <a href="#gaa45a8aa758334528a86cb7914ebe8545">More...</a><br /></td></tr> +<tr class="separator:gaa45a8aa758334528a86cb7914ebe8545"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2b345eada2c15249caaefaa894d1aae3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#ga2b345eada2c15249caaefaa894d1aae3">pn_session_open</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr> +<tr class="memdesc:ga2b345eada2c15249caaefaa894d1aae3"><td class="mdescLeft"> </td><td class="mdescRight">Open a session. <a href="#ga2b345eada2c15249caaefaa894d1aae3">More...</a><br /></td></tr> +<tr class="separator:ga2b345eada2c15249caaefaa894d1aae3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga12e5c4e71b0df4087d16ccc8b63b42b5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#ga12e5c4e71b0df4087d16ccc8b63b42b5">pn_session_close</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr> +<tr class="memdesc:ga12e5c4e71b0df4087d16ccc8b63b42b5"><td class="mdescLeft"> </td><td class="mdescRight">Close a session. <a href="#ga12e5c4e71b0df4087d16ccc8b63b42b5">More...</a><br /></td></tr> +<tr class="separator:ga12e5c4e71b0df4087d16ccc8b63b42b5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga1fdeb3d6606e869790a228d847136cb0"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#ga1fdeb3d6606e869790a228d847136cb0">pn_session_get_incoming_capacity</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr> +<tr class="memdesc:ga1fdeb3d6606e869790a228d847136cb0"><td class="mdescLeft"> </td><td class="mdescRight">Get the incoming capacity of the session measured in bytes. <a href="#ga1fdeb3d6606e869790a228d847136cb0">More...</a><br /></td></tr> +<tr class="separator:ga1fdeb3d6606e869790a228d847136cb0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaedc306d86e778cbf8eaaf528c3eacae9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#gaedc306d86e778cbf8eaaf528c3eacae9">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:gaedc306d86e778cbf8eaaf528c3eacae9"><td class="mdescLeft"> </td><td class="mdescRight">Set the incoming capacity for a session object. <a href="#gaedc306d86e778cbf8eaaf528c3eacae9">More...</a><br /></td></tr> +<tr class="separator:gaedc306d86e778cbf8eaaf528c3eacae9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga931b89bd737ab293056cb695dddd9800"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#ga931b89bd737ab293056cb695dddd9800">pn_session_get_outgoing_window</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr> +<tr class="memdesc:ga931b89bd737ab293056cb695dddd9800"><td class="mdescLeft"> </td><td class="mdescRight">Get the outgoing window for a session object. <a href="#ga931b89bd737ab293056cb695dddd9800">More...</a><br /></td></tr> +<tr class="separator:ga931b89bd737ab293056cb695dddd9800"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaca5962e539688b4f31b5b91136aa3c79"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#gaca5962e539688b4f31b5b91136aa3c79">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:gaca5962e539688b4f31b5b91136aa3c79"><td class="mdescLeft"> </td><td class="mdescRight">Set the outgoing window for a session object. <a href="#gaca5962e539688b4f31b5b91136aa3c79">More...</a><br /></td></tr> +<tr class="separator:gaca5962e539688b4f31b5b91136aa3c79"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gabcae388cdcb33e976b490525ec600b50"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#gabcae388cdcb33e976b490525ec600b50">pn_session_outgoing_bytes</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr> +<tr class="memdesc:gabcae388cdcb33e976b490525ec600b50"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of outgoing bytes currently buffered by a session. <a href="#gabcae388cdcb33e976b490525ec600b50">More...</a><br /></td></tr> +<tr class="separator:gabcae388cdcb33e976b490525ec600b50"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga55a8429e178831556844ab251ef67c77"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__session.html#ga55a8429e178831556844ab251ef67c77">pn_session_incoming_bytes</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session)</td></tr> +<tr class="memdesc:ga55a8429e178831556844ab251ef67c77"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of incoming bytes currently buffered by a session. <a href="#ga55a8429e178831556844ab251ef67c77">More...</a><br /></td></tr> +<tr class="separator:ga55a8429e178831556844ab251ef67c77"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga577d6f6659958c5d89cd56e944fbd999"><td class="memItemLeft" align="right" valign="top"><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#ga577d6f6659958c5d89cd56e944fbd999">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:ga577d6f6659958c5d89cd56e944fbd999"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the first session from a given connection that matches the specified state mask. <a href="#ga577d6f6659958c5d89cd56e944fbd999">More...</a><br /></td></tr> +<tr class="separator:ga577d6f6659958c5d89cd56e944fbd999"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga238754f924f84597056f3249a7e7a35f"><td class="memItemLeft" align="right" valign="top"><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#ga238754f924f84597056f3249a7e7a35f">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:ga238754f924f84597056f3249a7e7a35f"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the next session from a given connection that matches the specified state mask. <a href="#ga238754f924f84597056f3249a7e7a35f">More...</a><br /></td></tr> +<tr class="separator:ga238754f924f84597056f3249a7e7a35f"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<p>A container of links. </p> +<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="ga1feff407b8fe308a14f283d193246f3c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga1feff407b8fe308a14f283d193246f3c">◆ </a></span>pn_session()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><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="ga0f95b5177494a68991d75444c2f6f812"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga0f95b5177494a68991d75444c2f6f812">◆ </a></span>pn_session_free()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">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>the session object to free (or NULL) </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga07da6cda67bdb37511b0aa9c8a04d532"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga07da6cda67bdb37511b0aa9c8a04d532">◆ </a></span>pn_session_get_context()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">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"> + +<p><b>Deprecated</b> - Use <a class="el" href="group__session.html#ga0128a4413f413569b91e2bc78217728a" title="Get the attachments that are associated with a session object. ">pn_session_attachments()</a>. </p> +<p>Get the application context that is associated with a session object.</p> +<p>The application context for a session may be set using <a class="el" href="group__session.html#ga31f2e4cc76135f79e96453aa72d441b2" title="Deprecated - Use pn_session_attachments(). ">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="ga31f2e4cc76135f79e96453aa72d441b2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga31f2e4cc76135f79e96453aa72d441b2">◆ </a></span>pn_session_set_context()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">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"> + +<p><b>Deprecated</b> - Use <a class="el" href="group__session.html#ga0128a4413f413569b91e2bc78217728a" title="Get the attachments that are associated with a session object. ">pn_session_attachments()</a>. </p> +<p>Set a new application context for a session object.</p> +<p>The application context for a session object may be retrieved using <a class="el" href="group__session.html#ga07da6cda67bdb37511b0aa9c8a04d532" title="Deprecated - Use pn_session_attachments(). ">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="ga0128a4413f413569b91e2bc78217728a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga0128a4413f413569b91e2bc78217728a">◆ </a></span>pn_session_attachments()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">pn_record_t* 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="ga7e2a4567e3488a225257e4d883a7e78f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga7e2a4567e3488a225257e4d883a7e78f">◆ </a></span>pn_session_state()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><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 object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the session's state flags </dd></dl> + +</div> +</div> +<a id="ga1685531ca6fb6fb1058d5455a3c3edde"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga1685531ca6fb6fb1058d5455a3c3edde">◆ </a></span>pn_session_error()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">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><b>Deprecated</b> </p> +<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 session 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="gafdb7b3d530adaaf30aecc73ca6319cf3"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gafdb7b3d530adaaf30aecc73ca6319cf3">◆ </a></span>pn_session_condition()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><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="gae21b3fda1567bad1f8a8fe162ffaeece"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gae21b3fda1567bad1f8a8fe162ffaeece">◆ </a></span>pn_session_remote_condition()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><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="gaa45a8aa758334528a86cb7914ebe8545"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaa45a8aa758334528a86cb7914ebe8545">◆ </a></span>pn_session_connection()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><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="ga2b345eada2c15249caaefaa894d1aae3"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga2b345eada2c15249caaefaa894d1aae3">◆ </a></span>pn_session_open()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">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>the session object </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga12e5c4e71b0df4087d16ccc8b63b42b5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga12e5c4e71b0df4087d16ccc8b63b42b5">◆ </a></span>pn_session_close()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">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#ga2b345eada2c15249caaefaa894d1aae3" title="Open a session. ">pn_session_open</a>, in this case it is equivalent to calling <a class="el" href="group__session.html#ga2b345eada2c15249caaefaa894d1aae3" title="Open a session. ">pn_session_open</a> followed by <a class="el" href="group__session.html#ga12e5c4e71b0df4087d16ccc8b63b42b5" 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>the session object </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga1fdeb3d6606e869790a228d847136cb0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga1fdeb3d6606e869790a228d847136cb0">◆ </a></span>pn_session_get_incoming_capacity()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">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 can buffer.</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="gaedc306d86e778cbf8eaaf528c3eacae9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaedc306d86e778cbf8eaaf528c3eacae9">◆ </a></span>pn_session_set_incoming_capacity()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">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 can buffer, by governing the size of the session incoming-window for transfer frames. This happens in concert with the transport max frame size, and only when both values have been set.</p> +<p>NOTE: If set, this value must be greater than or equal to the negotiated frame size of the transport. The window is computed as a whole number of frames when dividing remaining capacity at a given time by the connection max frame size. As such, capacity and max frame size should be chosen so as to ensure the frame window isn't unduly small and limiting performance.</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 in bytes </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga931b89bd737ab293056cb695dddd9800"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga931b89bd737ab293056cb695dddd9800">◆ </a></span>pn_session_get_outgoing_window()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">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="gaca5962e539688b4f31b5b91136aa3c79"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaca5962e539688b4f31b5b91136aa3c79">◆ </a></span>pn_session_set_outgoing_window()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">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="gabcae388cdcb33e976b490525ec600b50"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gabcae388cdcb33e976b490525ec600b50">◆ </a></span>pn_session_outgoing_bytes()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">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>the 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="ga55a8429e178831556844ab251ef67c77"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga55a8429e178831556844ab251ef67c77">◆ </a></span>pn_session_incoming_bytes()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">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>the 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="ga577d6f6659958c5d89cd56e944fbd999"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga577d6f6659958c5d89cd56e944fbd999">◆ </a></span>pn_session_head()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><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="ga238754f924f84597056f3249a7e7a35f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga238754f924f84597056f3249a7e7a35f">◆ </a></span>pn_session_next()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><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#ga577d6f6659958c5d89cd56e944fbd999" 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#ga577d6f6659958c5d89cd56e944fbd999" 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#ga577d6f6659958c5d89cd56e944fbd999" 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#ga238754f924f84597056f3249a7e7a35f" 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> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="footer">Generated by + <a href="http://www.doxygen.org/index.html";> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + </ul> +</div> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/ba8436ae/content/releases/qpid-proton-0.24.0/proton/c/api/group__session.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-0.24.0/proton/c/api/group__session.js b/content/releases/qpid-proton-0.24.0/proton/c/api/group__session.js new file mode 100755 index 0000000..c705f66 --- /dev/null +++ b/content/releases/qpid-proton-0.24.0/proton/c/api/group__session.js @@ -0,0 +1,24 @@ +var group__session = +[ + [ "pn_session_t", "group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9", null ], + [ "pn_session", "group__session.html#ga1feff407b8fe308a14f283d193246f3c", null ], + [ "pn_session_free", "group__session.html#ga0f95b5177494a68991d75444c2f6f812", null ], + [ "pn_session_get_context", "group__session.html#ga07da6cda67bdb37511b0aa9c8a04d532", null ], + [ "pn_session_set_context", "group__session.html#ga31f2e4cc76135f79e96453aa72d441b2", null ], + [ "pn_session_attachments", "group__session.html#ga0128a4413f413569b91e2bc78217728a", null ], + [ "pn_session_state", "group__session.html#ga7e2a4567e3488a225257e4d883a7e78f", null ], + [ "pn_session_error", "group__session.html#ga1685531ca6fb6fb1058d5455a3c3edde", null ], + [ "pn_session_condition", "group__session.html#gafdb7b3d530adaaf30aecc73ca6319cf3", null ], + [ "pn_session_remote_condition", "group__session.html#gae21b3fda1567bad1f8a8fe162ffaeece", null ], + [ "pn_session_connection", "group__session.html#gaa45a8aa758334528a86cb7914ebe8545", null ], + [ "pn_session_open", "group__session.html#ga2b345eada2c15249caaefaa894d1aae3", null ], + [ "pn_session_close", "group__session.html#ga12e5c4e71b0df4087d16ccc8b63b42b5", null ], + [ "pn_session_get_incoming_capacity", "group__session.html#ga1fdeb3d6606e869790a228d847136cb0", null ], + [ "pn_session_set_incoming_capacity", "group__session.html#gaedc306d86e778cbf8eaaf528c3eacae9", null ], + [ "pn_session_get_outgoing_window", "group__session.html#ga931b89bd737ab293056cb695dddd9800", null ], + [ "pn_session_set_outgoing_window", "group__session.html#gaca5962e539688b4f31b5b91136aa3c79", null ], + [ "pn_session_outgoing_bytes", "group__session.html#gabcae388cdcb33e976b490525ec600b50", null ], + [ "pn_session_incoming_bytes", "group__session.html#ga55a8429e178831556844ab251ef67c77", null ], + [ "pn_session_head", "group__session.html#ga577d6f6659958c5d89cd56e944fbd999", null ], + [ "pn_session_next", "group__session.html#ga238754f924f84597056f3249a7e7a35f", null ] +]; \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org
