blob: 1f6cea43b5d5c9bd3f98fab9b61f9c39173551b4 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Qpid Proton C API: proton/session.h Source File</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>
<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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</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
&#160;<span id="projectnumber">0.32.0</span>
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
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.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('session_8h_source.html',''); initResizable(); });
/* @license-end */
</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="headertitle">
<div class="title">session.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="session_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef PROTON_SESSION_H</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define PROTON_SESSION_H 1</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160; </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * distributed with this work for additional information</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * &quot;License&quot;); you may not use this file except in compliance</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * with the License. You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * software distributed under the License is distributed on an</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> * &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> * KIND, either express or implied. See the License for the</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> * specific language governing permissions and limitations</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"> * under the License.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;proton/import_export.h&gt;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;proton/type_compat.h&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="types_8h.html">proton/types.h</a>&gt;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &lt;proton/object.h&gt;</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="error_8h.html">proton/error.h</a>&gt;</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="condition_8h.html">proton/condition.h</a>&gt;</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#include &lt;stddef.h&gt;</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="group__session.html#ga1feff407b8fe308a14f283d193246f3c"> 55</a></span>&#160;PN_EXTERN <a class="code" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *<a class="code" href="group__session.html#ga1feff407b8fe308a14f283d193246f3c">pn_session</a>(<a class="code" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; </div>
<div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="group__session.html#ga0f95b5177494a68991d75444c2f6f812"> 67</a></span>&#160;PN_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__session.html#ga0f95b5177494a68991d75444c2f6f812">pn_session_free</a>(<a class="code" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="group__session.html#ga07da6cda67bdb37511b0aa9c8a04d532"> 79</a></span>&#160;PN_EXTERN <span class="keywordtype">void</span> *<a class="code" href="group__session.html#ga07da6cda67bdb37511b0aa9c8a04d532">pn_session_get_context</a>(<a class="code" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; </div>
<div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="group__session.html#ga31f2e4cc76135f79e96453aa72d441b2"> 90</a></span>&#160;PN_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__session.html#ga31f2e4cc76135f79e96453aa72d441b2">pn_session_set_context</a>(<a class="code" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session, <span class="keywordtype">void</span> *context);</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; </div>
<div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="group__session.html#ga0128a4413f413569b91e2bc78217728a"> 98</a></span>&#160;PN_EXTERN pn_record_t *<a class="code" href="group__session.html#ga0128a4413f413569b91e2bc78217728a">pn_session_attachments</a>(<a class="code" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session);</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; </div>
<div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="group__session.html#ga7e2a4567e3488a225257e4d883a7e78f"> 106</a></span>&#160;PN_EXTERN <a class="code" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">pn_state_t</a> <a class="code" href="group__session.html#ga7e2a4567e3488a225257e4d883a7e78f">pn_session_state</a>(<a class="code" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session);</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; </div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;<span class="comment">/* PN_DEPRECATED(&quot;Use pn_session_condition&quot;) */</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"><a class="line" href="group__session.html#ga1685531ca6fb6fb1058d5455a3c3edde"> 128</a></span>&#160;PN_EXTERN <a class="code" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> *<a class="code" href="group__session.html#ga1685531ca6fb6fb1058d5455a3c3edde">pn_session_error</a>(<a class="code" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session);</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; </div>
<div class="line"><a name="l00146"></a><span class="lineno"><a class="line" href="group__session.html#gafdb7b3d530adaaf30aecc73ca6319cf3"> 146</a></span>&#160;PN_EXTERN <a class="code" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *<a class="code" href="group__session.html#gafdb7b3d530adaaf30aecc73ca6319cf3">pn_session_condition</a>(<a class="code" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session);</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; </div>
<div class="line"><a name="l00162"></a><span class="lineno"><a class="line" href="group__session.html#gae21b3fda1567bad1f8a8fe162ffaeece"> 162</a></span>&#160;PN_EXTERN <a class="code" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *<a class="code" href="group__session.html#gae21b3fda1567bad1f8a8fe162ffaeece">pn_session_remote_condition</a>(<a class="code" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session);</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; </div>
<div class="line"><a name="l00173"></a><span class="lineno"><a class="line" href="group__session.html#gaa45a8aa758334528a86cb7914ebe8545"> 173</a></span>&#160;PN_EXTERN <a class="code" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *<a class="code" href="group__session.html#gaa45a8aa758334528a86cb7914ebe8545">pn_session_connection</a>(<a class="code" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session);</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; </div>
<div class="line"><a name="l00183"></a><span class="lineno"><a class="line" href="group__session.html#ga2b345eada2c15249caaefaa894d1aae3"> 183</a></span>&#160;PN_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__session.html#ga2b345eada2c15249caaefaa894d1aae3">pn_session_open</a>(<a class="code" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session);</div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160; </div>
<div class="line"><a name="l00195"></a><span class="lineno"><a class="line" href="group__session.html#ga12e5c4e71b0df4087d16ccc8b63b42b5"> 195</a></span>&#160;PN_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__session.html#ga12e5c4e71b0df4087d16ccc8b63b42b5">pn_session_close</a>(<a class="code" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session);</div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; </div>
<div class="line"><a name="l00206"></a><span class="lineno"><a class="line" href="group__session.html#ga1fdeb3d6606e869790a228d847136cb0"> 206</a></span>&#160;PN_EXTERN <span class="keywordtype">size_t</span> <a class="code" href="group__session.html#ga1fdeb3d6606e869790a228d847136cb0">pn_session_get_incoming_capacity</a>(<a class="code" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session);</div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160; </div>
<div class="line"><a name="l00225"></a><span class="lineno"><a class="line" href="group__session.html#gaedc306d86e778cbf8eaaf528c3eacae9"> 225</a></span>&#160;PN_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__session.html#gaedc306d86e778cbf8eaaf528c3eacae9">pn_session_set_incoming_capacity</a>(<a class="code" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session, <span class="keywordtype">size_t</span> capacity);</div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160; </div>
<div class="line"><a name="l00233"></a><span class="lineno"><a class="line" href="group__session.html#ga931b89bd737ab293056cb695dddd9800"> 233</a></span>&#160;PN_EXTERN <span class="keywordtype">size_t</span> <a class="code" href="group__session.html#ga931b89bd737ab293056cb695dddd9800">pn_session_get_outgoing_window</a>(<a class="code" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session);</div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span>&#160; </div>
<div class="line"><a name="l00241"></a><span class="lineno"><a class="line" href="group__session.html#gaca5962e539688b4f31b5b91136aa3c79"> 241</a></span>&#160;PN_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__session.html#gaca5962e539688b4f31b5b91136aa3c79">pn_session_set_outgoing_window</a>(<a class="code" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session, <span class="keywordtype">size_t</span> window);</div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160; </div>
<div class="line"><a name="l00249"></a><span class="lineno"><a class="line" href="group__session.html#gabcae388cdcb33e976b490525ec600b50"> 249</a></span>&#160;PN_EXTERN <span class="keywordtype">size_t</span> <a class="code" href="group__session.html#gabcae388cdcb33e976b490525ec600b50">pn_session_outgoing_bytes</a>(<a class="code" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session);</div>
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span>&#160; </div>
<div class="line"><a name="l00257"></a><span class="lineno"><a class="line" href="group__session.html#ga55a8429e178831556844ab251ef67c77"> 257</a></span>&#160;PN_EXTERN <span class="keywordtype">size_t</span> <a class="code" href="group__session.html#ga55a8429e178831556844ab251ef67c77">pn_session_incoming_bytes</a>(<a class="code" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session);</div>
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span>&#160; </div>
<div class="line"><a name="l00275"></a><span class="lineno"><a class="line" href="group__session.html#ga577d6f6659958c5d89cd56e944fbd999"> 275</a></span>&#160;PN_EXTERN <a class="code" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *<a class="code" href="group__session.html#ga577d6f6659958c5d89cd56e944fbd999">pn_session_head</a>(<a class="code" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection, <a class="code" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">pn_state_t</a> state);</div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span>&#160; </div>
<div class="line"><a name="l00291"></a><span class="lineno"><a class="line" href="group__session.html#ga238754f924f84597056f3249a7e7a35f"> 291</a></span>&#160;PN_EXTERN <a class="code" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *<a class="code" href="group__session.html#ga238754f924f84597056f3249a7e7a35f">pn_session_next</a>(<a class="code" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session, <a class="code" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">pn_state_t</a> state);</div>
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span>&#160; </div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span>&#160;}</div>
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span>&#160; </div>
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* session.h */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="agroup__session_html_ga55a8429e178831556844ab251ef67c77"><div class="ttname"><a href="group__session.html#ga55a8429e178831556844ab251ef67c77">pn_session_incoming_bytes</a></div><div class="ttdeci">size_t pn_session_incoming_bytes(pn_session_t *session)</div><div class="ttdoc">Get the number of incoming bytes currently buffered by a session.</div></div>
<div class="ttc" id="atypes_8h_html"><div class="ttname"><a href="types_8h.html">types.h</a></div><div class="ttdoc">AMQP and API data types.</div></div>
<div class="ttc" id="agroup__session_html_ga7e2a4567e3488a225257e4d883a7e78f"><div class="ttname"><a href="group__session.html#ga7e2a4567e3488a225257e4d883a7e78f">pn_session_state</a></div><div class="ttdeci">pn_state_t pn_session_state(pn_session_t *session)</div><div class="ttdoc">Get the endpoint state flags for a session.</div></div>
<div class="ttc" id="agroup__error_html_ga24a289d5b32c9bd8a775600a5af83d52"><div class="ttname"><a href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a></div><div class="ttdeci">struct pn_error_t pn_error_t</div><div class="ttdoc">An int error code and some string text to describe the error.</div><div class="ttdef"><b>Definition:</b> error.h:44</div></div>
<div class="ttc" id="agroup__connection_html_gaa83193a655e32bffc18624acc2c39233"><div class="ttname"><a href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">pn_state_t</a></div><div class="ttdeci">int pn_state_t</div><div class="ttdoc">Holds the state flags for an AMQP endpoint.</div><div class="ttdef"><b>Definition:</b> types.h:271</div></div>
<div class="ttc" id="agroup__session_html_ga1fdeb3d6606e869790a228d847136cb0"><div class="ttname"><a href="group__session.html#ga1fdeb3d6606e869790a228d847136cb0">pn_session_get_incoming_capacity</a></div><div class="ttdeci">size_t pn_session_get_incoming_capacity(pn_session_t *session)</div><div class="ttdoc">Get the incoming capacity of the session measured in bytes.</div></div>
<div class="ttc" id="agroup__session_html_ga577d6f6659958c5d89cd56e944fbd999"><div class="ttname"><a href="group__session.html#ga577d6f6659958c5d89cd56e944fbd999">pn_session_head</a></div><div class="ttdeci">pn_session_t * pn_session_head(pn_connection_t *connection, pn_state_t state)</div><div class="ttdoc">Retrieve the first session from a given connection that matches the specified state mask.</div></div>
<div class="ttc" id="agroup__session_html_ga2b345eada2c15249caaefaa894d1aae3"><div class="ttname"><a href="group__session.html#ga2b345eada2c15249caaefaa894d1aae3">pn_session_open</a></div><div class="ttdeci">void pn_session_open(pn_session_t *session)</div><div class="ttdoc">Open a session.</div></div>
<div class="ttc" id="agroup__session_html_ga1feff407b8fe308a14f283d193246f3c"><div class="ttname"><a href="group__session.html#ga1feff407b8fe308a14f283d193246f3c">pn_session</a></div><div class="ttdeci">pn_session_t * pn_session(pn_connection_t *connection)</div><div class="ttdoc">Factory for creating a new session on a given connection object.</div></div>
<div class="ttc" id="agroup__session_html_ga31f2e4cc76135f79e96453aa72d441b2"><div class="ttname"><a href="group__session.html#ga31f2e4cc76135f79e96453aa72d441b2">pn_session_set_context</a></div><div class="ttdeci">void pn_session_set_context(pn_session_t *session, void *context)</div><div class="ttdoc">Set a new application context for a session object.</div></div>
<div class="ttc" id="agroup__session_html_gafdb7b3d530adaaf30aecc73ca6319cf3"><div class="ttname"><a href="group__session.html#gafdb7b3d530adaaf30aecc73ca6319cf3">pn_session_condition</a></div><div class="ttdeci">pn_condition_t * pn_session_condition(pn_session_t *session)</div><div class="ttdoc">Get the local condition associated with the session endpoint.</div></div>
<div class="ttc" id="agroup__session_html_ga12e5c4e71b0df4087d16ccc8b63b42b5"><div class="ttname"><a href="group__session.html#ga12e5c4e71b0df4087d16ccc8b63b42b5">pn_session_close</a></div><div class="ttdeci">void pn_session_close(pn_session_t *session)</div><div class="ttdoc">Close a session.</div></div>
<div class="ttc" id="acondition_8h_html"><div class="ttname"><a href="condition_8h.html">condition.h</a></div><div class="ttdoc">An endpoint error state.</div></div>
<div class="ttc" id="agroup__session_html_ga238754f924f84597056f3249a7e7a35f"><div class="ttname"><a href="group__session.html#ga238754f924f84597056f3249a7e7a35f">pn_session_next</a></div><div class="ttdeci">pn_session_t * pn_session_next(pn_session_t *session, pn_state_t state)</div><div class="ttdoc">Retrieve the next session from a given connection that matches the specified state mask.</div></div>
<div class="ttc" id="agroup__condition_html_ga11eb7db7d2c205169fe3d47c996a95a5"><div class="ttname"><a href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a></div><div class="ttdeci">struct pn_condition_t pn_condition_t</div><div class="ttdoc">An AMQP Condition object.</div><div class="ttdef"><b>Definition:</b> condition.h:64</div></div>
<div class="ttc" id="aerror_8h_html"><div class="ttname"><a href="error_8h.html">error.h</a></div><div class="ttdoc">A Proton API error.</div></div>
<div class="ttc" id="agroup__connection_html_ga886351d81ff3a977a284a206526c5aff"><div class="ttname"><a href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a></div><div class="ttdeci">struct pn_connection_t pn_connection_t</div><div class="ttdoc">An AMQP Connection object.</div><div class="ttdef"><b>Definition:</b> types.h:285</div></div>
<div class="ttc" id="agroup__session_html_ga1685531ca6fb6fb1058d5455a3c3edde"><div class="ttname"><a href="group__session.html#ga1685531ca6fb6fb1058d5455a3c3edde">pn_session_error</a></div><div class="ttdeci">pn_error_t * pn_session_error(pn_session_t *session)</div><div class="ttdoc">Deprecated - Use pn_session_condition().</div></div>
<div class="ttc" id="agroup__session_html_gaedc306d86e778cbf8eaaf528c3eacae9"><div class="ttname"><a href="group__session.html#gaedc306d86e778cbf8eaaf528c3eacae9">pn_session_set_incoming_capacity</a></div><div class="ttdeci">void pn_session_set_incoming_capacity(pn_session_t *session, size_t capacity)</div><div class="ttdoc">Set the incoming capacity for a session object.</div></div>
<div class="ttc" id="agroup__session_html_ga07da6cda67bdb37511b0aa9c8a04d532"><div class="ttname"><a href="group__session.html#ga07da6cda67bdb37511b0aa9c8a04d532">pn_session_get_context</a></div><div class="ttdeci">void * pn_session_get_context(pn_session_t *session)</div><div class="ttdoc">Get the application context that is associated with a session object.</div></div>
<div class="ttc" id="agroup__session_html_gabcae388cdcb33e976b490525ec600b50"><div class="ttname"><a href="group__session.html#gabcae388cdcb33e976b490525ec600b50">pn_session_outgoing_bytes</a></div><div class="ttdeci">size_t pn_session_outgoing_bytes(pn_session_t *session)</div><div class="ttdoc">Get the number of outgoing bytes currently buffered by a session.</div></div>
<div class="ttc" id="agroup__session_html_ga0f95b5177494a68991d75444c2f6f812"><div class="ttname"><a href="group__session.html#ga0f95b5177494a68991d75444c2f6f812">pn_session_free</a></div><div class="ttdeci">void pn_session_free(pn_session_t *session)</div><div class="ttdoc">Free a session object.</div></div>
<div class="ttc" id="agroup__session_html_gae21b3fda1567bad1f8a8fe162ffaeece"><div class="ttname"><a href="group__session.html#gae21b3fda1567bad1f8a8fe162ffaeece">pn_session_remote_condition</a></div><div class="ttdeci">pn_condition_t * pn_session_remote_condition(pn_session_t *session)</div><div class="ttdoc">Get the remote condition associated with the session endpoint.</div></div>
<div class="ttc" id="agroup__session_html_ga38ccb93b8f5c2892adafce5d5f0fbcd9"><div class="ttname"><a href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a></div><div class="ttdeci">struct pn_session_t pn_session_t</div><div class="ttdoc">An AMQP Session object.</div><div class="ttdef"><b>Definition:</b> types.h:296</div></div>
<div class="ttc" id="agroup__session_html_gaca5962e539688b4f31b5b91136aa3c79"><div class="ttname"><a href="group__session.html#gaca5962e539688b4f31b5b91136aa3c79">pn_session_set_outgoing_window</a></div><div class="ttdeci">void pn_session_set_outgoing_window(pn_session_t *session, size_t window)</div><div class="ttdoc">Set the outgoing window for a session object.</div></div>
<div class="ttc" id="agroup__session_html_ga0128a4413f413569b91e2bc78217728a"><div class="ttname"><a href="group__session.html#ga0128a4413f413569b91e2bc78217728a">pn_session_attachments</a></div><div class="ttdeci">pn_record_t * pn_session_attachments(pn_session_t *session)</div><div class="ttdoc">Get the attachments that are associated with a session object.</div></div>
<div class="ttc" id="agroup__session_html_gaa45a8aa758334528a86cb7914ebe8545"><div class="ttname"><a href="group__session.html#gaa45a8aa758334528a86cb7914ebe8545">pn_session_connection</a></div><div class="ttdeci">pn_connection_t * pn_session_connection(pn_session_t *session)</div><div class="ttdoc">Get the parent connection for a session object.</div></div>
<div class="ttc" id="agroup__session_html_ga931b89bd737ab293056cb695dddd9800"><div class="ttname"><a href="group__session.html#ga931b89bd737ab293056cb695dddd9800">pn_session_get_outgoing_window</a></div><div class="ttdeci">size_t pn_session_get_outgoing_window(pn_session_t *session)</div><div class="ttdoc">Get the outgoing window for a session object.</div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_3a71568e5d046e5ed52679664c3002a5.html">proton</a></li><li class="navelem"><a class="el" href="session_8h.html">session.h</a></li>
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
</ul>
</div>
</body>
</html>