http://git-wip-us.apache.org/repos/asf/qpid-site/blob/36c59045/content/releases/qpid-proton-master/proton/c/api/group__session.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/group__session.html b/content/releases/qpid-proton-master/proton/c/api/group__session.html index 8fa6077..3bef661 100755 --- a/content/releases/qpid-proton-master/proton/c/api/group__session.html +++ b/content/releases/qpid-proton-master/proton/c/api/group__session.html @@ -3,7 +3,8 @@ <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.11"/> +<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> @@ -14,7 +15,6 @@ <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/searchdata.js"></script> @@ -55,7 +55,7 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.8.11 --> +<!-- Generated by Doxygen 1.8.13 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> @@ -169,7 +169,9 @@ Functions</h2></td></tr> <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 class="anchor" id="ga38ccb93b8f5c2892adafce5d5f0fbcd9"></a> +<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"> @@ -185,7 +187,9 @@ Functions</h2></td></tr> </div> </div> <h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="ga1feff407b8fe308a14f283d193246f3c"></a> +<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"> @@ -208,16 +212,18 @@ Functions</h2></td></tr> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>a pointer to the new session </dd></dl> -<dl><dt><b>Examples: </b></dt><dd><a class="el" href="receive_8c-example.html#a18">receive.c</a>, and <a class="el" href="send_8c-example.html#a36">send.c</a>.</dd> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="receive_8c-example.html#a18">receive.c</a>, and <a class="el" href="send_8c-example.html#a29">send.c</a>.</dd> </dl> </div> </div> -<a class="anchor" id="ga0128a4413f413569b91e2bc78217728a"></a> +<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">pn_record_t* pn_session_attachments </td> + <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> @@ -226,23 +232,26 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Get the attachments that are associated with a session object. </p> +<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 whose attachments are to be returned. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>the session object to free (or NULL) </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>the attachments for the session object </dd></dl> - +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a74">broker.c</a>.</dd> +</dl> </div> </div> -<a class="anchor" id="ga12e5c4e71b0df4087d16ccc8b63b42b5"></a> +<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_close </td> + <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> @@ -250,25 +259,65 @@ Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> +<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000010">Deprecated:</a></b></dt><dd></dd></dl> +<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">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> -<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> +</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"> +<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000011">Deprecated:</a></b></dt><dd></dd></dl> +<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">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> -<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a75">broker.c</a>, and <a class="el" href="receive_8c-example.html#a36">receive.c</a>.</dd> -</dl> + </div> </div> -<a class="anchor" id="gafdb7b3d530adaaf30aecc73ca6319cf3"></a> +<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"><a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a>* pn_session_condition </td> + <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> @@ -277,25 +326,25 @@ Functions</h2></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> +<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 object </td></tr> + <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 session's local condition object </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>the attachments for the session object </dd></dl> </div> </div> -<a class="anchor" id="gaa45a8aa758334528a86cb7914ebe8545"></a> +<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#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a>* pn_session_connection </td> + <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> @@ -304,20 +353,20 @@ Functions</h2></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> +<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 parent connection object </dd></dl> -<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a2">broker.c</a>, <a class="el" href="receive_8c-example.html#a38">receive.c</a>, and <a class="el" href="send_8c-example.html#a46">send.c</a>.</dd> -</dl> +<dl class="section return"><dt>Returns</dt><dd>the session's state flags </dd></dl> + </div> </div> -<a class="anchor" id="ga1685531ca6fb6fb1058d5455a3c3edde"></a> +<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"> @@ -344,12 +393,14 @@ Functions</h2></td></tr> </div> </div> -<a class="anchor" id="ga0f95b5177494a68991d75444c2f6f812"></a> +<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">void pn_session_free </td> + <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> @@ -358,24 +409,27 @@ Functions</h2></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> +<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 to free (or NULL) </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>the session object </td></tr> </table> </dd> </dl> -<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a76">broker.c</a>.</dd> -</dl> +<dl class="section return"><dt>Returns</dt><dd>the session's local condition object </dd></dl> + </div> </div> -<a class="anchor" id="ga07da6cda67bdb37511b0aa9c8a04d532"></a> +<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">void* pn_session_get_context </td> + <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> @@ -383,25 +437,29 @@ Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000010">Deprecated:</a></b></dt><dd></dd></dl> -<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">pn_session_set_context</a>.</p> + +<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 whose context is to be returned. </td></tr> + <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 application context for the session object </dd></dl> - +<dl class="section return"><dt>Returns</dt><dd>the session's remote condition object </dd></dl> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a72">broker.c</a>, <a class="el" href="direct_8c-example.html#a80">direct.c</a>, <a class="el" href="receive_8c-example.html#a44">receive.c</a>, and <a class="el" href="send_8c-example.html#a54">send.c</a>.</dd> +</dl> </div> </div> -<a class="anchor" id="ga1fdeb3d6606e869790a228d847136cb0"></a> +<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">size_t pn_session_get_incoming_capacity </td> + <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> @@ -410,24 +468,27 @@ Functions</h2></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> +<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 incoming capacity of the session in bytes </dd></dl> - +<dl class="section return"><dt>Returns</dt><dd>the parent connection object </dd></dl> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a1">broker.c</a>, <a class="el" href="direct_8c-example.html#a47">direct.c</a>, and <a class="el" href="receive_8c-example.html#a37">receive.c</a>.</dd> +</dl> </div> </div> -<a class="anchor" id="ga931b89bd737ab293056cb695dddd9800"></a> +<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">size_t pn_session_get_outgoing_window </td> + <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> @@ -436,60 +497,54 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Get the outgoing window for a session object. </p> +<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> -<dl class="section return"><dt>Returns</dt><dd>the outgoing window for the session </dd></dl> - +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a44">broker.c</a>, <a class="el" href="direct_8c-example.html#a72">direct.c</a>, <a class="el" href="receive_8c-example.html#a19">receive.c</a>, and <a class="el" href="send_8c-example.html#a30">send.c</a>.</dd> +</dl> </div> </div> -<a class="anchor" id="ga577d6f6659958c5d89cd56e944fbd999"></a> +<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"><a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a>* pn_session_head </td> + <td class="memname">void pn_session_close </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 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> - <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> +<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">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> + <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 first session owned by the connection that matches the mask, else NULL if no sessions match </dd></dl> - +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a73">broker.c</a>, <a class="el" href="direct_8c-example.html#a46">direct.c</a>, and <a class="el" href="receive_8c-example.html#a36">receive.c</a>.</dd> +</dl> </div> </div> -<a class="anchor" id="ga55a8429e178831556844ab251ef67c77"></a> +<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_incoming_bytes </td> + <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> @@ -498,23 +553,26 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Get the number of incoming bytes currently buffered by a session. </p> +<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 number of incoming bytes currently buffered </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="ga238754f924f84597056f3249a7e7a35f"></a> +<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"><a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a>* pn_session_next </td> + <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> @@ -522,8 +580,8 @@ Functions</h2></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> + <td class="paramtype">size_t </td> + <td class="paramname"><em>capacity</em> </td> </tr> <tr> <td></td> @@ -533,25 +591,26 @@ Functions</h2></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> +<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 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> + <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> -<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="ga2b345eada2c15249caaefaa894d1aae3"></a> +<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">void pn_session_open </td> + <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> @@ -560,49 +619,62 @@ Functions</h2></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> +<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><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a46">broker.c</a>, <a class="el" href="receive_8c-example.html#a19">receive.c</a>, and <a class="el" href="send_8c-example.html#a37">send.c</a>.</dd> -</dl> +<dl class="section return"><dt>Returns</dt><dd>the outgoing window for the session </dd></dl> + </div> </div> -<a class="anchor" id="gabcae388cdcb33e976b490525ec600b50"></a> +<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">size_t pn_session_outgoing_bytes </td> + <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><td>)</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>Get the number of outgoing bytes currently buffered by a session. </p> +<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> -<dl class="section return"><dt>Returns</dt><dd>the number of outgoing bytes currently buffered </dd></dl> </div> </div> -<a class="anchor" id="gae21b3fda1567bad1f8a8fe162ffaeece"></a> +<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"><a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a>* pn_session_remote_condition </td> + <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> @@ -611,71 +683,61 @@ Functions</h2></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> +<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 session's remote condition object </dd></dl> -<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a74">broker.c</a>, <a class="el" href="receive_8c-example.html#a45">receive.c</a>, and <a class="el" href="send_8c-example.html#a60">send.c</a>.</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="ga31f2e4cc76135f79e96453aa72d441b2"></a> +<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">void pn_session_set_context </td> + <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> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">void * </td> - <td class="paramname"><em>context</em> </td> - </tr> - <tr> + <td class="paramname"><em>session</em></td><td>)</td> <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#_deprecated000011">Deprecated:</a></b></dt><dd></dd></dl> -<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">pn_session_get_context</a>.</p> + +<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> - <tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>the application context </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="gaedc306d86e778cbf8eaaf528c3eacae9"></a> +<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">void pn_session_set_incoming_capacity </td> + <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__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> * </td> - <td class="paramname"><em>session</em>, </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">size_t </td> - <td class="paramname"><em>capacity</em> </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> @@ -685,24 +747,27 @@ Functions</h2></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> +<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">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> + <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="gaca5962e539688b4f31b5b91136aa3c79"></a> +<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">void pn_session_set_outgoing_window </td> + <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> @@ -710,8 +775,8 @@ Functions</h2></td></tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">size_t </td> - <td class="paramname"><em>window</em> </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> @@ -721,39 +786,16 @@ Functions</h2></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="ga7e2a4567e3488a225257e4d883a7e78f"></a> -<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> +<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 session object </td></tr> + <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 session's state flags </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> @@ -764,7 +806,7 @@ Functions</h2></td></tr> <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.11 </li> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> </ul> </div> </body>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/36c59045/content/releases/qpid-proton-master/proton/c/api/group__session.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/group__session.js b/content/releases/qpid-proton-master/proton/c/api/group__session.js index ca0dc72..c705f66 100755 --- a/content/releases/qpid-proton-master/proton/c/api/group__session.js +++ b/content/releases/qpid-proton-master/proton/c/api/group__session.js @@ -2,23 +2,23 @@ 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_close", "group__session.html#ga12e5c4e71b0df4087d16ccc8b63b42b5", 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_error", "group__session.html#ga1685531ca6fb6fb1058d5455a3c3edde", null ], - [ "pn_session_free", "group__session.html#ga0f95b5177494a68991d75444c2f6f812", null ], - [ "pn_session_get_context", "group__session.html#ga07da6cda67bdb37511b0aa9c8a04d532", null ], - [ "pn_session_get_incoming_capacity", "group__session.html#ga1fdeb3d6606e869790a228d847136cb0", null ], - [ "pn_session_get_outgoing_window", "group__session.html#ga931b89bd737ab293056cb695dddd9800", null ], - [ "pn_session_head", "group__session.html#ga577d6f6659958c5d89cd56e944fbd999", null ], - [ "pn_session_incoming_bytes", "group__session.html#ga55a8429e178831556844ab251ef67c77", null ], - [ "pn_session_next", "group__session.html#ga238754f924f84597056f3249a7e7a35f", null ], [ "pn_session_open", "group__session.html#ga2b345eada2c15249caaefaa894d1aae3", null ], - [ "pn_session_outgoing_bytes", "group__session.html#gabcae388cdcb33e976b490525ec600b50", null ], - [ "pn_session_remote_condition", "group__session.html#gae21b3fda1567bad1f8a8fe162ffaeece", null ], - [ "pn_session_set_context", "group__session.html#ga31f2e4cc76135f79e96453aa72d441b2", 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_state", "group__session.html#ga7e2a4567e3488a225257e4d883a7e78f", 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
