http://git-wip-us.apache.org/repos/asf/qpid-site/blob/de3c3488/content/releases/qpid-proton-0.15.0/proton/c/api/group__session.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-0.15.0/proton/c/api/group__session.html b/content/releases/qpid-proton-0.15.0/proton/c/api/group__session.html new file mode 100755 index 0000000..b91325d --- /dev/null +++ b/content/releases/qpid-proton-0.15.0/proton/c/api/group__session.html @@ -0,0 +1,720 @@ +<!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.3.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="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td style="padding-left: 0.5em;"> + <div id="projectname">Qpid Proton C API +  <span id="projectnumber">0.15.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.3.1 --> +<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)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:vo id(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#typedef-members">Typedefs</a> | +<a href="#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="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">PN_EXTERN <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="separator:ga9ca2a8dae71d761598016798b9e13fc3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0a431d267919f7bda16a9a91f8889c01"><td class="memItemLeft" align="right" valign="top">PN_EXTERN 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="separator:ga0a431d267919f7bda16a9a91f8889c01"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf14527da4f91c8a4b6e383764fc6880f"><td class="memItemLeft" align="right" valign="top">PN_EXTERN 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">PN_EXTERN 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">PN_EXTERN pn_record_t * </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="separator:ga6769d95e6fa34c61b9f4e0b504aabd77"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga379badfc53a04a4ffa1262ec829a0d1e"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <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="separator:ga379badfc53a04a4ffa1262ec829a0d1e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gadca7de4fef037bee39dec8e46d3b6633"><td class="memItemLeft" align="right" valign="top">PN_EXTERN pn_error_t * </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="separator:gadca7de4fef037bee39dec8e46d3b6633"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae4be841a30fa987e5294b8225f7acf5e"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <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="separator:gae4be841a30fa987e5294b8225f7acf5e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga984a4465c17870a99f8dd33f2e03f8ff"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <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="separator:ga984a4465c17870a99f8dd33f2e03f8ff"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga427dff7259c2361931cdcd4d66073348"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <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="separator:ga427dff7259c2361931cdcd4d66073348"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga050c0473324175a9a451e9d3e2766fac"><td class="memItemLeft" align="right" valign="top">PN_EXTERN 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="separator:ga050c0473324175a9a451e9d3e2766fac"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gadc22e0e15181526ac3119793f42cb2a8"><td class="memItemLeft" align="right" valign="top">PN_EXTERN 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="separator:gadc22e0e15181526ac3119793f42cb2a8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac69e202dd7e6b3da142fcd715af2ae5c"><td class="memItemLeft" align="right" valign="top">PN_EXTERN 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="separator:gac69e202dd7e6b3da142fcd715af2ae5c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga667f7da4fb4859e2ecef6e16d53e27cf"><td class="memItemLeft" align="right" valign="top">PN_EXTERN 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="separator:ga667f7da4fb4859e2ecef6e16d53e27cf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8c0a63afcc6f41df1c7b548aee64ee58"><td class="memItemLeft" align="right" valign="top">PN_EXTERN 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="separator:ga8c0a63afcc6f41df1c7b548aee64ee58"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga59b64771b7bad4304aa92d76378e8baf"><td class="memItemLeft" align="right" valign="top">PN_EXTERN 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="separator:ga59b64771b7bad4304aa92d76378e8baf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gadc79b7203e0c3b0c71f808bf9b8ac357"><td class="memItemLeft" align="right" valign="top">PN_EXTERN 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="separator:gadc79b7203e0c3b0c71f808bf9b8ac357"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga22c5eca3f2a55cd921878cc43808bba6"><td class="memItemLeft" align="right" valign="top">PN_EXTERN 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="separator:ga22c5eca3f2a55cd921878cc43808bba6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8aea90f33a085de6f9c6404660efbcb7"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <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="separator:ga8aea90f33a085de6f9c6404660efbcb7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8cdfa389f82b3f7001ed9f54a2884ad9"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <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="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 class="anchor" id="ga38ccb93b8f5c2892adafce5d5f0fbcd9"></a> +<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">pn_link_t</a> objects. </p> + +</div> +</div> +<h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="ga9ca2a8dae71d761598016798b9e13fc3"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <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 class="anchor" id="ga6769d95e6fa34c61b9f4e0b504aabd77"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN 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 class="anchor" id="gadc22e0e15181526ac3119793f42cb2a8"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN 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">pn_session_open</a>, in this case it is equivalent to calling <a class="el" href="group__session.html#ga050c0473324175a9a451e9d3e2766fac">pn_session_open</a> followed by <a class="el" href="group__session.html#gadc22e0e15181526ac3119793f42cb2a8">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 class="anchor" id="gae4be841a30fa987e5294b8225f7acf5e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <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">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">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 class="anchor" id="ga427dff7259c2361931cdcd4d66073348"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <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 class="anchor" id="gadca7de4fef037bee39dec8e46d3b6633"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN pn_error_t* 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 class="anchor" id="ga0a431d267919f7bda16a9a91f8889c01"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN 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 class="anchor" id="gaf14527da4f91c8a4b6e383764fc6880f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN 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 class="anchor" id="gac69e202dd7e6b3da142fcd715af2ae5c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN 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 class="anchor" id="ga8c0a63afcc6f41df1c7b548aee64ee58"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN 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 class="anchor" id="ga8aea90f33a085de6f9c6404660efbcb7"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <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 class="anchor" id="ga22c5eca3f2a55cd921878cc43808bba6"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN 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 class="anchor" id="ga8cdfa389f82b3f7001ed9f54a2884ad9"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <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">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">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">pn_session_head</a> or <a class="el" href="group__session.html#ga8cdfa389f82b3f7001ed9f54a2884ad9">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 class="anchor" id="ga050c0473324175a9a451e9d3e2766fac"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN 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 class="anchor" id="gadc79b7203e0c3b0c71f808bf9b8ac357"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN 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 class="anchor" id="ga984a4465c17870a99f8dd33f2e03f8ff"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <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">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">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 class="anchor" id="ga7d906124c5cda5da5014e0e770d32223"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN 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 class="anchor" id="ga667f7da4fb4859e2ecef6e16d53e27cf"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN 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 class="anchor" id="ga59b64771b7bad4304aa92d76378e8baf"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN 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 class="anchor" id="ga379badfc53a04a4ffa1262ec829a0d1e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <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 --> +</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.3.1 </li> + </ul> +</div> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/de3c3488/content/releases/qpid-proton-0.15.0/proton/c/api/group__session.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-0.15.0/proton/c/api/group__session.js b/content/releases/qpid-proton-0.15.0/proton/c/api/group__session.js new file mode 100755 index 0000000..a758600 --- /dev/null +++ b/content/releases/qpid-proton-0.15.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#ga9ca2a8dae71d761598016798b9e13fc3", null ], + [ "pn_session_attachments", "group__session.html#ga6769d95e6fa34c61b9f4e0b504aabd77", null ], + [ "pn_session_close", "group__session.html#gadc22e0e15181526ac3119793f42cb2a8", null ], + [ "pn_session_condition", "group__session.html#gae4be841a30fa987e5294b8225f7acf5e", null ], + [ "pn_session_connection", "group__session.html#ga427dff7259c2361931cdcd4d66073348", null ], + [ "pn_session_error", "group__session.html#gadca7de4fef037bee39dec8e46d3b6633", null ], + [ "pn_session_free", "group__session.html#ga0a431d267919f7bda16a9a91f8889c01", null ], + [ "pn_session_get_context", "group__session.html#gaf14527da4f91c8a4b6e383764fc6880f", null ], + [ "pn_session_get_incoming_capacity", "group__session.html#gac69e202dd7e6b3da142fcd715af2ae5c", null ], + [ "pn_session_get_outgoing_window", "group__session.html#ga8c0a63afcc6f41df1c7b548aee64ee58", null ], + [ "pn_session_head", "group__session.html#ga8aea90f33a085de6f9c6404660efbcb7", null ], + [ "pn_session_incoming_bytes", "group__session.html#ga22c5eca3f2a55cd921878cc43808bba6", null ], + [ "pn_session_next", "group__session.html#ga8cdfa389f82b3f7001ed9f54a2884ad9", null ], + [ "pn_session_open", "group__session.html#ga050c0473324175a9a451e9d3e2766fac", null ], + [ "pn_session_outgoing_bytes", "group__session.html#gadc79b7203e0c3b0c71f808bf9b8ac357", null ], + [ "pn_session_remote_condition", "group__session.html#ga984a4465c17870a99f8dd33f2e03f8ff", null ], + [ "pn_session_set_context", "group__session.html#ga7d906124c5cda5da5014e0e770d32223", null ], + [ "pn_session_set_incoming_capacity", "group__session.html#ga667f7da4fb4859e2ecef6e16d53e27cf", null ], + [ "pn_session_set_outgoing_window", "group__session.html#ga59b64771b7bad4304aa92d76378e8baf", null ], + [ "pn_session_state", "group__session.html#ga379badfc53a04a4ffa1262ec829a0d1e", 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
