http://git-wip-us.apache.org/repos/asf/qpid-site/blob/de3c3488/content/releases/qpid-proton-0.15.0/proton/c/api/group__terminus.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-0.15.0/proton/c/api/group__terminus.html b/content/releases/qpid-proton-0.15.0/proton/c/api/group__terminus.html new file mode 100755 index 0000000..e9cc529 --- /dev/null +++ b/content/releases/qpid-proton-0.15.0/proton/c/api/group__terminus.html @@ -0,0 +1,853 @@ +<!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: Terminus</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__terminus.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="#typedef-members">Typedefs</a> | +<a href="#enum-members">Enumerations</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">Terminus<div class="ingroups"><a class="el" href="group__link.html">Link</a></div></div> </div> +</div><!--header--> +<div class="contents"> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> +Typedefs</h2></td></tr> +<tr class="memitem:gad202baf5c904d6991e13521b7c93fdc2"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a></td></tr> +<tr class="separator:gad202baf5c904d6991e13521b7c93fdc2"><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:ga3cb9c86d1e2bb024de2658f9def098e7"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__terminus.html#ga3cb9c86d1e2bb024de2658f9def098e7">pn_terminus_type_t</a> { <a class="el" href="group__terminus.html#gga3cb9c86d1e2bb024de2658f9def098e7accee852b0d609496d88d91d683784216">PN_UNSPECIFIED</a> = 0, +<a class="el" href="group__terminus.html#gga3cb9c86d1e2bb024de2658f9def098e7a7fd70c48647a2edc5167bce3ade8f2f0">PN_SOURCE</a> = 1, +<a class="el" href="group__terminus.html#gga3cb9c86d1e2bb024de2658f9def098e7a760e5ca8afcbee9f43a72cfd09b7c54e">PN_TARGET</a> = 2, +<a class="el" href="group__terminus.html#gga3cb9c86d1e2bb024de2658f9def098e7a75bb94f03973a939835d98e9b1999aae">PN_COORDINATOR</a> = 3 + }</td></tr> +<tr class="separator:ga3cb9c86d1e2bb024de2658f9def098e7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga213267363be45848f3299471ea93089b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__terminus.html#ga213267363be45848f3299471ea93089b">pn_durability_t</a> { <a class="el" href="group__terminus.html#gga213267363be45848f3299471ea93089ba403e259f8d858d6a12f463dbd7e5dc6b">PN_NONDURABLE</a> = 0, +<a class="el" href="group__terminus.html#gga213267363be45848f3299471ea93089ba95b1d5b60c47569e0358258305de1d58">PN_CONFIGURATION</a> = 1, +<a class="el" href="group__terminus.html#gga213267363be45848f3299471ea93089bac2e0a9f773faf4ee8fd43f77855933d2">PN_DELIVERIES</a> = 2 + }</td></tr> +<tr class="separator:ga213267363be45848f3299471ea93089b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab4089b27ee99a348deab776f3d4931f0"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__terminus.html#gab4089b27ee99a348deab776f3d4931f0">pn_expiry_policy_t</a> { <a class="el" href="group__terminus.html#ggab4089b27ee99a348deab776f3d4931f0ad559c0f96078b8b7d8b84b77354b2391">PN_EXPIRE_WITH_LINK</a>, +<a class="el" href="group__terminus.html#ggab4089b27ee99a348deab776f3d4931f0a02ac8e7dfc45bb4ae66e97624adaca01">PN_EXPIRE_WITH_SESSION</a>, +<a class="el" href="group__terminus.html#ggab4089b27ee99a348deab776f3d4931f0a188731d2f46e10273d74ae7cedbd5bb5">PN_EXPIRE_WITH_CONNECTION</a>, +<a class="el" href="group__terminus.html#ggab4089b27ee99a348deab776f3d4931f0a52bf932997783f578fd29c0a4659c556">PN_EXPIRE_NEVER</a> + }</td></tr> +<tr class="separator:gab4089b27ee99a348deab776f3d4931f0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac6fb89a5fa96476db51b60f10dc785d0"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__terminus.html#gac6fb89a5fa96476db51b60f10dc785d0">pn_distribution_mode_t</a> { <a class="el" href="group__terminus.html#ggac6fb89a5fa96476db51b60f10dc785d0a74d3ae9ce3ad50e5c5cc71164a2a8aac">PN_DIST_MODE_UNSPECIFIED</a> = 0, +<a class="el" href="group__terminus.html#ggac6fb89a5fa96476db51b60f10dc785d0a914fec87d6b3211d5f2eeb780819e523">PN_DIST_MODE_COPY</a> = 1, +<a class="el" href="group__terminus.html#ggac6fb89a5fa96476db51b60f10dc785d0a9e076691930f95f32c850ea01a808b92">PN_DIST_MODE_MOVE</a> = 2 + }</td></tr> +<tr class="separator:gac6fb89a5fa96476db51b60f10dc785d0"><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:gaaef31d25eb233aace7be1e0174fbf55e"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__terminus.html#ga3cb9c86d1e2bb024de2658f9def098e7">pn_terminus_type_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__terminus.html#gaaef31d25eb233aace7be1e0174fbf55e">pn_terminus_get_type</a> (<a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus)</td></tr> +<tr class="separator:gaaef31d25eb233aace7be1e0174fbf55e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gafe106dcd053dd04b0fdbc9b40b58e23d"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__terminus.html#gafe106dcd053dd04b0fdbc9b40b58e23d">pn_terminus_set_type</a> (<a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus, <a class="el" href="group__terminus.html#ga3cb9c86d1e2bb024de2658f9def098e7">pn_terminus_type_t</a> type)</td></tr> +<tr class="separator:gafe106dcd053dd04b0fdbc9b40b58e23d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf7ce75acdf855eaf7637abcd4131d6b3"><td class="memItemLeft" align="right" valign="top">PN_EXTERN const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__terminus.html#gaf7ce75acdf855eaf7637abcd4131d6b3">pn_terminus_get_address</a> (<a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus)</td></tr> +<tr class="separator:gaf7ce75acdf855eaf7637abcd4131d6b3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae55a8e0c226942c3ce122fa1e453148c"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__terminus.html#gae55a8e0c226942c3ce122fa1e453148c">pn_terminus_set_address</a> (<a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus, const char *address)</td></tr> +<tr class="separator:gae55a8e0c226942c3ce122fa1e453148c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga575d3d03d45453bce10392b120e35a50"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__terminus.html#gac6fb89a5fa96476db51b60f10dc785d0">pn_distribution_mode_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__terminus.html#ga575d3d03d45453bce10392b120e35a50">pn_terminus_get_distribution_mode</a> (const <a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus)</td></tr> +<tr class="separator:ga575d3d03d45453bce10392b120e35a50"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad4abc043078d14aeeaef3116500d62e1"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__terminus.html#gad4abc043078d14aeeaef3116500d62e1">pn_terminus_set_distribution_mode</a> (<a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus, <a class="el" href="group__terminus.html#gac6fb89a5fa96476db51b60f10dc785d0">pn_distribution_mode_t</a> mode)</td></tr> +<tr class="separator:gad4abc043078d14aeeaef3116500d62e1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gabaa9f17714567505f194d6fbb3ad785c"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__terminus.html#ga213267363be45848f3299471ea93089b">pn_durability_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__terminus.html#gabaa9f17714567505f194d6fbb3ad785c">pn_terminus_get_durability</a> (<a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus)</td></tr> +<tr class="separator:gabaa9f17714567505f194d6fbb3ad785c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga386428e4d1742649fffa112f231a3bf8"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__terminus.html#ga386428e4d1742649fffa112f231a3bf8">pn_terminus_set_durability</a> (<a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus, <a class="el" href="group__terminus.html#ga213267363be45848f3299471ea93089b">pn_durability_t</a> durability)</td></tr> +<tr class="separator:ga386428e4d1742649fffa112f231a3bf8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga4ea6ce82047f3fab63e70a29b74b5fcf"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__terminus.html#gab4089b27ee99a348deab776f3d4931f0">pn_expiry_policy_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__terminus.html#ga4ea6ce82047f3fab63e70a29b74b5fcf">pn_terminus_get_expiry_policy</a> (<a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus)</td></tr> +<tr class="separator:ga4ea6ce82047f3fab63e70a29b74b5fcf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gace5b1ae5c177b3d072d619567e20c2a3"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__terminus.html#gace5b1ae5c177b3d072d619567e20c2a3">pn_terminus_set_expiry_policy</a> (<a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus, <a class="el" href="group__terminus.html#gab4089b27ee99a348deab776f3d4931f0">pn_expiry_policy_t</a> policy)</td></tr> +<tr class="separator:gace5b1ae5c177b3d072d619567e20c2a3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gadf6f4e80e36b70803acab67b12a35a14"><td class="memItemLeft" align="right" valign="top">PN_EXTERN pn_seconds_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__terminus.html#gadf6f4e80e36b70803acab67b12a35a14">pn_terminus_get_timeout</a> (<a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus)</td></tr> +<tr class="separator:gadf6f4e80e36b70803acab67b12a35a14"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gafe5932e60e778827a0b6c27e7748a814"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__terminus.html#gafe5932e60e778827a0b6c27e7748a814">pn_terminus_set_timeout</a> (<a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus, pn_seconds_t timeout)</td></tr> +<tr class="separator:gafe5932e60e778827a0b6c27e7748a814"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga66ac0a6b680d16588f6e95e0804c64f5"><td class="memItemLeft" align="right" valign="top">PN_EXTERN bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__terminus.html#ga66ac0a6b680d16588f6e95e0804c64f5">pn_terminus_is_dynamic</a> (<a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus)</td></tr> +<tr class="separator:ga66ac0a6b680d16588f6e95e0804c64f5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8600194fb12e709bb165249996d3d136"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__terminus.html#ga8600194fb12e709bb165249996d3d136">pn_terminus_set_dynamic</a> (<a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus, bool dynamic)</td></tr> +<tr class="separator:ga8600194fb12e709bb165249996d3d136"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga166a84223f2e17a8d122bf19e5ebe0e3"><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__terminus.html#ga166a84223f2e17a8d122bf19e5ebe0e3">pn_terminus_properties</a> (<a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus)</td></tr> +<tr class="separator:ga166a84223f2e17a8d122bf19e5ebe0e3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga31429fed465bdf8c393196f3dfbf4d2f"><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__terminus.html#ga31429fed465bdf8c393196f3dfbf4d2f">pn_terminus_capabilities</a> (<a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus)</td></tr> +<tr class="separator:ga31429fed465bdf8c393196f3dfbf4d2f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab27e5d1e2e0d1610ff9d9819d89f4bed"><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__terminus.html#gab27e5d1e2e0d1610ff9d9819d89f4bed">pn_terminus_outcomes</a> (<a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus)</td></tr> +<tr class="separator:gab27e5d1e2e0d1610ff9d9819d89f4bed"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga91a7d1ca890c3171220ea7d1eaa57b86"><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__terminus.html#ga91a7d1ca890c3171220ea7d1eaa57b86">pn_terminus_filter</a> (<a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus)</td></tr> +<tr class="separator:ga91a7d1ca890c3171220ea7d1eaa57b86"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gabf6c265040dd7233bddbb4efcf314999"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__terminus.html#gabf6c265040dd7233bddbb4efcf314999">pn_terminus_copy</a> (<a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *terminus, <a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> *src)</td></tr> +<tr class="separator:gabf6c265040dd7233bddbb4efcf314999"><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="gad202baf5c904d6991e13521b7c93fdc2"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef struct <a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> <a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Encapsulates the endpoint state associated with an AMQP Terminus.</p> +<p>An AMQP Terminus acts as either a source or target for messages, but never both. Every AMQP link is associated with both a source terminus and a target terminus that is negotiated during link establishment. A terminus consists of an AMQP address, along with a number of other properties defining the quality of service and behaviour of the link. </p> + +</div> +</div> +<h2 class="groupheader">Enumeration Type Documentation</h2> +<a class="anchor" id="gac6fb89a5fa96476db51b60f10dc785d0"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="group__terminus.html#gac6fb89a5fa96476db51b60f10dc785d0">pn_distribution_mode_t</a></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Distribution mode of an AMQP terminus.</p> +<p>The distribution mode of a source terminus defines the behaviour when multiple receiving links provide addresses that resolve to the same node. </p> +<table class="fieldtable"> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggac6fb89a5fa96476db51b60f10dc785d0a74d3ae9ce3ad50e5c5cc71164a2a8aac"></a>PN_DIST_MODE_UNSPECIFIED</em> </td><td class="fielddoc"> +<p>the behaviour is defined by the node </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="ggac6fb89a5fa96476db51b60f10dc785d0a914fec87d6b3211d5f2eeb780819e523"></a>PN_DIST_MODE_COPY</em> </td><td class="fielddoc"> +<p>the receiver gets all messages </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="ggac6fb89a5fa96476db51b60f10dc785d0a9e076691930f95f32c850ea01a808b92"></a>PN_DIST_MODE_MOVE</em> </td><td class="fielddoc"> +<p>the receiver competes for messages </p> +</td></tr> +</table> + +</div> +</div> +<a class="anchor" id="ga213267363be45848f3299471ea93089b"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="group__terminus.html#ga213267363be45848f3299471ea93089b">pn_durability_t</a></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Durability mode of an AMQP terminus.</p> +<p>An AMQP terminus may provide durable storage for its state, thereby permitting link recovery in the event of endpoint failures. This durability may be applied to the configuration of the terminus only, or to all delivery state as well. </p> +<table class="fieldtable"> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga213267363be45848f3299471ea93089ba403e259f8d858d6a12f463dbd7e5dc6b"></a>PN_NONDURABLE</em> </td><td class="fielddoc"> +<p>indicates a non durable terminus </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="gga213267363be45848f3299471ea93089ba95b1d5b60c47569e0358258305de1d58"></a>PN_CONFIGURATION</em> </td><td class="fielddoc"> +<p>indicates a terminus with durably held configuration, but not delivery state </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="gga213267363be45848f3299471ea93089bac2e0a9f773faf4ee8fd43f77855933d2"></a>PN_DELIVERIES</em> </td><td class="fielddoc"> +<p>indicates a terminus with both durably held configuration and durably held delivery state. </p> +</td></tr> +</table> + +</div> +</div> +<a class="anchor" id="gab4089b27ee99a348deab776f3d4931f0"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="group__terminus.html#gab4089b27ee99a348deab776f3d4931f0">pn_expiry_policy_t</a></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Expiry policy of an AMQP terminus.</p> +<p>An orphaned terminus can only exist for the timeout configured by <a class="el" href="group__terminus.html#gafe5932e60e778827a0b6c27e7748a814">pn_terminus_set_timeout</a>. The expiry policy determins when a terminus is considered orphaned, i.e. when the expiry timer starts counting down. </p> +<table class="fieldtable"> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggab4089b27ee99a348deab776f3d4931f0ad559c0f96078b8b7d8b84b77354b2391"></a>PN_EXPIRE_WITH_LINK</em> </td><td class="fielddoc"> +<p>the terminus is orphaned when the parent link is closed </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="ggab4089b27ee99a348deab776f3d4931f0a02ac8e7dfc45bb4ae66e97624adaca01"></a>PN_EXPIRE_WITH_SESSION</em> </td><td class="fielddoc"> +<p>the terminus is orphaned when the parent session is closed </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="ggab4089b27ee99a348deab776f3d4931f0a188731d2f46e10273d74ae7cedbd5bb5"></a>PN_EXPIRE_WITH_CONNECTION</em> </td><td class="fielddoc"> +<p>the terminus is orphaned when the parent connection is closed </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="ggab4089b27ee99a348deab776f3d4931f0a52bf932997783f578fd29c0a4659c556"></a>PN_EXPIRE_NEVER</em> </td><td class="fielddoc"> +<p>the terminus is never considered orphaned </p> +</td></tr> +</table> + +</div> +</div> +<a class="anchor" id="ga3cb9c86d1e2bb024de2658f9def098e7"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="group__terminus.html#ga3cb9c86d1e2bb024de2658f9def098e7">pn_terminus_type_t</a></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Type of an AMQP terminus. </p> +<table class="fieldtable"> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga3cb9c86d1e2bb024de2658f9def098e7accee852b0d609496d88d91d683784216"></a>PN_UNSPECIFIED</em> </td><td class="fielddoc"> +<p>indicates a nonexistent terminus, may used as a source or target </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="gga3cb9c86d1e2bb024de2658f9def098e7a7fd70c48647a2edc5167bce3ade8f2f0"></a>PN_SOURCE</em> </td><td class="fielddoc"> +<p>indicates a source of messages </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="gga3cb9c86d1e2bb024de2658f9def098e7a760e5ca8afcbee9f43a72cfd09b7c54e"></a>PN_TARGET</em> </td><td class="fielddoc"> +<p>indicates a target for messages </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="gga3cb9c86d1e2bb024de2658f9def098e7a75bb94f03973a939835d98e9b1999aae"></a>PN_COORDINATOR</em> </td><td class="fielddoc"> +<p>a special target identifying a transaction coordinator </p> +</td></tr> +</table> + +</div> +</div> +<h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="ga31429fed465bdf8c393196f3dfbf4d2f"></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_terminus_capabilities </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> + <td class="paramname"><em>terminus</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Access/modify the AMQP capabilities data for a terminus 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 terminus object is freed due to its parent link being 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 capabilities for the parent terminus object. Note that this MUST take the form of an array of symbols to be valid.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to a pn_data_t representing the terminus capabilities </dd></dl> + +</div> +</div> +<a class="anchor" id="gabf6c265040dd7233bddbb4efcf314999"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN int pn_terminus_copy </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> + <td class="paramname"><em>terminus</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> + <td class="paramname"><em>src</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Copy a terminus object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>the terminus object to be copied into </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>the terminus to be copied from </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </dd></dl> + +</div> +</div> +<a class="anchor" id="ga91a7d1ca890c3171220ea7d1eaa57b86"></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_terminus_filter </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> + <td class="paramname"><em>terminus</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Access/modify the AMQP filter set for a terminus 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 terminus object is freed due to its parent link being 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 filter set for the parent terminus object. Note that this MUST take the form of a symbol keyed map to be valid.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a source terminus object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to a pn_data_t representing the terminus filter set </dd></dl> + +</div> +</div> +<a class="anchor" id="gaf7ce75acdf855eaf7637abcd4131d6b3"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN const char* pn_terminus_get_address </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> + <td class="paramname"><em>terminus</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the address of a terminus object.</p> +<p>The pointer returned by this operation is valid until <a class="el" href="group__terminus.html#gae55a8e0c226942c3ce122fa1e453148c">pn_terminus_set_address</a> is called or until the terminus is freed due to its parent link being freed.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to the address </dd></dl> + +</div> +</div> +<a class="anchor" id="ga575d3d03d45453bce10392b120e35a50"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__terminus.html#gac6fb89a5fa96476db51b60f10dc785d0">pn_distribution_mode_t</a> pn_terminus_get_distribution_mode </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> + <td class="paramname"><em>terminus</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the distribution mode of a terminus object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the distribution mode of the terminus </dd></dl> + +</div> +</div> +<a class="anchor" id="gabaa9f17714567505f194d6fbb3ad785c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__terminus.html#ga213267363be45848f3299471ea93089b">pn_durability_t</a> pn_terminus_get_durability </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> + <td class="paramname"><em>terminus</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the durability mode of a terminus object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the terminus durability mode </dd></dl> + +</div> +</div> +<a class="anchor" id="ga4ea6ce82047f3fab63e70a29b74b5fcf"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__terminus.html#gab4089b27ee99a348deab776f3d4931f0">pn_expiry_policy_t</a> pn_terminus_get_expiry_policy </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> + <td class="paramname"><em>terminus</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the expiry policy of a terminus object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the expiry policy of the terminus </dd></dl> + +</div> +</div> +<a class="anchor" id="gadf6f4e80e36b70803acab67b12a35a14"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN pn_seconds_t pn_terminus_get_timeout </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> + <td class="paramname"><em>terminus</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the timeout of a terminus object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the timeout of the terminus </dd></dl> + +</div> +</div> +<a class="anchor" id="gaaef31d25eb233aace7be1e0174fbf55e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <a class="el" href="group__terminus.html#ga3cb9c86d1e2bb024de2658f9def098e7">pn_terminus_type_t</a> pn_terminus_get_type </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> + <td class="paramname"><em>terminus</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the type of a terminus object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the terminus type </dd></dl> + +</div> +</div> +<a class="anchor" id="ga66ac0a6b680d16588f6e95e0804c64f5"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN bool pn_terminus_is_dynamic </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> + <td class="paramname"><em>terminus</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the dynamic flag for a terminus object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>true if the dynamic flag is set for the terminus, false otherwise </dd></dl> + +</div> +</div> +<a class="anchor" id="gab27e5d1e2e0d1610ff9d9819d89f4bed"></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_terminus_outcomes </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> + <td class="paramname"><em>terminus</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Access/modify the AMQP outcomes for a terminus 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 terminus object is freed due to its parent link being 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 outcomes for the parent terminus object. Note that this MUST take the form of an array of symbols to be valid.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to a pn_data_t representing the terminus outcomes </dd></dl> + +</div> +</div> +<a class="anchor" id="ga166a84223f2e17a8d122bf19e5ebe0e3"></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_terminus_properties </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> + <td class="paramname"><em>terminus</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Access/modify the AMQP properties data for a terminus 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 terminus object is freed due to its parent link being 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 terminus object. Note that this MUST take the form of a symbol keyed map to be valid.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to a pn_data_t representing the terminus properties </dd></dl> + +</div> +</div> +<a class="anchor" id="gae55a8e0c226942c3ce122fa1e453148c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN int pn_terminus_set_address </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> + <td class="paramname"><em>terminus</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>address</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Set the address of a terminus object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">address</td><td>an AMQP address string </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </dd></dl> + +</div> +</div> +<a class="anchor" id="gad4abc043078d14aeeaef3116500d62e1"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN int pn_terminus_set_distribution_mode </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> + <td class="paramname"><em>terminus</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__terminus.html#gac6fb89a5fa96476db51b60f10dc785d0">pn_distribution_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 distribution mode of a terminus object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>the distribution mode for the terminus </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </dd></dl> + +</div> +</div> +<a class="anchor" id="ga386428e4d1742649fffa112f231a3bf8"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN int pn_terminus_set_durability </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> + <td class="paramname"><em>terminus</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__terminus.html#ga213267363be45848f3299471ea93089b">pn_durability_t</a> </td> + <td class="paramname"><em>durability</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Set the durability mode of a terminus object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">durability</td><td>the terminus durability mode </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </dd></dl> + +</div> +</div> +<a class="anchor" id="ga8600194fb12e709bb165249996d3d136"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN int pn_terminus_set_dynamic </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> + <td class="paramname"><em>terminus</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>dynamic</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Set the dynamic flag for a terminus object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">dynamic</td><td>the dynamic flag for the terminus </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </dd></dl> + +</div> +</div> +<a class="anchor" id="gace5b1ae5c177b3d072d619567e20c2a3"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN int pn_terminus_set_expiry_policy </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> + <td class="paramname"><em>terminus</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__terminus.html#gab4089b27ee99a348deab776f3d4931f0">pn_expiry_policy_t</a> </td> + <td class="paramname"><em>policy</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Set the expiry policy of a terminus object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">policy</td><td>the expiry policy for the terminus </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </dd></dl> + +</div> +</div> +<a class="anchor" id="gafe5932e60e778827a0b6c27e7748a814"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN int pn_terminus_set_timeout </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> + <td class="paramname"><em>terminus</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">pn_seconds_t </td> + <td class="paramname"><em>timeout</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Set the timeout of a terminus object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>the timeout for the terminus </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </dd></dl> + +</div> +</div> +<a class="anchor" id="gafe106dcd053dd04b0fdbc9b40b58e23d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN int pn_terminus_set_type </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> + <td class="paramname"><em>terminus</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__terminus.html#ga3cb9c86d1e2bb024de2658f9def098e7">pn_terminus_type_t</a> </td> + <td class="paramname"><em>type</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Set the type of a terminus object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>the terminus type </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </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__terminus.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-0.15.0/proton/c/api/group__terminus.js b/content/releases/qpid-proton-0.15.0/proton/c/api/group__terminus.js new file mode 100755 index 0000000..8281a30 --- /dev/null +++ b/content/releases/qpid-proton-0.15.0/proton/c/api/group__terminus.js @@ -0,0 +1,45 @@ +var group__terminus = +[ + [ "pn_terminus_t", "group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2", null ], + [ "pn_distribution_mode_t", "group__terminus.html#gac6fb89a5fa96476db51b60f10dc785d0", [ + [ "PN_DIST_MODE_UNSPECIFIED", "group__terminus.html#ggac6fb89a5fa96476db51b60f10dc785d0a74d3ae9ce3ad50e5c5cc71164a2a8aac", null ], + [ "PN_DIST_MODE_COPY", "group__terminus.html#ggac6fb89a5fa96476db51b60f10dc785d0a914fec87d6b3211d5f2eeb780819e523", null ], + [ "PN_DIST_MODE_MOVE", "group__terminus.html#ggac6fb89a5fa96476db51b60f10dc785d0a9e076691930f95f32c850ea01a808b92", null ] + ] ], + [ "pn_durability_t", "group__terminus.html#ga213267363be45848f3299471ea93089b", [ + [ "PN_NONDURABLE", "group__terminus.html#gga213267363be45848f3299471ea93089ba403e259f8d858d6a12f463dbd7e5dc6b", null ], + [ "PN_CONFIGURATION", "group__terminus.html#gga213267363be45848f3299471ea93089ba95b1d5b60c47569e0358258305de1d58", null ], + [ "PN_DELIVERIES", "group__terminus.html#gga213267363be45848f3299471ea93089bac2e0a9f773faf4ee8fd43f77855933d2", null ] + ] ], + [ "pn_expiry_policy_t", "group__terminus.html#gab4089b27ee99a348deab776f3d4931f0", [ + [ "PN_EXPIRE_WITH_LINK", "group__terminus.html#ggab4089b27ee99a348deab776f3d4931f0ad559c0f96078b8b7d8b84b77354b2391", null ], + [ "PN_EXPIRE_WITH_SESSION", "group__terminus.html#ggab4089b27ee99a348deab776f3d4931f0a02ac8e7dfc45bb4ae66e97624adaca01", null ], + [ "PN_EXPIRE_WITH_CONNECTION", "group__terminus.html#ggab4089b27ee99a348deab776f3d4931f0a188731d2f46e10273d74ae7cedbd5bb5", null ], + [ "PN_EXPIRE_NEVER", "group__terminus.html#ggab4089b27ee99a348deab776f3d4931f0a52bf932997783f578fd29c0a4659c556", null ] + ] ], + [ "pn_terminus_type_t", "group__terminus.html#ga3cb9c86d1e2bb024de2658f9def098e7", [ + [ "PN_UNSPECIFIED", "group__terminus.html#gga3cb9c86d1e2bb024de2658f9def098e7accee852b0d609496d88d91d683784216", null ], + [ "PN_SOURCE", "group__terminus.html#gga3cb9c86d1e2bb024de2658f9def098e7a7fd70c48647a2edc5167bce3ade8f2f0", null ], + [ "PN_TARGET", "group__terminus.html#gga3cb9c86d1e2bb024de2658f9def098e7a760e5ca8afcbee9f43a72cfd09b7c54e", null ], + [ "PN_COORDINATOR", "group__terminus.html#gga3cb9c86d1e2bb024de2658f9def098e7a75bb94f03973a939835d98e9b1999aae", null ] + ] ], + [ "pn_terminus_capabilities", "group__terminus.html#ga31429fed465bdf8c393196f3dfbf4d2f", null ], + [ "pn_terminus_copy", "group__terminus.html#gabf6c265040dd7233bddbb4efcf314999", null ], + [ "pn_terminus_filter", "group__terminus.html#ga91a7d1ca890c3171220ea7d1eaa57b86", null ], + [ "pn_terminus_get_address", "group__terminus.html#gaf7ce75acdf855eaf7637abcd4131d6b3", null ], + [ "pn_terminus_get_distribution_mode", "group__terminus.html#ga575d3d03d45453bce10392b120e35a50", null ], + [ "pn_terminus_get_durability", "group__terminus.html#gabaa9f17714567505f194d6fbb3ad785c", null ], + [ "pn_terminus_get_expiry_policy", "group__terminus.html#ga4ea6ce82047f3fab63e70a29b74b5fcf", null ], + [ "pn_terminus_get_timeout", "group__terminus.html#gadf6f4e80e36b70803acab67b12a35a14", null ], + [ "pn_terminus_get_type", "group__terminus.html#gaaef31d25eb233aace7be1e0174fbf55e", null ], + [ "pn_terminus_is_dynamic", "group__terminus.html#ga66ac0a6b680d16588f6e95e0804c64f5", null ], + [ "pn_terminus_outcomes", "group__terminus.html#gab27e5d1e2e0d1610ff9d9819d89f4bed", null ], + [ "pn_terminus_properties", "group__terminus.html#ga166a84223f2e17a8d122bf19e5ebe0e3", null ], + [ "pn_terminus_set_address", "group__terminus.html#gae55a8e0c226942c3ce122fa1e453148c", null ], + [ "pn_terminus_set_distribution_mode", "group__terminus.html#gad4abc043078d14aeeaef3116500d62e1", null ], + [ "pn_terminus_set_durability", "group__terminus.html#ga386428e4d1742649fffa112f231a3bf8", null ], + [ "pn_terminus_set_dynamic", "group__terminus.html#ga8600194fb12e709bb165249996d3d136", null ], + [ "pn_terminus_set_expiry_policy", "group__terminus.html#gace5b1ae5c177b3d072d619567e20c2a3", null ], + [ "pn_terminus_set_timeout", "group__terminus.html#gafe5932e60e778827a0b6c27e7748a814", null ], + [ "pn_terminus_set_type", "group__terminus.html#gafe106dcd053dd04b0fdbc9b40b58e23d", 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
