http://git-wip-us.apache.org/repos/asf/qpid-site/blob/de3c3488/content/releases/qpid-proton-0.15.0/proton/c/api/group__connection.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-0.15.0/proton/c/api/group__connection.html b/content/releases/qpid-proton-0.15.0/proton/c/api/group__connection.html new file mode 100755 index 0000000..e1579be --- /dev/null +++ b/content/releases/qpid-proton-0.15.0/proton/c/api/group__connection.html @@ -0,0 +1,1147 @@ +<!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: Connection</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__connection.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">Connection<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__condition"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__condition.html">Condition</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:gac83dd8123b992813be86fe0f7eaf8f61"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#gac83dd8123b992813be86fe0f7eaf8f61">PN_LOCAL_UNINIT</a>   (1)</td></tr> +<tr class="separator:gac83dd8123b992813be86fe0f7eaf8f61"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0c3bf54f0991944a2f6eea36b561fa2b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#ga0c3bf54f0991944a2f6eea36b561fa2b">PN_LOCAL_ACTIVE</a>   (2)</td></tr> +<tr class="separator:ga0c3bf54f0991944a2f6eea36b561fa2b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga602c2c870ebed1d9bfe100876909225b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#ga602c2c870ebed1d9bfe100876909225b">PN_LOCAL_CLOSED</a>   (4)</td></tr> +<tr class="separator:ga602c2c870ebed1d9bfe100876909225b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga4c35fcb0aacd254d586df8594ee770d3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#ga4c35fcb0aacd254d586df8594ee770d3">PN_REMOTE_UNINIT</a>   (8)</td></tr> +<tr class="separator:ga4c35fcb0aacd254d586df8594ee770d3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad96220f2886c21a4f2eebc9487f53a87"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#gad96220f2886c21a4f2eebc9487f53a87">PN_REMOTE_ACTIVE</a>   (16)</td></tr> +<tr class="separator:gad96220f2886c21a4f2eebc9487f53a87"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga764c602a20457f9aa8862825b6d13a8d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#ga764c602a20457f9aa8862825b6d13a8d">PN_REMOTE_CLOSED</a>   (32)</td></tr> +<tr class="separator:ga764c602a20457f9aa8862825b6d13a8d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga32329c4bb3e23607a243cd8100c01264"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#ga32329c4bb3e23607a243cd8100c01264">PN_LOCAL_MASK</a>   (<a class="el" href="group__connection.html#gac83dd8123b992813be86fe0f7eaf8f61">PN_LOCAL_UNINIT</a> | <a class="el" href="group__connection.html#ga0c3bf54f0991944a2f6eea36b561fa2b">PN_LOCAL_ACTIVE</a> | <a class="el" href="group__connection.html#ga602c2c870ebed1d9bfe100876909225b">PN_LOCAL_CLOSED</a>)</td></tr> +<tr class="separator:ga32329c4bb3e23607a243cd8100c01264"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga695af0c2d90d50f4baf403ea60710fa3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#ga695af0c2d90d50f4baf403ea60710fa3">PN_REMOTE_MASK</a>   (<a class="el" href="group__connection.html#ga4c35fcb0aacd254d586df8594ee770d3">PN_REMOTE_UNINIT</a> | <a class="el" href="group__connection.html#gad96220f2886c21a4f2eebc9487f53a87">PN_REMOTE_ACTIVE</a> | <a class="el" href="group__connection.html#ga764c602a20457f9aa8862825b6d13a8d">PN_REMOTE_CLOSED</a>)</td></tr> +<tr class="separator:ga695af0c2d90d50f4baf403ea60710fa3"><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:gaa83193a655e32bffc18624acc2c39233"><td class="memItemLeft" align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">pn_state_t</a></td></tr> +<tr class="separator:gaa83193a655e32bffc18624acc2c39233"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga886351d81ff3a977a284a206526c5aff"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a></td></tr> +<tr class="separator:ga886351d81ff3a977a284a206526c5aff"><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:ga7ad02932efd7fd54938813852f7b61dc"><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__connection.html#ga7ad02932efd7fd54938813852f7b61dc">pn_connection</a> (void)</td></tr> +<tr class="separator:ga7ad02932efd7fd54938813852f7b61dc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga94b0ff0015b3d2c2325fb24cc0e65bf2"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#ga94b0ff0015b3d2c2325fb24cc0e65bf2">pn_connection_free</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="separator:ga94b0ff0015b3d2c2325fb24cc0e65bf2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa373c1fb55103e273944f49cc8b0edf5"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#gaa373c1fb55103e273944f49cc8b0edf5">pn_connection_release</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="separator:gaa373c1fb55103e273944f49cc8b0edf5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga6ee261d6544bd80c8db1c00861e6847b"><td class="memItemLeft" align="right" valign="top">PN_EXTERN pn_error_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#ga6ee261d6544bd80c8db1c00861e6847b">pn_connection_error</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="separator:ga6ee261d6544bd80c8db1c00861e6847b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7943e7721ab30776cb79d4799d628164"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#ga7943e7721ab30776cb79d4799d628164">pn_connection_collect</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection, <a class="el" href="group__event.html#ga905cdecedb8020bc28e648e43348b5d1">pn_collector_t</a> *collector)</td></tr> +<tr class="separator:ga7943e7721ab30776cb79d4799d628164"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf304c011df5e00160f49297ba172149c"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#gaf304c011df5e00160f49297ba172149c">pn_connection_get_context</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="separator:gaf304c011df5e00160f49297ba172149c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3f6cdab1871250511beef56402a4f7f7"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#ga3f6cdab1871250511beef56402a4f7f7">pn_connection_set_context</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection, void *context)</td></tr> +<tr class="separator:ga3f6cdab1871250511beef56402a4f7f7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8510314b8226658d14ee20253bde5853"><td class="memItemLeft" align="right" valign="top">PN_EXTERN pn_record_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#ga8510314b8226658d14ee20253bde5853">pn_connection_attachments</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="separator:ga8510314b8226658d14ee20253bde5853"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab2f0a1503fa22e705dcad9056054a18a"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">pn_state_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#gab2f0a1503fa22e705dcad9056054a18a">pn_connection_state</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="separator:gab2f0a1503fa22e705dcad9056054a18a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7458674f4779b1e863494a991c923c0e"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#ga7458674f4779b1e863494a991c923c0e">pn_connection_open</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="separator:ga7458674f4779b1e863494a991c923c0e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gacc8f6e4fd7c886c084212852918bd8cf"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#gacc8f6e4fd7c886c084212852918bd8cf">pn_connection_close</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="separator:gacc8f6e4fd7c886c084212852918bd8cf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5da6d9f55883af5f996d45828a7034a7"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#ga5da6d9f55883af5f996d45828a7034a7">pn_connection_reset</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="separator:ga5da6d9f55883af5f996d45828a7034a7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf9b7a7f1b127151a1cb35dcb86bcbe6d"><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__connection.html#gaf9b7a7f1b127151a1cb35dcb86bcbe6d">pn_connection_condition</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="separator:gaf9b7a7f1b127151a1cb35dcb86bcbe6d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga6a8f4087f792e701e01a572b8ac84dd0"><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__connection.html#ga6a8f4087f792e701e01a572b8ac84dd0">pn_connection_remote_condition</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="separator:ga6a8f4087f792e701e01a572b8ac84dd0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga1ae9f5d1b693ed734384241100564c60"><td class="memItemLeft" align="right" valign="top">PN_EXTERN const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#ga1ae9f5d1b693ed734384241100564c60">pn_connection_get_container</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="separator:ga1ae9f5d1b693ed734384241100564c60"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga26407d58547c672d64858e07375e0965"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#ga26407d58547c672d64858e07375e0965">pn_connection_set_container</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection, const char *container)</td></tr> +<tr class="separator:ga26407d58547c672d64858e07375e0965"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga167a317ed0316c37e28a11e4e97d6a53"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#ga167a317ed0316c37e28a11e4e97d6a53">pn_connection_set_user</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection, const char *user)</td></tr> +<tr class="separator:ga167a317ed0316c37e28a11e4e97d6a53"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gacaaee6956135f36d9bd6ef4d9f300a2c"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#gacaaee6956135f36d9bd6ef4d9f300a2c">pn_connection_set_password</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection, const char *password)</td></tr> +<tr class="separator:gacaaee6956135f36d9bd6ef4d9f300a2c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaeb5426c33775c4d668d1653426e65d95"><td class="memItemLeft" align="right" valign="top">PN_EXTERN const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#gaeb5426c33775c4d668d1653426e65d95">pn_connection_get_user</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="separator:gaeb5426c33775c4d668d1653426e65d95"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac1df3c6f6d31bbc1a0e0e7e4ffb1b4fa"><td class="memItemLeft" align="right" valign="top">PN_EXTERN const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#gac1df3c6f6d31bbc1a0e0e7e4ffb1b4fa">pn_connection_get_hostname</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="separator:gac1df3c6f6d31bbc1a0e0e7e4ffb1b4fa"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga204a7c356658d414f5d08da4f25f5d9e"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#ga204a7c356658d414f5d08da4f25f5d9e">pn_connection_set_hostname</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection, const char *hostname)</td></tr> +<tr class="separator:ga204a7c356658d414f5d08da4f25f5d9e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga466d510620741123b4e9ba723c039f0c"><td class="memItemLeft" align="right" valign="top">PN_EXTERN const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#ga466d510620741123b4e9ba723c039f0c">pn_connection_remote_container</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="separator:ga466d510620741123b4e9ba723c039f0c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2d78f4bf7484fa8a44bb7fd64b7a75e8"><td class="memItemLeft" align="right" valign="top">PN_EXTERN const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#ga2d78f4bf7484fa8a44bb7fd64b7a75e8">pn_connection_remote_hostname</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="separator:ga2d78f4bf7484fa8a44bb7fd64b7a75e8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8b7a3914155561305f814d12422c874a"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#ga8b7a3914155561305f814d12422c874a">pn_connection_offered_capabilities</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="separator:ga8b7a3914155561305f814d12422c874a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga608fc121ce149f534bac640b119d2230"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#ga608fc121ce149f534bac640b119d2230">pn_connection_desired_capabilities</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="separator:ga608fc121ce149f534bac640b119d2230"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab8700c359187ecb9451acf43c78c5486"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#gab8700c359187ecb9451acf43c78c5486">pn_connection_properties</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="separator:gab8700c359187ecb9451acf43c78c5486"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9d3578b047e3f0118c0fd5e106f58579"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#ga9d3578b047e3f0118c0fd5e106f58579">pn_connection_remote_offered_capabilities</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="separator:ga9d3578b047e3f0118c0fd5e106f58579"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga57a496ea0893c5920a7ace900e033a74"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#ga57a496ea0893c5920a7ace900e033a74">pn_connection_remote_desired_capabilities</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="separator:ga57a496ea0893c5920a7ace900e033a74"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga98cc1795b88c340ee0d3aab3b8db0abf"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection.html#ga98cc1795b88c340ee0d3aab3b8db0abf">pn_connection_remote_properties</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="separator:ga98cc1795b88c340ee0d3aab3b8db0abf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9181af243a5958309ad90bf8460634ae"><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__connection.html#ga9181af243a5958309ad90bf8460634ae">pn_connection_transport</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="separator:ga9181af243a5958309ad90bf8460634ae"><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="ga0c3bf54f0991944a2f6eea36b561fa2b"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define PN_LOCAL_ACTIVE   (2)</td> + </tr> + </table> +</div><div class="memdoc"> +<p>The local <a class="el" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">endpoint state </a> is active. </p> + +</div> +</div> +<a class="anchor" id="ga602c2c870ebed1d9bfe100876909225b"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define PN_LOCAL_CLOSED   (4)</td> + </tr> + </table> +</div><div class="memdoc"> +<p>The local <a class="el" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">endpoint state </a> is closed. </p> + +</div> +</div> +<a class="anchor" id="ga32329c4bb3e23607a243cd8100c01264"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define PN_LOCAL_MASK   (<a class="el" href="group__connection.html#gac83dd8123b992813be86fe0f7eaf8f61">PN_LOCAL_UNINIT</a> | <a class="el" href="group__connection.html#ga0c3bf54f0991944a2f6eea36b561fa2b">PN_LOCAL_ACTIVE</a> | <a class="el" href="group__connection.html#ga602c2c870ebed1d9bfe100876909225b">PN_LOCAL_CLOSED</a>)</td> + </tr> + </table> +</div><div class="memdoc"> +<p>A mask for values of <a class="el" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">pn_state_t</a> that preserves only the local bits of an endpoint's state. </p> + +</div> +</div> +<a class="anchor" id="gac83dd8123b992813be86fe0f7eaf8f61"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define PN_LOCAL_UNINIT   (1)</td> + </tr> + </table> +</div><div class="memdoc"> +<p>The local <a class="el" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">endpoint state </a> is uninitialized. </p> + +</div> +</div> +<a class="anchor" id="gad96220f2886c21a4f2eebc9487f53a87"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define PN_REMOTE_ACTIVE   (16)</td> + </tr> + </table> +</div><div class="memdoc"> +<p>The remote <a class="el" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">endpoint state </a> is active. </p> + +</div> +</div> +<a class="anchor" id="ga764c602a20457f9aa8862825b6d13a8d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define PN_REMOTE_CLOSED   (32)</td> + </tr> + </table> +</div><div class="memdoc"> +<p>The remote <a class="el" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">endpoint state </a> is closed. </p> + +</div> +</div> +<a class="anchor" id="ga695af0c2d90d50f4baf403ea60710fa3"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define PN_REMOTE_MASK   (<a class="el" href="group__connection.html#ga4c35fcb0aacd254d586df8594ee770d3">PN_REMOTE_UNINIT</a> | <a class="el" href="group__connection.html#gad96220f2886c21a4f2eebc9487f53a87">PN_REMOTE_ACTIVE</a> | <a class="el" href="group__connection.html#ga764c602a20457f9aa8862825b6d13a8d">PN_REMOTE_CLOSED</a>)</td> + </tr> + </table> +</div><div class="memdoc"> +<p>A mask for values of <a class="el" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">pn_state_t</a> that preserves only the remote bits of an endpoint's state. </p> + +</div> +</div> +<a class="anchor" id="ga4c35fcb0aacd254d586df8594ee770d3"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define PN_REMOTE_UNINIT   (8)</td> + </tr> + </table> +</div><div class="memdoc"> +<p>The remote <a class="el" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">endpoint state </a> is uninitialized. </p> + +</div> +</div> +<h2 class="groupheader">Typedef Documentation</h2> +<a class="anchor" id="ga886351d81ff3a977a284a206526c5aff"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef struct <a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> <a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a></td> + </tr> + </table> +</div><div class="memdoc"> +<p>An AMQP Connection object.</p> +<p>A pn_connection_t object encapsulates all of the endpoint state associated with an AMQP Connection. A pn_connection_t object contains zero or more <a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> objects, which in turn contain zero or more <a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> objects. Each <a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> object contains an ordered sequence of <a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> objects. A link is either a <a class="el" href="group__sender.html">Sender </a>, or a <a class="el" href="group__receiver.html">Receiver </a>, but never both. </p> + +</div> +</div> +<a class="anchor" id="gaa83193a655e32bffc18624acc2c39233"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef int <a class="el" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">pn_state_t</a></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Holds the state flags for an AMQP endpoint.</p> +<p>A pn_state_t is an integral value with flags that encode both the local and remote state of an AMQP Endpoint (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">Connection </a>, <a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">Session </a>, or <a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">Link </a>). The local portion of the state may be accessed using <a class="el" href="group__connection.html#ga32329c4bb3e23607a243cd8100c01264">PN_LOCAL_MASK</a>, and the remote portion may be accessed using <a class="el" href="group__connection.html#ga695af0c2d90d50f4baf403ea60710fa3">PN_REMOTE_MASK</a>. Individual bits may be accessed using <a class="el" href="group__connection.html#gac83dd8123b992813be86fe0f7eaf8f61">PN_LOCAL_UNINIT</a>, <a class="el" href="group__connection.html#ga0c3bf54f0991944a2f6eea36b561fa2b">PN_LOCAL_ACTIVE</a>, <a class="el" href="group__connection.html#ga602c2c870ebed1d9bfe100876909225b ">PN_LOCAL_CLOSED</a>, and <a class="el" href="group__connection.html#ga4c35fcb0aacd254d586df8594ee770d3">PN_REMOTE_UNINIT</a>, <a class="el" href="group__connection.html#gad96220f2886c21a4f2eebc9487f53a87">PN_REMOTE_ACTIVE</a>, <a class="el" href="group__connection.html#ga764c602a20457f9aa8862825b6d13a8d">PN_REMOTE_CLOSED</a>.</p> +<p>Every AMQP endpoint (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">Connection </a>, <a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">Session </a>, or <a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">Link </a>) starts out in an uninitialized state and then proceeds linearly to an active and then closed state. This lifecycle occurs at both endpoints involved, and so the state model for an endpoint includes not only the known local state, but also the last known state of the remote endpoint. </p> + +</div> +</div> +<h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="ga7ad02932efd7fd54938813852f7b61dc"></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_connection </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Factory to construct a new Connection.</p> +<dl class="section return"><dt>Returns</dt><dd>pointer to a new connection object. </dd></dl> + +</div> +</div> +<a class="anchor" id="ga8510314b8226658d14ee20253bde5853"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN pn_record_t* pn_connection_attachments </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the attachments that are associated with a connection object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection whose attachments are to be returned. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the attachments for the connection object </dd></dl> + +</div> +</div> +<a class="anchor" id="gacc8f6e4fd7c886c084212852918bd8cf"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_connection_close </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Close a connection.</p> +<p>Once this operation has completed, the PN_LOCAL_CLOSED state flag will be set. This may be called without calling <a class="el" href="group__connection.html#ga7458674f4779b1e863494a991c923c0e">pn_connection_open</a>, in this case it is equivalent to calling <a class="el" href="group__connection.html#ga7458674f4779b1e863494a991c923c0e">pn_connection_open</a> followed by <a class="el" href="group__connection.html#gacc8f6e4fd7c886c084212852918bd8cf">pn_connection_close</a>.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>a connection object </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ga7943e7721ab30776cb79d4799d628164"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_connection_collect </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__event.html#ga905cdecedb8020bc28e648e43348b5d1">pn_collector_t</a> * </td> + <td class="paramname"><em>collector</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Associate a connection object with an event collector.</p> +<p>By associating a connection object with an event collector, key changes in endpoint state are reported to the collector via <a class="el" href="group__event.html#ga87f3028b4888632bbd56fb71ac737ae8">pn_event_t</a> objects that can be inspected and processed. See <a class="el" href="group__event.html#ga87f3028b4888632bbd56fb71ac737ae8">pn_event_t</a> for more details on the kinds of events.</p> +<p>Note that by registering a collector, the user is requesting that an indefinite number of events be queued up on his behalf. This means that unless the application eventually processes these events, the storage requirements for keeping them will grow without bound. In other words, don't register a collector with a connection if you never intend to process any of the events.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">collector</td><td>the event collector </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="gaf9b7a7f1b127151a1cb35dcb86bcbe6d"></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_connection_condition </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the local condition associated with the connection endpoint.</p> +<p>The <a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> object retrieved may be modified prior to closing the connection in order to indicate a particular condition exists when the connection closes. This is normally used to communicate error conditions to the remote peer, however it may also be used in non error cases such as redirects. See <a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> for more details.</p> +<p>The pointer returned by this operation is valid until the connection object is freed.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the connection's local condition object </dd></dl> + +</div> +</div> +<a class="anchor" id="ga608fc121ce149f534bac640b119d2230"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a>* pn_connection_desired_capabilities </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Access/modify the AMQP desired capabilities data for a connection object.</p> +<p>This operation will return a pointer to a <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> object that is valid until the connection object is freed. Any data contained by the <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> object will be sent as the desired capabilites for the parent connection object. Note that this MUST take the form of an array of symbols to be valid.</p> +<p>The <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> pointer returned is valid until the connection object is freed.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to a pn_data_t representing the desired capabilities </dd></dl> + +</div> +</div> +<a class="anchor" id="ga6ee261d6544bd80c8db1c00861e6847b"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN pn_error_t* pn_connection_error </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get additional error information associated with the connection.</p> +<p>Whenever a connection operation fails (i.e. returns an error code), additional error details can be obtained using this function. The error object that is returned may also be used to clear the error condition.</p> +<p>The pointer returned by this operation is valid until the connection object is freed.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the connection's error object </dd></dl> + +</div> +</div> +<a class="anchor" id="ga94b0ff0015b3d2c2325fb24cc0e65bf2"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_connection_free </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Free a connection object.</p> +<p>When a connection object is freed, all <a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a>, <a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a>, and <a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> objects associated with the connection are also freed.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection object to free (or NULL) </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ga1ae9f5d1b693ed734384241100564c60"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN const char* pn_connection_get_container </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the AMQP Container name advertised by a connection object.</p> +<p>The pointer returned by this operation is valid until <a class="el" href="group__connection.html#ga26407d58547c672d64858e07375e0965">pn_connection_set_container</a> is called, or until the connection object is freed, whichever happens sooner.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to the container name </dd></dl> + +</div> +</div> +<a class="anchor" id="gaf304c011df5e00160f49297ba172149c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void* pn_connection_get_context </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd>Get the application context that is associated with a connection object.</dd></dl> +<p>The application context for a connection may be set using <a class="el" href="group__connection.html#ga3f6cdab1871250511beef56402a4f7f7">pn_connection_set_context</a>.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection whose context is to be returned. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the application context for the connection object </dd></dl> + +</div> +</div> +<a class="anchor" id="gac1df3c6f6d31bbc1a0e0e7e4ffb1b4fa"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN const char* pn_connection_get_hostname </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the value of the AMQP Hostname used by a connection object.</p> +<p>The pointer returned by this operation is valid until <a class="el" href="group__connection.html#ga204a7c356658d414f5d08da4f25f5d9e">pn_connection_set_hostname</a> is called, or until the connection object is freed, whichever happens sooner.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to the hostname </dd></dl> + +</div> +</div> +<a class="anchor" id="gaeb5426c33775c4d668d1653426e65d95"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN const char* pn_connection_get_user </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the authentication username for a client connection</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the username passed into the connection </dd></dl> + +</div> +</div> +<a class="anchor" id="ga8b7a3914155561305f814d12422c874a"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a>* pn_connection_offered_capabilities </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Access/modify the AMQP offered capabilities data for a connection object.</p> +<p>This operation will return a pointer to a <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> object that is valid until the connection object is freed. Any data contained by the <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> object will be sent as the offered capabilites for the parent connection object. Note that this MUST take the form of an array of symbols to be valid.</p> +<p>The <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> pointer returned is valid until the connection object is freed.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to a pn_data_t representing the offered capabilities </dd></dl> + +</div> +</div> +<a class="anchor" id="ga7458674f4779b1e863494a991c923c0e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_connection_open </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Open a connection.</p> +<p>Once this operation has completed, the PN_LOCAL_ACTIVE state flag will be set.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>a connection object </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="gab8700c359187ecb9451acf43c78c5486"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a>* pn_connection_properties </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Access/modify the AMQP properties data for a connection object.</p> +<p>This operation will return a pointer to a <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> object that is valid until the connection object is freed. Any data contained by the <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> object will be sent as the AMQP properties for the parent connection object. Note that this MUST take the form of a symbol keyed map to be valid.</p> +<p>The <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> pointer returned is valid until the connection object is freed.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to a pn_data_t representing the connection properties </dd></dl> + +</div> +</div> +<a class="anchor" id="gaa373c1fb55103e273944f49cc8b0edf5"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_connection_release </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Release a connection object.</p> +<p>When a connection object is released, all <a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> and <a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a>, objects associated with the connection are also released and all <a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> objects are settled.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection object to be released </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ga6a8f4087f792e701e01a572b8ac84dd0"></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_connection_remote_condition </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the remote condition associated with the connection endpoint.</p> +<p>The <a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> object retrieved may be examined in order to determine whether the remote peer was indicating some sort of exceptional condition when the remote connection endpoint was closed. The <a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> object returned may not be modified.</p> +<p>The pointer returned by this operation is valid until the connection object is freed.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the connection's remote condition object </dd></dl> + +</div> +</div> +<a class="anchor" id="ga466d510620741123b4e9ba723c039f0c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN const char* pn_connection_remote_container </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the AMQP Container name advertised by the remote connection endpoint.</p> +<p>This will return NULL until the <a class="el" href="group__connection.html#gad96220f2886c21a4f2eebc9487f53a87">PN_REMOTE_ACTIVE</a> state is reached. See <a class="el" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">pn_state_t</a> for more details on endpoint state.</p> +<p>Any non null pointer returned by this operation will be valid until the connection object is unbound from a transport or freed, whichever happens sooner.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to the remote container name </dd></dl> + +</div> +</div> +<a class="anchor" id="ga57a496ea0893c5920a7ace900e033a74"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a>* pn_connection_remote_desired_capabilities </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Access the AMQP desired capabilites supplied by the remote connection endpoint.</p> +<p>This operation will return a pointer to a <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> object that is valid until the connection object is freed. This data object will be empty until the remote connection is opened as indicated by the <a class="el" href="group__connection.html#gad96220f2886c21a4f2eebc9487f53a87">PN_REMOTE_ACTIVE</a> flag.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the remote desired capabilities </dd></dl> + +</div> +</div> +<a class="anchor" id="ga2d78f4bf7484fa8a44bb7fd64b7a75e8"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN const char* pn_connection_remote_hostname </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the AMQP Hostname set by the remote connection endpoint.</p> +<p>This will return NULL until the <a class="el" href="group__connection.html#gad96220f2886c21a4f2eebc9487f53a87">PN_REMOTE_ACTIVE</a> state is reached. See <a class="el" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">pn_state_t</a> for more details on endpoint state.</p> +<p>Any non null pointer returned by this operation will be valid until the connection object is unbound from a transport or freed, whichever happens sooner.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to the remote hostname </dd></dl> + +</div> +</div> +<a class="anchor" id="ga9d3578b047e3f0118c0fd5e106f58579"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a>* pn_connection_remote_offered_capabilities </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Access the AMQP offered capabilites supplied by the remote connection endpoint.</p> +<p>This operation will return a pointer to a <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> object that is valid until the connection object is freed. This data object will be empty until the remote connection is opened as indicated by the <a class="el" href="group__connection.html#gad96220f2886c21a4f2eebc9487f53a87">PN_REMOTE_ACTIVE</a> flag.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the remote offered capabilities </dd></dl> + +</div> +</div> +<a class="anchor" id="ga98cc1795b88c340ee0d3aab3b8db0abf"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a>* pn_connection_remote_properties </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Access the AMQP connection properties supplied by the remote connection endpoint.</p> +<p>This operation will return a pointer to a <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> object that is valid until the connection object is freed. This data object will be empty until the remote connection is opened as indicated by the <a class="el" href="group__connection.html#gad96220f2886c21a4f2eebc9487f53a87">PN_REMOTE_ACTIVE</a> flag.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the remote connection properties </dd></dl> + +</div> +</div> +<a class="anchor" id="ga5da6d9f55883af5f996d45828a7034a7"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_connection_reset </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Reset a connection object back to the uninitialized state.</p> +<p>Note that this does <em>not</em> remove any contained <a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a>, <a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a>, and <a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> objects.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>a connection object </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ga26407d58547c672d64858e07375e0965"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_connection_set_container </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>container</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Set the AMQP Container name advertised by a connection object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">container</td><td>the container name </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ga3f6cdab1871250511beef56402a4f7f7"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_connection_set_context </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">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#_deprecated000002">Deprecated:</a></b></dt><dd>Set a new application context for a connection object.</dd></dl> +<p>The application context for a connection object may be retrieved using <a class="el" href="group__connection.html#gaf304c011df5e00160f49297ba172149c">pn_connection_get_context</a>.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection object </td></tr> + <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="ga204a7c356658d414f5d08da4f25f5d9e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_connection_set_hostname </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>hostname</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Set the name of the virtual host (either fully qualified or relative) to which this connection is connecting to. This information may be used by the remote peer to determine the correct back-end service to connect the client to. This value will be sent in the Open performative, and will be used by SSL and SASL layers to identify the peer.</p> +<dl class="section note"><dt>Note</dt><dd>Note: the virtual host string is passed verbatim, it is not parsed as a URL or modified in any way. It should not contain numeric IP addresses or port numbers unless that is what you intend to send as the virtual host name </dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">hostname</td><td>the virtual host name </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="gacaaee6956135f36d9bd6ef4d9f300a2c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_connection_set_password </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>password</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Set the authentication password for a client connection</p> +<p>It is necessary to set the username and password before binding the connection to a trasnport and it isn't allowed to change them after the binding.</p> +<p>Note that the password is write only and has no accessor as the underlying implementation should be zeroing the password after use to avoid the password being present in memory longer than necessary</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">password</td><td>the password corresponding to the username - this will be copied and zeroed out after use </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ga167a317ed0316c37e28a11e4e97d6a53"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_connection_set_user </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>user</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Set the authentication username for a client connection</p> +<p>It is necessary to set the username and password before binding the connection to a trasnport and it isn't allowed to change them after the binding.</p> +<p>If not set then no authentication will be negotiated unless the client sasl layer is explicitly created (this would be for sometting like Kerberos where the credentials are implicit in the environment, or to explicitly use the ANONYMOUS SASL mechanism)</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">user</td><td>the username </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="gab2f0a1503fa22e705dcad9056054a18a"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">pn_state_t</a> pn_connection_state </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the endpoint state flags for a connection.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the connection's state flags </dd></dl> + +</div> +</div> +<a class="anchor" id="ga9181af243a5958309ad90bf8460634ae"></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_connection_transport </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the transport bound to a connection object.</p> +<p>If the connection is unbound, then this operation will return NULL.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the transport bound to a connection, or NULL if the connection is unbound </dd></dl> + +</div> +</div> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="footer">Generated by + <a href="http://www.doxygen.org/index.html";> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3.1 </li> + </ul> +</div> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/de3c3488/content/releases/qpid-proton-0.15.0/proton/c/api/group__connection.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-0.15.0/proton/c/api/group__connection.js b/content/releases/qpid-proton-0.15.0/proton/c/api/group__connection.js new file mode 100755 index 0000000..45d1372 --- /dev/null +++ b/content/releases/qpid-proton-0.15.0/proton/c/api/group__connection.js @@ -0,0 +1,44 @@ +var group__connection = +[ + [ "Condition", "group__condition.html", "group__condition" ], + [ "PN_LOCAL_ACTIVE", "group__connection.html#ga0c3bf54f0991944a2f6eea36b561fa2b", null ], + [ "PN_LOCAL_CLOSED", "group__connection.html#ga602c2c870ebed1d9bfe100876909225b", null ], + [ "PN_LOCAL_MASK", "group__connection.html#ga32329c4bb3e23607a243cd8100c01264", null ], + [ "PN_LOCAL_UNINIT", "group__connection.html#gac83dd8123b992813be86fe0f7eaf8f61", null ], + [ "PN_REMOTE_ACTIVE", "group__connection.html#gad96220f2886c21a4f2eebc9487f53a87", null ], + [ "PN_REMOTE_CLOSED", "group__connection.html#ga764c602a20457f9aa8862825b6d13a8d", null ], + [ "PN_REMOTE_MASK", "group__connection.html#ga695af0c2d90d50f4baf403ea60710fa3", null ], + [ "PN_REMOTE_UNINIT", "group__connection.html#ga4c35fcb0aacd254d586df8594ee770d3", null ], + [ "pn_connection_t", "group__connection.html#ga886351d81ff3a977a284a206526c5aff", null ], + [ "pn_state_t", "group__connection.html#gaa83193a655e32bffc18624acc2c39233", null ], + [ "pn_connection", "group__connection.html#ga7ad02932efd7fd54938813852f7b61dc", null ], + [ "pn_connection_attachments", "group__connection.html#ga8510314b8226658d14ee20253bde5853", null ], + [ "pn_connection_close", "group__connection.html#gacc8f6e4fd7c886c084212852918bd8cf", null ], + [ "pn_connection_collect", "group__connection.html#ga7943e7721ab30776cb79d4799d628164", null ], + [ "pn_connection_condition", "group__connection.html#gaf9b7a7f1b127151a1cb35dcb86bcbe6d", null ], + [ "pn_connection_desired_capabilities", "group__connection.html#ga608fc121ce149f534bac640b119d2230", null ], + [ "pn_connection_error", "group__connection.html#ga6ee261d6544bd80c8db1c00861e6847b", null ], + [ "pn_connection_free", "group__connection.html#ga94b0ff0015b3d2c2325fb24cc0e65bf2", null ], + [ "pn_connection_get_container", "group__connection.html#ga1ae9f5d1b693ed734384241100564c60", null ], + [ "pn_connection_get_context", "group__connection.html#gaf304c011df5e00160f49297ba172149c", null ], + [ "pn_connection_get_hostname", "group__connection.html#gac1df3c6f6d31bbc1a0e0e7e4ffb1b4fa", null ], + [ "pn_connection_get_user", "group__connection.html#gaeb5426c33775c4d668d1653426e65d95", null ], + [ "pn_connection_offered_capabilities", "group__connection.html#ga8b7a3914155561305f814d12422c874a", null ], + [ "pn_connection_open", "group__connection.html#ga7458674f4779b1e863494a991c923c0e", null ], + [ "pn_connection_properties", "group__connection.html#gab8700c359187ecb9451acf43c78c5486", null ], + [ "pn_connection_release", "group__connection.html#gaa373c1fb55103e273944f49cc8b0edf5", null ], + [ "pn_connection_remote_condition", "group__connection.html#ga6a8f4087f792e701e01a572b8ac84dd0", null ], + [ "pn_connection_remote_container", "group__connection.html#ga466d510620741123b4e9ba723c039f0c", null ], + [ "pn_connection_remote_desired_capabilities", "group__connection.html#ga57a496ea0893c5920a7ace900e033a74", null ], + [ "pn_connection_remote_hostname", "group__connection.html#ga2d78f4bf7484fa8a44bb7fd64b7a75e8", null ], + [ "pn_connection_remote_offered_capabilities", "group__connection.html#ga9d3578b047e3f0118c0fd5e106f58579", null ], + [ "pn_connection_remote_properties", "group__connection.html#ga98cc1795b88c340ee0d3aab3b8db0abf", null ], + [ "pn_connection_reset", "group__connection.html#ga5da6d9f55883af5f996d45828a7034a7", null ], + [ "pn_connection_set_container", "group__connection.html#ga26407d58547c672d64858e07375e0965", null ], + [ "pn_connection_set_context", "group__connection.html#ga3f6cdab1871250511beef56402a4f7f7", null ], + [ "pn_connection_set_hostname", "group__connection.html#ga204a7c356658d414f5d08da4f25f5d9e", null ], + [ "pn_connection_set_password", "group__connection.html#gacaaee6956135f36d9bd6ef4d9f300a2c", null ], + [ "pn_connection_set_user", "group__connection.html#ga167a317ed0316c37e28a11e4e97d6a53", null ], + [ "pn_connection_state", "group__connection.html#gab2f0a1503fa22e705dcad9056054a18a", null ], + [ "pn_connection_transport", "group__connection.html#ga9181af243a5958309ad90bf8460634ae", null ] +]; \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org
