http://git-wip-us.apache.org/repos/asf/qpid-site/blob/de3c3488/content/releases/qpid-proton-0.15.0/proton/c/api/group__transport.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-0.15.0/proton/c/api/group__transport.html b/content/releases/qpid-proton-0.15.0/proton/c/api/group__transport.html new file mode 100755 index 0000000..e893360 --- /dev/null +++ b/content/releases/qpid-proton-0.15.0/proton/c/api/group__transport.html @@ -0,0 +1,1751 @@ +<!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: Transport</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__transport.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="#groups">Modules</a> | +<a href="#define-members">Macros</a> | +<a href="#typedef-members">Typedefs</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">Transport<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="groups"></a> +Modules</h2></td></tr> +<tr class="memitem:group__sasl"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sasl.html">SASL</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:group__ssl"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html">SSL</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> +Macros</h2></td></tr> +<tr class="memitem:gae8f32e46e94953bab10bee530eee9044"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gae8f32e46e94953bab10bee530eee9044">PN_TRACE_OFF</a>   (0)</td></tr> +<tr class="separator:gae8f32e46e94953bab10bee530eee9044"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gafde0eb3c73fb98816f4238d42d48f3d8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gafde0eb3c73fb98816f4238d42d48f3d8">PN_TRACE_RAW</a>   (1)</td></tr> +<tr class="separator:gafde0eb3c73fb98816f4238d42d48f3d8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab8e04b4c128379ff27e6b801c0bce494"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gab8e04b4c128379ff27e6b801c0bce494">PN_TRACE_FRM</a>   (2)</td></tr> +<tr class="separator:gab8e04b4c128379ff27e6b801c0bce494"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7065ad65f95c995a24e416edc95aead4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga7065ad65f95c995a24e416edc95aead4">PN_TRACE_DRV</a>   (4)</td></tr> +<tr class="separator:ga7065ad65f95c995a24e416edc95aead4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3bde88d15fcfda400a36d8f9e5d51688"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga3bde88d15fcfda400a36d8f9e5d51688">PN_TRACE_EVT</a>   (8)</td></tr> +<tr class="separator:ga3bde88d15fcfda400a36d8f9e5d51688"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> +Typedefs</h2></td></tr> +<tr class="memitem:ga4695788da8491f0c7104bfe36634ff94"><td class="memItemLeft" align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga4695788da8491f0c7104bfe36634ff94">pn_trace_t</a></td></tr> +<tr class="separator:ga4695788da8491f0c7104bfe36634ff94"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3481dace48ff59d216127a63720038cd"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga3481dace48ff59d216127a63720038cd">pn_tracer_t</a> )(<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, const char *message)</td></tr> +<tr class="separator:ga3481dace48ff59d216127a63720038cd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac26eda05f649bbf0399f3d8d78d12fa8"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a></td></tr> +<tr class="separator:gac26eda05f649bbf0399f3d8d78d12fa8"><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:gad75d8d99018bc22c2d23ef8e820e7a6d"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gad75d8d99018bc22c2d23ef8e820e7a6d">pn_transport</a> (void)</td></tr> +<tr class="separator:gad75d8d99018bc22c2d23ef8e820e7a6d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0f9cecc86a7185e6c9f25ead5c46b82b"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga0f9cecc86a7185e6c9f25ead5c46b82b">pn_transport_set_server</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:ga0f9cecc86a7185e6c9f25ead5c46b82b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa1b0a748aad3cc35684ee095978dbd58"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gaa1b0a748aad3cc35684ee095978dbd58">pn_transport_free</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:gaa1b0a748aad3cc35684ee095978dbd58"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gafa71f9e73acbe139941b9ebe754b3241"><td class="memItemLeft" align="right" valign="top">PN_EXTERN const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gafa71f9e73acbe139941b9ebe754b3241">pn_transport_get_user</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:gafa71f9e73acbe139941b9ebe754b3241"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gafc2157ad11690d0b0679aa34db1a1d5a"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gafc2157ad11690d0b0679aa34db1a1d5a">pn_transport_require_auth</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, bool required)</td></tr> +<tr class="separator:gafc2157ad11690d0b0679aa34db1a1d5a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab35340b55e7a5cc6420ee8426c8e10ed"><td class="memItemLeft" align="right" valign="top">PN_EXTERN bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gab35340b55e7a5cc6420ee8426c8e10ed">pn_transport_is_authenticated</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:gab35340b55e7a5cc6420ee8426c8e10ed"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gadfc4a4be3de102890cc5c0ee4c1d8481"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gadfc4a4be3de102890cc5c0ee4c1d8481">pn_transport_require_encryption</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, bool required)</td></tr> +<tr class="separator:gadfc4a4be3de102890cc5c0ee4c1d8481"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8e5deef63ba7b1483a6fadec65c1c3b5"><td class="memItemLeft" align="right" valign="top">PN_EXTERN bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga8e5deef63ba7b1483a6fadec65c1c3b5">pn_transport_is_encrypted</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:ga8e5deef63ba7b1483a6fadec65c1c3b5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2d0ad8e3e702ed47088789e33bf0c457"><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__transport.html#ga2d0ad8e3e702ed47088789e33bf0c457">pn_transport_condition</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:ga2d0ad8e3e702ed47088789e33bf0c457"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga00a271caac7d531ae795d78db81199e9"><td class="memItemLeft" align="right" valign="top">PN_EXTERN pn_error_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga00a271caac7d531ae795d78db81199e9">pn_transport_error</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:ga00a271caac7d531ae795d78db81199e9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad07706c1e7db90d1b5d0ad6caf4c5892"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gad07706c1e7db90d1b5d0ad6caf4c5892">pn_transport_bind</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, <a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="separator:gad07706c1e7db90d1b5d0ad6caf4c5892"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf0e4c15f27f610ca4c5d64c0f4e95f07"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gaf0e4c15f27f610ca4c5d64c0f4e95f07">pn_transport_unbind</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:gaf0e4c15f27f610ca4c5d64c0f4e95f07"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaee7ed090a3fa99d9f46d145939af893b"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gaee7ed090a3fa99d9f46d145939af893b">pn_transport_trace</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, <a class="el" href="group__transport.html#ga4695788da8491f0c7104bfe36634ff94">pn_trace_t</a> trace)</td></tr> +<tr class="separator:gaee7ed090a3fa99d9f46d145939af893b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaad5defb0c74cea7e7224c13edfc86c47"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gaad5defb0c74cea7e7224c13edfc86c47">pn_transport_set_tracer</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, <a class="el" href="group__transport.html#ga3481dace48ff59d216127a63720038cd">pn_tracer_t</a> tracer)</td></tr> +<tr class="separator:gaad5defb0c74cea7e7224c13edfc86c47"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga99b48ee38d0bc21855eee158f8584aca"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__transport.html#ga3481dace48ff59d216127a63720038cd">pn_tracer_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga99b48ee38d0bc21855eee158f8584aca">pn_transport_get_tracer</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:ga99b48ee38d0bc21855eee158f8584aca"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9016acfea374d8b58183158b8d857ee8"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga9016acfea374d8b58183158b8d857ee8">pn_transport_get_context</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:ga9016acfea374d8b58183158b8d857ee8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga493c8b24e44413338e7afc52aef8d2fd"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga493c8b24e44413338e7afc52aef8d2fd">pn_transport_set_context</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, void *context)</td></tr> +<tr class="separator:ga493c8b24e44413338e7afc52aef8d2fd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2dfb9c5a747cf45f2bb40fd1001cc54d"><td class="memItemLeft" align="right" valign="top">PN_EXTERN pn_record_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga2dfb9c5a747cf45f2bb40fd1001cc54d">pn_transport_attachments</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:ga2dfb9c5a747cf45f2bb40fd1001cc54d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa0e8f0ac87011ef42d91a215c94d8e7c"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gaa0e8f0ac87011ef42d91a215c94d8e7c">pn_transport_log</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, const char *message)</td></tr> +<tr class="separator:gaa0e8f0ac87011ef42d91a215c94d8e7c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga6475de6019c60e6d7f4f8f971c980162"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga6475de6019c60e6d7f4f8f971c980162">pn_transport_vlogf</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, const char *fmt, va_list ap)</td></tr> +<tr class="separator:ga6475de6019c60e6d7f4f8f971c980162"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga81f66ece6523ad3e6f0426b1dbb53e5e"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga81f66ece6523ad3e6f0426b1dbb53e5e">pn_transport_logf</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, const char *fmt,...)</td></tr> +<tr class="separator:ga81f66ece6523ad3e6f0426b1dbb53e5e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga36ff89334941ed67b98af731e5696844"><td class="memItemLeft" align="right" valign="top">PN_EXTERN uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga36ff89334941ed67b98af731e5696844">pn_transport_get_channel_max</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:ga36ff89334941ed67b98af731e5696844"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga470514642911834717ec0cd2a0cdab3f"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga470514642911834717ec0cd2a0cdab3f">pn_transport_set_channel_max</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, uint16_t channel_max)</td></tr> +<tr class="separator:ga470514642911834717ec0cd2a0cdab3f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0842d4831299a6aa87075620e8bba436"><td class="memItemLeft" align="right" valign="top">PN_EXTERN uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga0842d4831299a6aa87075620e8bba436">pn_transport_remote_channel_max</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:ga0842d4831299a6aa87075620e8bba436"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga93bb966654732ecdd07557dc3307a7e2"><td class="memItemLeft" align="right" valign="top">PN_EXTERN uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga93bb966654732ecdd07557dc3307a7e2">pn_transport_get_max_frame</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:ga93bb966654732ecdd07557dc3307a7e2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2974d2551737553bc953232f3bd6438c"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga2974d2551737553bc953232f3bd6438c">pn_transport_set_max_frame</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, uint32_t size)</td></tr> +<tr class="separator:ga2974d2551737553bc953232f3bd6438c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaeb38ead1b320bdb0572d819712fd84c5"><td class="memItemLeft" align="right" valign="top">PN_EXTERN uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gaeb38ead1b320bdb0572d819712fd84c5">pn_transport_get_remote_max_frame</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:gaeb38ead1b320bdb0572d819712fd84c5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2d650c473958ae118701d8aefd96aaa1"><td class="memItemLeft" align="right" valign="top">PN_EXTERN pn_millis_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga2d650c473958ae118701d8aefd96aaa1">pn_transport_get_idle_timeout</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:ga2d650c473958ae118701d8aefd96aaa1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gadd73956f25923eff0ca93784d943d349"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gadd73956f25923eff0ca93784d943d349">pn_transport_set_idle_timeout</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, pn_millis_t timeout)</td></tr> +<tr class="separator:gadd73956f25923eff0ca93784d943d349"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gabae92ce766617943d51fdab7504b867c"><td class="memItemLeft" align="right" valign="top">PN_EXTERN pn_millis_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gabae92ce766617943d51fdab7504b867c">pn_transport_get_remote_idle_timeout</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:gabae92ce766617943d51fdab7504b867c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga6e1cdd7040dbd032b9e31a2c5900a314"><td class="memItemLeft" align="right" valign="top">PN_EXTERN ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga6e1cdd7040dbd032b9e31a2c5900a314">pn_transport_input</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, const char *bytes, size_t available)</td></tr> +<tr class="separator:ga6e1cdd7040dbd032b9e31a2c5900a314"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3d1d51b1aea73388a8d4a11e49119817"><td class="memItemLeft" align="right" valign="top">PN_EXTERN ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga3d1d51b1aea73388a8d4a11e49119817">pn_transport_output</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, char *bytes, size_t size)</td></tr> +<tr class="separator:ga3d1d51b1aea73388a8d4a11e49119817"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0cdcc7fc4f5459687083dcb46796e0dd"><td class="memItemLeft" align="right" valign="top">PN_EXTERN ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga0cdcc7fc4f5459687083dcb46796e0dd">pn_transport_capacity</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:ga0cdcc7fc4f5459687083dcb46796e0dd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga51a02f24b448365039da44744f4e65a6"><td class="memItemLeft" align="right" valign="top">PN_EXTERN char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga51a02f24b448365039da44744f4e65a6">pn_transport_tail</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:ga51a02f24b448365039da44744f4e65a6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2d769e6c83f9f6f740648798c3d668ff"><td class="memItemLeft" align="right" valign="top">PN_EXTERN ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga2d769e6c83f9f6f740648798c3d668ff">pn_transport_push</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, const char *src, size_t size)</td></tr> +<tr class="separator:ga2d769e6c83f9f6f740648798c3d668ff"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa9a5bd5aef7c5dadbc67a236ad1b3447"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gaa9a5bd5aef7c5dadbc67a236ad1b3447">pn_transport_process</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, size_t size)</td></tr> +<tr class="separator:gaa9a5bd5aef7c5dadbc67a236ad1b3447"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaab1f8bacfea4934f0f9dae50488f6aac"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gaab1f8bacfea4934f0f9dae50488f6aac">pn_transport_close_tail</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:gaab1f8bacfea4934f0f9dae50488f6aac"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0fa738666a89b80dfbe381c2768b1d7f"><td class="memItemLeft" align="right" valign="top">PN_EXTERN ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga0fa738666a89b80dfbe381c2768b1d7f">pn_transport_pending</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:ga0fa738666a89b80dfbe381c2768b1d7f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac92129f1805ec946d5a792ae4a1b3327"><td class="memItemLeft" align="right" valign="top">PN_EXTERN const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gac92129f1805ec946d5a792ae4a1b3327">pn_transport_head</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:gac92129f1805ec946d5a792ae4a1b3327"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga10a9c4fc00faf70adedc76a941b1cfe9"><td class="memItemLeft" align="right" valign="top">PN_EXTERN ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga10a9c4fc00faf70adedc76a941b1cfe9">pn_transport_peek</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, char *dst, size_t size)</td></tr> +<tr class="separator:ga10a9c4fc00faf70adedc76a941b1cfe9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaeb3c887ab8b0cbf90a0f50dcb799debb"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gaeb3c887ab8b0cbf90a0f50dcb799debb">pn_transport_pop</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, size_t size)</td></tr> +<tr class="separator:gaeb3c887ab8b0cbf90a0f50dcb799debb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3aee76a664f84898b7a979075ac0e2b8"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga3aee76a664f84898b7a979075ac0e2b8">pn_transport_close_head</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:ga3aee76a664f84898b7a979075ac0e2b8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0a651e6b090ec7c3f86b1d5133372995"><td class="memItemLeft" align="right" valign="top">PN_EXTERN bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga0a651e6b090ec7c3f86b1d5133372995">pn_transport_quiesced</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:ga0a651e6b090ec7c3f86b1d5133372995"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga69b8c9a7dbdef76644711274b6f61987"><td class="memItemLeft" align="right" valign="top">PN_EXTERN bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga69b8c9a7dbdef76644711274b6f61987">pn_transport_closed</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:ga69b8c9a7dbdef76644711274b6f61987"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2be777fea1b19677ac50072c487d9ad1"><td class="memItemLeft" align="right" valign="top">PN_EXTERN pn_timestamp_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga2be777fea1b19677ac50072c487d9ad1">pn_transport_tick</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, pn_timestamp_t now)</td></tr> +<tr class="separator:ga2be777fea1b19677ac50072c487d9ad1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5ceae486fe78521728d05b9c4db7d5f7"><td class="memItemLeft" align="right" valign="top">PN_EXTERN uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga5ceae486fe78521728d05b9c4db7d5f7">pn_transport_get_frames_output</a> (const <a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:ga5ceae486fe78521728d05b9c4db7d5f7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad5614b4c311ab84a21213f60011a6840"><td class="memItemLeft" align="right" valign="top">PN_EXTERN uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gad5614b4c311ab84a21213f60011a6840">pn_transport_get_frames_input</a> (const <a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:gad5614b4c311ab84a21213f60011a6840"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2d2c338ec9d913391f1364bf3e701eae"><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__transport.html#ga2d2c338ec9d913391f1364bf3e701eae">pn_transport_connection</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="separator:ga2d2c338ec9d913391f1364bf3e701eae"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<h2 class="groupheader">Macro Definition Documentation</h2> +<a class="anchor" id="ga7065ad65f95c995a24e416edc95aead4"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define PN_TRACE_DRV   (4)</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Log driver related events, e.g. initialization, end of stream, etc. </p> + +</div> +</div> +<a class="anchor" id="ga3bde88d15fcfda400a36d8f9e5d51688"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define PN_TRACE_EVT   (8)</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Log events </p> + +</div> +</div> +<a class="anchor" id="gab8e04b4c128379ff27e6b801c0bce494"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define PN_TRACE_FRM   (2)</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Log frames into/out of the transport. </p> + +</div> +</div> +<a class="anchor" id="gae8f32e46e94953bab10bee530eee9044"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define PN_TRACE_OFF   (0)</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Turn logging off entirely. </p> + +</div> +</div> +<a class="anchor" id="gafde0eb3c73fb98816f4238d42d48f3d8"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define PN_TRACE_RAW   (1)</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Log raw binary data into/out of the transport. </p> + +</div> +</div> +<h2 class="groupheader">Typedef Documentation</h2> +<a class="anchor" id="ga4695788da8491f0c7104bfe36634ff94"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef int <a class="el" href="group__transport.html#ga4695788da8491f0c7104bfe36634ff94">pn_trace_t</a></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Holds the trace flags for an AMQP transport.</p> +<p>The trace flags for an AMQP transport control what sort of information is logged by an AMQP transport. The following bits can be set:</p> +<ul> +<li><a class="el" href="group__transport.html#gae8f32e46e94953bab10bee530eee9044">PN_TRACE_OFF</a></li> +<li><a class="el" href="group__transport.html#gafde0eb3c73fb98816f4238d42d48f3d8">PN_TRACE_RAW</a></li> +<li><a class="el" href="group__transport.html#gab8e04b4c128379ff27e6b801c0bce494">PN_TRACE_FRM</a></li> +<li><a class="el" href="group__transport.html#ga7065ad65f95c995a24e416edc95aead4">PN_TRACE_DRV</a></li> +<li><a class="el" href="group__transport.html#ga3bde88d15fcfda400a36d8f9e5d51688">PN_TRACE_EVT</a> </li> +</ul> + +</div> +</div> +<a class="anchor" id="ga3481dace48ff59d216127a63720038cd"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef void(* pn_tracer_t)(<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, const char *message)</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Callback for customizing logging behaviour. </p> + +</div> +</div> +<a class="anchor" id="gac26eda05f649bbf0399f3d8d78d12fa8"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef struct <a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> <a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a></td> + </tr> + </table> +</div><div class="memdoc"> +<p>An AMQP Transport object.</p> +<p>A pn_transport_t encapsulates the transport related state of all AMQP endpoint objects associated with a physical network connection at a given point in time. </p> + +</div> +</div> +<h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="gad75d8d99018bc22c2d23ef8e820e7a6d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a>* pn_transport </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Factory for creating a transport. A transport is used by a connection to interface with the network. There can only be one connection associated with a transport. See <a class="el" href="group__transport.html#gad07706c1e7db90d1b5d0ad6caf4c5892">pn_transport_bind()</a>.</p> +<p>Initially a transport is configured to be a client transport. Use <a class="el" href="group__transport.html#ga0f9cecc86a7185e6c9f25ead5c46b82b">pn_transport_set_server()</a> to configure the transport as a server transport.</p> +<p>A client transport initiates outgoing connections.</p> +<p>A client transport must be configured with the protocol layers to use and cannot configure itself automatically.</p> +<p>A server transport accepts incoming connections. It can automatically configure itself to include the various protocol layers depending on the incoming protocol headers.</p> +<dl class="section return"><dt>Returns</dt><dd>pointer to new transport </dd></dl> + +</div> +</div> +<a class="anchor" id="ga2dfb9c5a747cf45f2bb40fd1001cc54d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN pn_record_t* pn_transport_attachments </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the attachments that are associated with a transport object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>the transport whose attachments are to be returned. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the attachments for the transport object </dd></dl> + +</div> +</div> +<a class="anchor" id="gad07706c1e7db90d1b5d0ad6caf4c5892"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN int pn_transport_bind </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em>, </td> + </tr> + <tr> + <td class="paramkey"></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></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Binds the transport to an AMQP connection.</p> +<dl class="section return"><dt>Returns</dt><dd>an error code, or 0 on success </dd></dl> + +</div> +</div> +<a class="anchor" id="ga0cdcc7fc4f5459687083dcb46796e0dd"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN ssize_t pn_transport_capacity </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the amount of free space for input following the transport's tail pointer.</p> +<p>If the engine is in an exceptional state such as encountering an error condition or reaching the end of stream state, a negative value will be returned indicating the condition. If an error is indicated, futher details can be obtained from <a class="el" href="group__transport.html#ga00a271caac7d531ae795d78db81199e9">pn_transport_error</a>. Calls to <a class="el" href="group__transport.html#gaa9a5bd5aef7c5dadbc67a236ad1b3447">pn_transport_process</a> may alter the value of this pointer. See <a class="el" href="group__transport.html#gaa9a5bd5aef7c5dadbc67a236ad1b3447">pn_transport_process</a> for details.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>the transport </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the free space in the transport, PN_EOS or error code if < 0 </dd></dl> + +</div> +</div> +<a class="anchor" id="ga3aee76a664f84898b7a979075ac0e2b8"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN int pn_transport_close_head </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Indicate that the output has closed.</p> +<p>This tells the transport that no more output will be popped.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>the transport </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>0 on success, or error code if < 0 </dd></dl> + +</div> +</div> +<a class="anchor" id="gaab1f8bacfea4934f0f9dae50488f6aac"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN int pn_transport_close_tail </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Indicate that the input has reached End Of Stream (EOS).</p> +<p>This tells the transport that no more input will be forthcoming.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>the transport </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>0 on success, or error code if < 0 </dd></dl> + +</div> +</div> +<a class="anchor" id="ga69b8c9a7dbdef76644711274b6f61987"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN bool pn_transport_closed </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Check if a transport is closed.</p> +<p>A transport is defined to be closed when both the tail and the head are closed. In other words, when both <a class="el" href="group__transport.html#ga0cdcc7fc4f5459687083dcb46796e0dd">pn_transport_capacity()</a> < 0 and <a class="el" href="group__transport.html#ga0fa738666a89b80dfbe381c2768b1d7f">pn_transport_pending()</a> < 0.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>a transport object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>true if the transport is closed, false otherwise </dd></dl> + +</div> +</div> +<a class="anchor" id="ga2d0ad8e3e702ed47088789e33bf0c457"></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_transport_condition </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get additional information about the condition of the transport.</p> +<p>When a PN_TRANSPORT_ERROR event occurs, this operation can be used to access the details of the error condtion.</p> +<p>The pointer returned by this operation is valid until the transport object is freed.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>the transport object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the transport's condition object </dd></dl> + +</div> +</div> +<a class="anchor" id="ga2d2c338ec9d913391f1364bf3e701eae"></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_transport_connection </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Access the AMQP Connection associated with the transport.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>a transport object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the connection context for the transport, or NULL if none </dd></dl> + +</div> +</div> +<a class="anchor" id="ga00a271caac7d531ae795d78db81199e9"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN pn_error_t* pn_transport_error </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em></td><td>)</td> + <td></td> + </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> + +</div> +</div> +<a class="anchor" id="gaa1b0a748aad3cc35684ee095978dbd58"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_transport_free </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Free a transport object.</p> +<p>When a transport is freed, it is automatically unbound from its associated connection.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>a transport object or NULL </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ga36ff89334941ed67b98af731e5696844"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN uint16_t pn_transport_get_channel_max </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the maximum allowed channel for a transport. This will be the minimum of</p> +<ol type="1"> +<li>limit imposed by this proton implementation</li> +<li>limit imposed by remote peer</li> +<li>limit imposed by this application, using <a class="el" href="group__transport.html#ga470514642911834717ec0cd2a0cdab3f">pn_transport_set_channel_max()</a></li> +</ol> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>a transport object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the maximum allowed channel </dd></dl> + +</div> +</div> +<a class="anchor" id="ga9016acfea374d8b58183158b8d857ee8"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void* pn_transport_get_context </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the application context that is associated with a transport object.</p> +<p>The application context for a transport may be set using <a class="el" href="group__transport.html#ga493c8b24e44413338e7afc52aef8d2fd">pn_transport_set_context</a>.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>the transport whose context is to be returned. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the application context for the transport object </dd></dl> + +</div> +</div> +<a class="anchor" id="gad5614b4c311ab84a21213f60011a6840"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN uint64_t pn_transport_get_frames_input </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the number of frames input by a transport.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>a transport object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the number of frames input by the transport </dd></dl> + +</div> +</div> +<a class="anchor" id="ga5ceae486fe78521728d05b9c4db7d5f7"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN uint64_t pn_transport_get_frames_output </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the number of frames output by a transport.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>a transport object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the number of frames output by the transport </dd></dl> + +</div> +</div> +<a class="anchor" id="ga2d650c473958ae118701d8aefd96aaa1"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN pn_millis_t pn_transport_get_idle_timeout </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the idle timeout for a transport.</p> +<p>A zero idle timeout means heartbeats are disabled.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>a transport object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the transport's idle timeout </dd></dl> + +</div> +</div> +<a class="anchor" id="ga93bb966654732ecdd07557dc3307a7e2"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN uint32_t pn_transport_get_max_frame </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the maximum frame size of a transport.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>a transport object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the maximum frame size of the transport object </dd></dl> + +</div> +</div> +<a class="anchor" id="gabae92ce766617943d51fdab7504b867c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN pn_millis_t pn_transport_get_remote_idle_timeout </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the idle timeout for a transport's remote peer.</p> +<p>A zero idle timeout means heartbeats are disabled.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>a transport object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the idle timeout for the transport's remote peer </dd></dl> + +</div> +</div> +<a class="anchor" id="gaeb38ead1b320bdb0572d819712fd84c5"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN uint32_t pn_transport_get_remote_max_frame </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the maximum frame size of a transport's remote peer.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>a transport object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the maximum frame size of the transport's remote peer </dd></dl> + +</div> +</div> +<a class="anchor" id="ga99b48ee38d0bc21855eee158f8584aca"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__transport.html#ga3481dace48ff59d216127a63720038cd">pn_tracer_t</a> pn_transport_get_tracer </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the tracning function used by a transport.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>a transport object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the tracing function used by a transport </dd></dl> + +</div> +</div> +<a class="anchor" id="gafa71f9e73acbe139941b9ebe754b3241"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN const char* pn_transport_get_user </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Retrieve the authenticated user</p> +<p>This is usually used at the the server end to find the name of the authenticated user. On the client it will merely return whatever user was passed in to the <a class="el" href="group__connection.html#ga167a317ed0316c37e28a11e4e97d6a53">pn_connection_set_user()</a> API of the bound connection.</p> +<p>The returned value is only reliable after the PN_TRANSPORT_AUTHENTICATED event has been received.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>the transport</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>If a the user is anonymous (either no SASL layer is negotiated or the SASL ANONYMOUS mechanism is used) then the user will be "anonymous" Otherwise a string containing the user is returned. </dd></dl> + +</div> +</div> +<a class="anchor" id="gac92129f1805ec946d5a792ae4a1b3327"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN const char* pn_transport_head </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the transport's head pointer.</p> +<p>This pointer references queued output data. The <a class="el" href="group__transport.html#ga0fa738666a89b80dfbe381c2768b1d7f">pn_transport_pending</a> function reports how many bytes of output data follow this pointer. Calls to <a class="el" href="group__transport.html#gaeb3c887ab8b0cbf90a0f50dcb799debb">pn_transport_pop</a> may alter this pointer and any data it references. See <a class="el" href="group__transport.html#gaeb3c887ab8b0cbf90a0f50dcb799debb">pn_transport_pop</a> for details.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>the transport </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to the transport's output buffer, or NULL if no pending output. </dd></dl> + +</div> +</div> +<a class="anchor" id="ga6e1cdd7040dbd032b9e31a2c5900a314"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN ssize_t pn_transport_input </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>bytes</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>available</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#_deprecated000012">Deprecated:</a></b></dt><dd></dd></dl> + +</div> +</div> +<a class="anchor" id="gab35340b55e7a5cc6420ee8426c8e10ed"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN bool pn_transport_is_authenticated </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Tell whether the transport connection is authenticated</p> +<p>Note that this property may not be stable until the PN_CONNECTION_REMOTE_OPEN event is received.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>the transport </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>bool representing authentication </dd></dl> + +</div> +</div> +<a class="anchor" id="ga8e5deef63ba7b1483a6fadec65c1c3b5"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN bool pn_transport_is_encrypted </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Tell whether the transport connection is encrypted</p> +<p>Note that this property may not be stable until the PN_CONNECTION_REMOTE_OPEN event is received.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>the transport </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>bool representing encryption </dd></dl> + +</div> +</div> +<a class="anchor" id="gaa0e8f0ac87011ef42d91a215c94d8e7c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_transport_log </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>message</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Log a message using a transport's logging mechanism.</p> +<p>This can be useful in a debugging context as the log message will be prefixed with the transport's identifier.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>a transport object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">message</td><td>the message to be logged </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ga81f66ece6523ad3e6f0426b1dbb53e5e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_transport_logf </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>fmt</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>...</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Log a printf formatted message using a transport's logging mechanism.</p> +<p>This can be useful in a debugging context as the log message will be prefixed with the transport's identifier.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>a transport object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">fmt</td><td>the printf formatted message to be logged </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ga3d1d51b1aea73388a8d4a11e49119817"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN ssize_t pn_transport_output </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"><em>bytes</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>size</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#_deprecated000013">Deprecated:</a></b></dt><dd></dd></dl> + +</div> +</div> +<a class="anchor" id="ga10a9c4fc00faf70adedc76a941b1cfe9"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN ssize_t pn_transport_peek </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"><em>dst</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>size</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Copies <code>size</code> bytes from the head of the transport to the <code>dst</code> pointer.</p> +<p>It is an error to call this with a value of <code>size</code> that is greater than the value reported by <a class="el" href="group__transport.html#ga0fa738666a89b80dfbe381c2768b1d7f">pn_transport_pending</a>.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>the transport </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">dst</td><td>the destination buffer </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>the capacity of the destination buffer </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>number of bytes copied on success, or error code if < 0 </dd></dl> + +</div> +</div> +<a class="anchor" id="ga0fa738666a89b80dfbe381c2768b1d7f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN ssize_t pn_transport_pending </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the number of pending output bytes following the transport's head pointer.</p> +<p>If the engine is in an exceptional state such as encountering an error condition or reaching the end of stream state, a negative value will be returned indicating the condition. If an error is indicated, further details can be obtained from <a class="el" href="group__transport.html#ga00a271caac7d531ae795d78db81199e9">pn_transport_error</a>. Calls to <a class="el" href="group__transport.html#gaeb3c887ab8b0cbf90a0f50dcb799debb">pn_transport_pop</a> may alter the value of this pointer. See <a class="el" href="group__transport.html#gaeb3c887ab8b0cbf90a0f50dcb799debb">pn_transport_pop</a> for details.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>the transport </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the number of pending output bytes, or an error code </dd></dl> + +</div> +</div> +<a class="anchor" id="gaeb3c887ab8b0cbf90a0f50dcb799debb"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_transport_pop </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>size</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Removes <code>size</code> bytes of output from the pending output queue following the transport's head pointer.</p> +<p>Calls to this function may alter the transport's head pointer as well as the number of pending bytes reported by <a class="el" href="group__transport.html#ga0fa738666a89b80dfbe381c2768b1d7f">pn_transport_pending</a>.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>the transport </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>the number of bytes to remove </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="gaa9a5bd5aef7c5dadbc67a236ad1b3447"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN int pn_transport_process </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>size</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Process input data following the tail pointer.</p> +<p>Calling this function will cause the transport to consume <code>size</code> bytes of input occupying the free space following the tail pointer. Calls to this function may change the value of <a class="el" href="group__transport.html#ga51a02f24b448365039da44744f4e65a6">pn_transport_tail</a>, as well as the amount of free space reported by <a class="el" href="group__transport.html#ga0cdcc7fc4f5459687083dcb46796e0dd">pn_transport_capacity</a>.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>the transport </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>the amount of data written to the transport's input buffer </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>0 on success, or error code if < 0 </dd></dl> + +</div> +</div> +<a class="anchor" id="ga2d769e6c83f9f6f740648798c3d668ff"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN ssize_t pn_transport_push </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>src</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>size</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Pushes the supplied bytes into the tail of the transport.</p> +<p>This is equivalent to copying <code>size</code> bytes afther the tail pointer and then calling <a class="el" href="group__transport.html#gaa9a5bd5aef7c5dadbc67a236ad1b3447">pn_transport_process</a> with an argument of <code>size</code>. Only some of the bytes will be copied if there is insufficienty capacity available. Use <a class="el" href="group__transport.html#ga0cdcc7fc4f5459687083dcb46796e0dd">pn_transport_capacity</a> to determine how much capacity the transport has.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>the transport </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>the start of the data to push into the transport </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>the amount of data to push into the transport</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the number of bytes pushed on success, or error code if < 0 </dd></dl> + +</div> +</div> +<a class="anchor" id="ga0a651e6b090ec7c3f86b1d5133372995"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN bool pn_transport_quiesced </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Check if a transport has buffered data.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>a transport object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>true if the transport has buffered data, false otherwise </dd></dl> + +</div> +</div> +<a class="anchor" id="ga0842d4831299a6aa87075620e8bba436"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN uint16_t pn_transport_remote_channel_max </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the maximum allowed channel of a transport's remote peer.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>a transport object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the maximum allowed channel of the transport's remote peer </dd></dl> + +</div> +</div> +<a class="anchor" id="gafc2157ad11690d0b0679aa34db1a1d5a"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_transport_require_auth </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>required</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Set whether a non authenticated transport connection is allowed</p> +<p>There are several ways within the AMQP protocol suite to get unauthenticated connections:</p> +<ul> +<li>Use no SASL layer (with either no TLS or TLS without client certificates)</li> +<li>Use an SASL layer but the ANONYMOUS mechanism</li> +</ul> +<p>The default if this option is not set is to allow unauthenticated connections.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>the transport </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">required</td><td>boolean is true when authenticated connections are required </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="gadfc4a4be3de102890cc5c0ee4c1d8481"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_transport_require_encryption </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>required</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Set whether a non encrypted transport connection is allowed</p> +<p>There are several ways within the AMQP protocol suite to get encrypted connections:</p> +<ul> +<li>Use TLS/SSL</li> +<li>Use an SASL with a mechanism that supports saecurity layers</li> +</ul> +<p>The default if this option is not set is to allow unencrypted connections.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>the transport </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">required</td><td>boolean is true when encrypted connections are required </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ga470514642911834717ec0cd2a0cdab3f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN int pn_transport_set_channel_max </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint16_t </td> + <td class="paramname"><em>channel_max</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Set the maximum allowed channel number for a transport. Note that this is the maximum channel number allowed, giving a valid channel number range of [0..channel_max]. Therefore the maximum number of simultaineously active channels will be channel_max plus 1. You can call this function more than once to raise and lower the limit your application imposes on max channels for this transport. However, smaller limits may be imposed by this library, or by the remote peer. After the OPEN frame has been sent to the remote peer, further calls to this function will have no effect.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>a transport object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">channel_max</td><td>the maximum allowed channel </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>PN_OK, or PN_STATE_ERR if it is too late to change channel_max </dd></dl> + +</div> +</div> +<a class="anchor" id="ga493c8b24e44413338e7afc52aef8d2fd"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_transport_set_context </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</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>Set a new application context for a transport object.</dd></dl> +<p>The application context for a transport object may be retrieved using <a class="el" href="group__transport.html#ga9016acfea374d8b58183158b8d857ee8">pn_transport_get_context</a>.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>the transport 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="gadd73956f25923eff0ca93784d943d349"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_transport_set_idle_timeout </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> +
<TRUNCATED> --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org
