http://git-wip-us.apache.org/repos/asf/qpid-site/blob/de3c3488/content/releases/qpid-proton-0.15.0/proton/c/api/group__link.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-0.15.0/proton/c/api/group__link.html b/content/releases/qpid-proton-0.15.0/proton/c/api/group__link.html new file mode 100755 index 0000000..5c5d3e3 --- /dev/null +++ b/content/releases/qpid-proton-0.15.0/proton/c/api/group__link.html @@ -0,0 +1,1350 @@ +<!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: Link</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__link.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="#typedef-members">Typedefs</a> | +<a href="#enum-members">Enumerations</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">Link<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__sender"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sender.html">Sender</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:group__receiver"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__receiver.html">Receiver</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:group__terminus"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__terminus.html">Terminus</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="typedef-members"></a> +Typedefs</h2></td></tr> +<tr class="memitem:ga89dad3aa7934329a7ff467c636687bc0"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a></td></tr> +<tr class="separator:ga89dad3aa7934329a7ff467c636687bc0"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> +Enumerations</h2></td></tr> +<tr class="memitem:ga3fb58bd0b88d37407ebb615c2630e608"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga3fb58bd0b88d37407ebb615c2630e608">pn_snd_settle_mode_t</a> { <a class="el" href="group__link.html#gga3fb58bd0b88d37407ebb615c2630e608a8bd9806d2f8d8c1724ed26bb0543bade">PN_SND_UNSETTLED</a> = 0, +<a class="el" href="group__link.html#gga3fb58bd0b88d37407ebb615c2630e608ac159f0edca565961b554768a42e82bf0">PN_SND_SETTLED</a> = 1, +<a class="el" href="group__link.html#gga3fb58bd0b88d37407ebb615c2630e608ac33a5700d0247976b465aeb7c1437fd1">PN_SND_MIXED</a> = 2 + }</td></tr> +<tr class="separator:ga3fb58bd0b88d37407ebb615c2630e608"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad1c2388cdae687be26222a5d66fd2d58"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#gad1c2388cdae687be26222a5d66fd2d58">pn_rcv_settle_mode_t</a> { <a class="el" href="group__link.html#ggad1c2388cdae687be26222a5d66fd2d58ac22b82396bd686940dfcc861302a8262">PN_RCV_FIRST</a> = 0, +<a class="el" href="group__link.html#ggad1c2388cdae687be26222a5d66fd2d58ac79dc7f63fce078a8f0fe268c81dcaf3">PN_RCV_SECOND</a> = 1 + }</td></tr> +<tr class="separator:gad1c2388cdae687be26222a5d66fd2d58"><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:ga1d87431c33b1d5e84ee8f42875cae8d5"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga1d87431c33b1d5e84ee8f42875cae8d5">pn_sender</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session, const char *name)</td></tr> +<tr class="separator:ga1d87431c33b1d5e84ee8f42875cae8d5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga476a97822eff18e7b8ae39a0a3a0b20f"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga476a97822eff18e7b8ae39a0a3a0b20f">pn_receiver</a> (<a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> *session, const char *name)</td></tr> +<tr class="separator:ga476a97822eff18e7b8ae39a0a3a0b20f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa28fac1437012b534873b6e255bcb494"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#gaa28fac1437012b534873b6e255bcb494">pn_link_free</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:gaa28fac1437012b534873b6e255bcb494"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga1bca6c08ba0179233dc76cb3834cbe4e"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga1bca6c08ba0179233dc76cb3834cbe4e">pn_link_get_context</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:ga1bca6c08ba0179233dc76cb3834cbe4e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0be02619b09c3b7b38fe50318466792e"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga0be02619b09c3b7b38fe50318466792e">pn_link_set_context</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link, void *context)</td></tr> +<tr class="separator:ga0be02619b09c3b7b38fe50318466792e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga51ace30d440f3f6a1c7b022a17c14738"><td class="memItemLeft" align="right" valign="top">PN_EXTERN pn_record_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga51ace30d440f3f6a1c7b022a17c14738">pn_link_attachments</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:ga51ace30d440f3f6a1c7b022a17c14738"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3d284db80651c3183a60f706325f2266"><td class="memItemLeft" align="right" valign="top">PN_EXTERN const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga3d284db80651c3183a60f706325f2266">pn_link_name</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:ga3d284db80651c3183a60f706325f2266"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gacb14567cf4afa5a3d2ec774cd66ec9fe"><td class="memItemLeft" align="right" valign="top">PN_EXTERN bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#gacb14567cf4afa5a3d2ec774cd66ec9fe">pn_link_is_sender</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:gacb14567cf4afa5a3d2ec774cd66ec9fe"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac02f18d19fa8da9fef840e52be41cf68"><td class="memItemLeft" align="right" valign="top">PN_EXTERN bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#gac02f18d19fa8da9fef840e52be41cf68">pn_link_is_receiver</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:gac02f18d19fa8da9fef840e52be41cf68"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaef39c0b3b65fca7d9b227ef38a345394"><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__link.html#gaef39c0b3b65fca7d9b227ef38a345394">pn_link_state</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:gaef39c0b3b65fca7d9b227ef38a345394"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga72d4d05cc2a29cc1a3c96cd984c2a4b6"><td class="memItemLeft" align="right" valign="top">PN_EXTERN pn_error_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga72d4d05cc2a29cc1a3c96cd984c2a4b6">pn_link_error</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:ga72d4d05cc2a29cc1a3c96cd984c2a4b6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3d9321a1831d214e079152b7a8030cf1"><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__link.html#ga3d9321a1831d214e079152b7a8030cf1">pn_link_condition</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:ga3d9321a1831d214e079152b7a8030cf1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gabac87dd5667123557a0e73a45ad13349"><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__link.html#gabac87dd5667123557a0e73a45ad13349">pn_link_remote_condition</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:gabac87dd5667123557a0e73a45ad13349"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9417ad2f784646ae23318782411e422a"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga9417ad2f784646ae23318782411e422a">pn_link_session</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:ga9417ad2f784646ae23318782411e422a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gacd5a06ca5daa5d4910d795d7157ebfde"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#gacd5a06ca5daa5d4910d795d7157ebfde">pn_link_head</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection, <a class="el" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">pn_state_t</a> state)</td></tr> +<tr class="separator:gacd5a06ca5daa5d4910d795d7157ebfde"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga07d0254efd3df298246a043f5323d540"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga07d0254efd3df298246a043f5323d540">pn_link_next</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link, <a class="el" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">pn_state_t</a> state)</td></tr> +<tr class="separator:ga07d0254efd3df298246a043f5323d540"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab9a73ca4ac5383a71ddf54cbcb748083"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#gab9a73ca4ac5383a71ddf54cbcb748083">pn_link_open</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:gab9a73ca4ac5383a71ddf54cbcb748083"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad9d63c2255cae6c913cb980f8812ace0"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#gad9d63c2255cae6c913cb980f8812ace0">pn_link_close</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:gad9d63c2255cae6c913cb980f8812ace0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga82df1bbe52ddbc75c7b7403489d4652f"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga82df1bbe52ddbc75c7b7403489d4652f">pn_link_detach</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:ga82df1bbe52ddbc75c7b7403489d4652f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8a8002b94c660f1fd1cbb3e932bd52f0"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga8a8002b94c660f1fd1cbb3e932bd52f0">pn_link_source</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:ga8a8002b94c660f1fd1cbb3e932bd52f0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga44c7bdc0a9179d9cdd96c3153e4da36c"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga44c7bdc0a9179d9cdd96c3153e4da36c">pn_link_target</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:ga44c7bdc0a9179d9cdd96c3153e4da36c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga6955876604a5982a969cf3e44bc3b045"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga6955876604a5982a969cf3e44bc3b045">pn_link_remote_source</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:ga6955876604a5982a969cf3e44bc3b045"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad9c24558b723dc4877abad8bacd5a17a"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#gad9c24558b723dc4877abad8bacd5a17a">pn_link_remote_target</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:gad9c24558b723dc4877abad8bacd5a17a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga662d2bf8a9a447cf1a69f4ec7d72a6ac"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga662d2bf8a9a447cf1a69f4ec7d72a6ac">pn_link_current</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:ga662d2bf8a9a447cf1a69f4ec7d72a6ac"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaea1f1ff885604e194ecfbae8c43e91d7"><td class="memItemLeft" align="right" valign="top">PN_EXTERN bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#gaea1f1ff885604e194ecfbae8c43e91d7">pn_link_advance</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:gaea1f1ff885604e194ecfbae8c43e91d7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae106eccd62d41a1b6125bc471315066d"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#gae106eccd62d41a1b6125bc471315066d">pn_link_credit</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:gae106eccd62d41a1b6125bc471315066d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab5a35ccbd14c04285845a6d7b40f44df"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#gab5a35ccbd14c04285845a6d7b40f44df">pn_link_queued</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:gab5a35ccbd14c04285845a6d7b40f44df"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga1c9b1a283a88199a2dc56af8ab150760"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga1c9b1a283a88199a2dc56af8ab150760">pn_link_remote_credit</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:ga1c9b1a283a88199a2dc56af8ab150760"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga412100bbe765f6fa0313257b6f24a1b8"><td class="memItemLeft" align="right" valign="top">PN_EXTERN bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga412100bbe765f6fa0313257b6f24a1b8">pn_link_get_drain</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:ga412100bbe765f6fa0313257b6f24a1b8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga72edd3ec60adb06f7af3f53580dfcebc"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga72edd3ec60adb06f7af3f53580dfcebc">pn_link_drained</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:ga72edd3ec60adb06f7af3f53580dfcebc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae87b35d45c495a640c04376175696403"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#gae87b35d45c495a640c04376175696403">pn_link_available</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:gae87b35d45c495a640c04376175696403"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga44b6238638d71356b00f3129e0b28182"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__link.html#ga3fb58bd0b88d37407ebb615c2630e608">pn_snd_settle_mode_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga44b6238638d71356b00f3129e0b28182">pn_link_snd_settle_mode</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:ga44b6238638d71356b00f3129e0b28182"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8aec1bf839d167e81037595a86c8751a"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__link.html#gad1c2388cdae687be26222a5d66fd2d58">pn_rcv_settle_mode_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga8aec1bf839d167e81037595a86c8751a">pn_link_rcv_settle_mode</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:ga8aec1bf839d167e81037595a86c8751a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga410b0f045ee235b93a7fa1439af50d2c"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga410b0f045ee235b93a7fa1439af50d2c">pn_link_set_snd_settle_mode</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link, <a class="el" href="group__link.html#ga3fb58bd0b88d37407ebb615c2630e608">pn_snd_settle_mode_t</a> mode)</td></tr> +<tr class="separator:ga410b0f045ee235b93a7fa1439af50d2c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaff06cd4918c76523e1893dc1341ebc48"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#gaff06cd4918c76523e1893dc1341ebc48">pn_link_set_rcv_settle_mode</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link, <a class="el" href="group__link.html#gad1c2388cdae687be26222a5d66fd2d58">pn_rcv_settle_mode_t</a> mode)</td></tr> +<tr class="separator:gaff06cd4918c76523e1893dc1341ebc48"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga03991c2d516e68c0eba2a2eb910bb9f5"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__link.html#ga3fb58bd0b88d37407ebb615c2630e608">pn_snd_settle_mode_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga03991c2d516e68c0eba2a2eb910bb9f5">pn_link_remote_snd_settle_mode</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:ga03991c2d516e68c0eba2a2eb910bb9f5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga13d85968d1ced071196379c9cbd108b1"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__link.html#gad1c2388cdae687be26222a5d66fd2d58">pn_rcv_settle_mode_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga13d85968d1ced071196379c9cbd108b1">pn_link_remote_rcv_settle_mode</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:ga13d85968d1ced071196379c9cbd108b1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga77f816f63c744283b2fd62e6f8abef07"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga77f816f63c744283b2fd62e6f8abef07">pn_link_unsettled</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:ga77f816f63c744283b2fd62e6f8abef07"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga79008e1324488bcbc7387b657c1d2897"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga79008e1324488bcbc7387b657c1d2897">pn_unsettled_head</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="separator:ga79008e1324488bcbc7387b657c1d2897"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga29f38b239a25d8adad5fa7457e4ec014"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga29f38b239a25d8adad5fa7457e4ec014">pn_unsettled_next</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> +<tr class="separator:ga29f38b239a25d8adad5fa7457e4ec014"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<h2 class="groupheader">Typedef Documentation</h2> +<a class="anchor" id="ga89dad3aa7934329a7ff467c636687bc0"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef struct <a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> <a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a></td> + </tr> + </table> +</div><div class="memdoc"> +<p>An AMQP Link object.</p> +<p>A pn_link_t object encapsulates all of the endpoint state associated with an AMQP Link. A pn_link_t object contains an ordered sequence of <a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> objects representing in-flight deliveries. A pn_link_t may be 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> +<p>A pn_link_t object maintains a pointer to the <em>current</em> delivery within the ordered sequence of deliveries contained by the link (See <a class="el" href="group__link.html#ga662d2bf8a9a447cf1a69f4ec7d72a6ac">pn_link_current</a>). The <em>current</em> delivery is the target of a number of operations associated with the link, such as sending (<a class="el" href="group__sender.html#ga6edd45454fe2ddd093aad94f3d277475">pn_link_send</a>) and receiving (<a class="el" href="group__receiver.html#gaa98289676877e6c820a95e4bce94eda6">pn_link_recv</a>) message data. </p> + +</div> +</div> +<h2 class="groupheader">Enumeration Type Documentation</h2> +<a class="anchor" id="gad1c2388cdae687be26222a5d66fd2d58"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="group__link.html#gad1c2388cdae687be26222a5d66fd2d58">pn_rcv_settle_mode_t</a></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Describes the permitted/expected settlement behaviours of a receiving link.</p> +<p>The receiver settle mode describes the permitted and expected behaviour of a receiving link with respect to settling of deliveries. See <a class="el" href="group__delivery.html#ga8b3a1e6da2acabf21fedea60198d4cdb">pn_delivery_settle</a> for more details. </p> +<table class="fieldtable"> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggad1c2388cdae687be26222a5d66fd2d58ac22b82396bd686940dfcc861302a8262"></a>PN_RCV_FIRST</em> </td><td class="fielddoc"> +<p>The receiver will settle deliveries regardless of what the sender does. </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="ggad1c2388cdae687be26222a5d66fd2d58ac79dc7f63fce078a8f0fe268c81dcaf3"></a>PN_RCV_SECOND</em> </td><td class="fielddoc"> +<p>The receiver will only settle deliveries after the sender settles. </p> +</td></tr> +</table> + +</div> +</div> +<a class="anchor" id="ga3fb58bd0b88d37407ebb615c2630e608"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="group__link.html#ga3fb58bd0b88d37407ebb615c2630e608">pn_snd_settle_mode_t</a></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Describes the permitted/expected settlement behaviours of a sending link.</p> +<p>The sender settle mode describes the permitted and expected behaviour of a sending link with respect to settling of deliveries. See <a class="el" href="group__delivery.html#ga8b3a1e6da2acabf21fedea60198d4cdb">pn_delivery_settle</a> for more details. </p> +<table class="fieldtable"> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga3fb58bd0b88d37407ebb615c2630e608a8bd9806d2f8d8c1724ed26bb0543bade"></a>PN_SND_UNSETTLED</em> </td><td class="fielddoc"> +<p>The sender will send all deliveries initially unsettled. </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="gga3fb58bd0b88d37407ebb615c2630e608ac159f0edca565961b554768a42e82bf0"></a>PN_SND_SETTLED</em> </td><td class="fielddoc"> +<p>The sender will send all deliveries settled to the receiver. </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="gga3fb58bd0b88d37407ebb615c2630e608ac33a5700d0247976b465aeb7c1437fd1"></a>PN_SND_MIXED</em> </td><td class="fielddoc"> +<p>The sender may send a mixure of settled and unsettled deliveries. </p> +</td></tr> +</table> + +</div> +</div> +<h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="gaea1f1ff885604e194ecfbae8c43e91d7"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN bool pn_link_advance </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Advance the current delivery of a link to the next delivery on the link.</p> +<p>For sending links this operation is used to finish sending message data for the current outgoing delivery and move on to the next outgoing delivery (if any).</p> +<p>For receiving links, this operation is used to finish accessing message data from the current incoming delivery and move on to the next incoming delivery (if any).</p> +<p>Each link maintains a sequence of deliveries in the order they were created, along with a pointer to the <em>current</em> delivery. The pn_link_advance operation will modify the <em>current</em> delivery on the link to point to the next delivery in the sequence. If there is no next delivery in the sequence, the current delivery will be set to NULL. This operation will return true if invoking it caused the value of the current delivery to change, even if it was set to NULL.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>true if the current delivery was changed </dd></dl> + +</div> +</div> +<a class="anchor" id="ga51ace30d440f3f6a1c7b022a17c14738"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN pn_record_t* pn_link_attachments </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the attachments that are associated with a link object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>the link whose attachments are to be returned. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the attachments for the link object </dd></dl> + +</div> +</div> +<a class="anchor" id="gae87b35d45c495a640c04376175696403"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN int pn_link_available </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the available deliveries hint for a link.</p> +<p>The available count for a link provides a hint as to the number of deliveries that might be able to be sent if sufficient credit were issued by the receiving link endpoint. See <a class="el" href="group__sender.html#gaa7a1eb227dde862c8a311535d1737b1a">pn_link_offered</a> for more details.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the available deliveries hint </dd></dl> + +</div> +</div> +<a class="anchor" id="gad9d63c2255cae6c913cb980f8812ace0"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_link_close </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Close a link.</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__link.html#gab9a73ca4ac5383a71ddf54cbcb748083">pn_link_open</a>, in this case it is equivalent to calling <a class="el" href="group__link.html#gab9a73ca4ac5383a71ddf54cbcb748083">pn_link_open</a> followed by <a class="el" href="group__link.html#gad9d63c2255cae6c913cb980f8812ace0">pn_link_close</a>.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ga3d9321a1831d214e079152b7a8030cf1"></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_link_condition </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the local condition associated with a link endpoint.</p> +<p>The <a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> object retrieved may be modified prior to closing a link in order to indicate a particular condition exists when the link closes. This is normally used to communicate error conditions to the remote peer, however it may also be used in non error cases. See <a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> for more details.</p> +<p>The pointer returned by this operation is valid until the link object is freed.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>the link object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the link's local condition object </dd></dl> + +</div> +</div> +<a class="anchor" id="gae106eccd62d41a1b6125bc471315066d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN int pn_link_credit </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the credit balance for a link.</p> +<p>Links use a credit based flow control scheme. Every receiver maintains a credit balance that corresponds to the number of deliveries that the receiver can accept at any given moment. As more capacity becomes available at the receiver (see <a class="el" href="group__receiver.html#gaf331f33acd1fddbb6f8e674a8a7c6aa2">pn_link_flow</a>), it adds credit to this balance and communicates the new balance to the sender. Whenever a delivery is sent/received, the credit balance maintained by the link is decremented by one. Once the credit balance at the sender reaches zero, the sender must pause sending until more credit is obtained from the receiver.</p> +<p>Note that a sending link may still be used to send deliveries even if pn_link_credit reaches zero, however those deliveries will end up being buffered by the link until enough credit is obtained from the receiver to send them over the wire. In this case the balance reported by <a class="el" href="group__link.html#gae106eccd62d41a1b6125bc471315066d">pn_link_credit</a> will go negative.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the credit balance for the link </dd></dl> + +</div> +</div> +<a class="anchor" id="ga662d2bf8a9a447cf1a69f4ec7d72a6ac"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a>* pn_link_current </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the current delivery for a link.</p> +<p>Each link maintains a sequence of deliveries in the order they were created, along with a pointer to the <em>current</em> delivery. All send/recv operations on a link take place on the <em>current</em> delivery. If a link has no current delivery, the current delivery is automatically initialized to the next delivery created on the link. Once initialized, the current delivery remains the same until it is changed through use of <a class="el" href="group__link.html#gaea1f1ff885604e194ecfbae8c43e91d7">pn_link_advance</a> or until it is settled via <a class="el" href="group__delivery.html#ga8b3a1e6da2acabf21fedea60198d4cdb">pn_delivery_settle</a>.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the current delivery for the link, or NULL if there is none </dd></dl> + +</div> +</div> +<a class="anchor" id="ga82df1bbe52ddbc75c7b7403489d4652f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_link_detach </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Detach a link.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ga72edd3ec60adb06f7af3f53580dfcebc"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN int pn_link_drained </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Drain excess credit for a link.</p> +<p>When a link is in drain mode, the sender must use all excess credit immediately, and release any excess credit back to the receiver if there are no deliveries available to send.</p> +<p>When invoked on a sending link that is in drain mode, this operation will release all excess credit back to the receiver and return the number of credits released back to the sender. If the link is not in drain mode, this operation is a noop.</p> +<p>When invoked on a receiving link, this operation will return and reset the number of credits the sender has released back to the receiver.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the number of credits drained </dd></dl> + +</div> +</div> +<a class="anchor" id="ga72d4d05cc2a29cc1a3c96cd984c2a4b6"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN pn_error_t* pn_link_error </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get additional error information associated with the link.</p> +<p>Whenever a link 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 link object is freed.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>the link object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the link's error object </dd></dl> + +</div> +</div> +<a class="anchor" id="gaa28fac1437012b534873b6e255bcb494"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_link_free </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Free a link object.</p> +<p>When a link object is freed, all <a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> objects associated with the session are also freed. Freeing a link will settle any unsettled deliveries on the link.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object to free (or NULL) </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ga1bca6c08ba0179233dc76cb3834cbe4e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void* pn_link_get_context </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000005">Deprecated:</a></b></dt><dd>Get the application context that is associated with a link object.</dd></dl> +<p>The application context for a link may be set using <a class="el" href="group__link.html#ga0be02619b09c3b7b38fe50318466792e">pn_link_set_context</a>.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>the link whose context is to be returned. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the application context for the link object </dd></dl> + +</div> +</div> +<a class="anchor" id="ga412100bbe765f6fa0313257b6f24a1b8"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN bool pn_link_get_drain </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the drain flag for a link.</p> +<p>If a link is in drain mode, then the sending endpoint of a link must immediately use up all available credit on the link. If this is not possible, the excess credit must be returned by invoking <a class="el" href="group__link.html#ga72edd3ec60adb06f7af3f53580dfcebc">pn_link_drained</a>. Only the receiving endpoint can set the drain mode. See <a class="el" href="group__receiver.html#ga22837f7f8e152add8de867bbe4163892">pn_link_set_drain</a> for details.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>true if and only if the link is in drain mode </dd></dl> + +</div> +</div> +<a class="anchor" id="gacd5a06ca5daa5d4910d795d7157ebfde"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a>* pn_link_head </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">pn_state_t</a> </td> + <td class="paramname"><em>state</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Retrieve the first link that matches the given state mask.</p> +<p>Examines the state of each link owned by the connection and returns the first link that matches the given state mask. If state contains both local and remote flags, then an exact match against those flags is performed. If state contains only local or only remote flags, then a match occurs if any of the local or remote flags are set respectively. state==0 matches all links.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>to be searched for matching Links </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>mask to match </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the first link owned by the connection that matches the mask, else NULL if no links match </dd></dl> + +</div> +</div> +<a class="anchor" id="gac02f18d19fa8da9fef840e52be41cf68"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN bool pn_link_is_receiver </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Test if a link is a receiver.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>true if and only if the link is a receiver </dd></dl> + +</div> +</div> +<a class="anchor" id="gacb14567cf4afa5a3d2ec774cd66ec9fe"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN bool pn_link_is_sender </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Test if a link is a sender.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>true if and only if the link is a sender </dd></dl> + +</div> +</div> +<a class="anchor" id="ga3d284db80651c3183a60f706325f2266"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN const char* pn_link_name </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the name of a link.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the name of the link </dd></dl> + +</div> +</div> +<a class="anchor" id="ga07d0254efd3df298246a043f5323d540"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a>* pn_link_next </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__connection.html#gaa83193a655e32bffc18624acc2c39233">pn_state_t</a> </td> + <td class="paramname"><em>state</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Retrieve the next link that matches the given state mask.</p> +<p>When used with pn_link_head, the application can access all links on the connection that match the given state. See pn_link_head for description of match behavior.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>the previous link obtained from pn_link_head or pn_link_next </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>mask to match </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the next session owned by the connection that matches the mask, else NULL if no sessions match </dd></dl> + +</div> +</div> +<a class="anchor" id="gab9a73ca4ac5383a71ddf54cbcb748083"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_link_open </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Open a link.</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">link</td><td>a link object </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="gab5a35ccbd14c04285845a6d7b40f44df"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN int pn_link_queued </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the number of queued deliveries for a link.</p> +<p>Links may queue deliveries for a number of reasons, for example there may be insufficient credit to send them to the receiver (see <a class="el" href="group__link.html#gae106eccd62d41a1b6125bc471315066d">pn_link_credit</a>), or they simply may not have yet had a chance to be written to the wire. This operation will return the number of queued deliveries on a link.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the number of queued deliveries for the link </dd></dl> + +</div> +</div> +<a class="anchor" id="ga8aec1bf839d167e81037595a86c8751a"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__link.html#gad1c2388cdae687be26222a5d66fd2d58">pn_rcv_settle_mode_t</a> pn_link_rcv_settle_mode </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the local receiver settle mode for a link.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the local receiver settle mode </dd></dl> + +</div> +</div> +<a class="anchor" id="gabac87dd5667123557a0e73a45ad13349"></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_link_remote_condition </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the remote condition associated with a link 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 link 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 link object is freed.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>the link object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the link's remote condition object </dd></dl> + +</div> +</div> +<a class="anchor" id="ga1c9b1a283a88199a2dc56af8ab150760"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN int pn_link_remote_credit </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the remote view of the credit for a link.</p> +<p>The remote view of the credit for a link differs from local view of credit for a link by the number of queued deliveries. In other words <a class="el" href="group__link.html#ga1c9b1a283a88199a2dc56af8ab150760">pn_link_remote_credit</a> is defined to be <a class="el" href="group__link.html#gae106eccd62d41a1b6125bc471315066d">pn_link_credit</a> - <a class="el" href="group__link.html#gab5a35ccbd14c04285845a6d7b40f44df">pn_link_queued</a>.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the remote view of the credit for a link </dd></dl> + +</div> +</div> +<a class="anchor" id="ga13d85968d1ced071196379c9cbd108b1"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__link.html#gad1c2388cdae687be26222a5d66fd2d58">pn_rcv_settle_mode_t</a> pn_link_remote_rcv_settle_mode </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the remote receiver settle mode for a link.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the remote receiver settle mode </dd></dl> + +</div> +</div> +<a class="anchor" id="ga03991c2d516e68c0eba2a2eb910bb9f5"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__link.html#ga3fb58bd0b88d37407ebb615c2630e608">pn_snd_settle_mode_t</a> pn_link_remote_snd_settle_mode </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the remote sender settle mode for a link.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the remote sender settle mode </dd></dl> + +</div> +</div> +<a class="anchor" id="ga6955876604a5982a969cf3e44bc3b045"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a>* pn_link_remote_source </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Access the remotely defined source definition for a link.</p> +<p>The pointer returned by this operation is valid until the link object is freed. The remotely defined terminus will be empty until the link is remotely opened as indicated by the PN_REMOTE_ACTIVE flag.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to the remotely defined source terminus </dd></dl> + +</div> +</div> +<a class="anchor" id="gad9c24558b723dc4877abad8bacd5a17a"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a>* pn_link_remote_target </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Access the remotely defined target definition for a link.</p> +<p>The pointer returned by this operation is valid until the link object is freed. The remotely defined terminus will be empty until the link is remotely opened as indicated by the PN_REMOTE_ACTIVE flag.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to the remotely defined target terminus </dd></dl> + +</div> +</div> +<a class="anchor" id="ga9417ad2f784646ae23318782411e422a"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a>* pn_link_session </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the parent session for a link object.</p> +<p>This operation retrieves the parent <a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> object that contains the given <a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>the link object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the parent session object </dd></dl> + +</div> +</div> +<a class="anchor" id="ga0be02619b09c3b7b38fe50318466792e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_link_set_context </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</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#_deprecated000006">Deprecated:</a></b></dt><dd>Set a new application context for a link object.</dd></dl> +<p>The application context for a link object may be retrieved using <a class="el" href="group__link.html#ga1bca6c08ba0179233dc76cb3834cbe4e">pn_link_get_context</a>.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>the link 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="gaff06cd4918c76523e1893dc1341ebc48"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_link_set_rcv_settle_mode </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__link.html#gad1c2388cdae687be26222a5d66fd2d58">pn_rcv_settle_mode_t</a> </td> + <td class="paramname"><em>mode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Set the local receiver settle mode for a link.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>the receiver settle mode </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ga410b0f045ee235b93a7fa1439af50d2c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN void pn_link_set_snd_settle_mode </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__link.html#ga3fb58bd0b88d37407ebb615c2630e608">pn_snd_settle_mode_t</a> </td> + <td class="paramname"><em>mode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Set the local sender settle mode for a link.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>the sender settle mode </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ga44b6238638d71356b00f3129e0b28182"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__link.html#ga3fb58bd0b88d37407ebb615c2630e608">pn_snd_settle_mode_t</a> pn_link_snd_settle_mode </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the local sender settle mode for a link.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the local sender settle mode </dd></dl> + +</div> +</div> +<a class="anchor" id="ga8a8002b94c660f1fd1cbb3e932bd52f0"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a>* pn_link_source </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Access the locally defined source definition for a link.</p> +<p>The pointer returned by this operation is valid until the link object is freed.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to a source terminus </dd></dl> + +</div> +</div> +<a class="anchor" id="gaef39c0b3b65fca7d9b227ef38a345394"></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_link_state </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the endpoint state flags for a link.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>the link </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the link's state flags </dd></dl> + +</div> +</div> +<a class="anchor" id="ga44c7bdc0a9179d9cdd96c3153e4da36c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a>* pn_link_target </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Access the locally defined target definition for a link.</p> +<p>The pointer returned by this operation is valid until the link object is freed.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to a target terminus </dd></dl> + +</div> +</div> +<a class="anchor" id="ga77f816f63c744283b2fd62e6f8abef07"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN int pn_link_unsettled </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the number of unsettled deliveries for a link.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the number of unsettled deliveries </dd></dl> + +</div> +</div> +<a class="anchor" id="ga476a97822eff18e7b8ae39a0a3a0b20f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a>* pn_receiver </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> * </td> + <td class="paramname"><em>session</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>name</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Construct a new receiver on a session.</p> +<p>Each receiving link between two AMQP containers must be uniquely named. Note that this uniqueness cannot be enforced at the API level, so some consideration should be taken in choosing link names.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>the session object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>the name of the link </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a newly constructed receiver link or NULL on error </dd></dl> + +</div> +</div> +<a class="anchor" id="ga1d87431c33b1d5e84ee8f42875cae8d5"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a>* pn_sender </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__session.html#ga38ccb93b8f5c2892adafce5d5f0fbcd9">pn_session_t</a> * </td> + <td class="paramname"><em>session</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>name</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Construct a new sender on a session.</p> +<p>Each sending link between two AMQP containers must be uniquely named. Note that this uniqueness cannot be enforced at the API level, so some consideration should be taken in choosing link names.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>the session object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>the name of the link </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a newly constructed sender link or NULL on error </dd></dl> + +</div> +</div> +<a class="anchor" id="ga79008e1324488bcbc7387b657c1d2897"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a>* pn_unsettled_head </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the first unsettled delivery for a link.</p> +<p>"</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to the first unsettled delivery on the link </dd></dl> + +</div> +</div> +<a class="anchor" id="ga29f38b239a25d8adad5fa7457e4ec014"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a>* pn_unsettled_next </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td> + <td class="paramname"><em>delivery</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the next unsettled delivery on a link.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the next unsettled delivery on the link </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>
--------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org
