| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.20"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Qpid Proton C++ API: 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="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function() { init_search(); }); |
| /* @license-end */ |
| </script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Qpid Proton C++ API |
|  <span id="projectnumber">0.32.0</span> |
| </div> |
| </td> |
| <td> <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.svg" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a> |
| </span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.20 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('classproton_1_1terminus.html',''); initResizable(); }); |
| /* @license-end */ |
| </script> |
| <div id="doc-content"> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-types">Public Types</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classproton_1_1terminus-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">terminus</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>One end of a link, either a source or a target. |
| <a href="classproton_1_1terminus.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="terminus_8hpp_source.html">terminus.hpp</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for terminus:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classproton_1_1terminus.png" usemap="#terminus_map" alt=""/> |
| <map id="terminus_map" name="terminus_map"> |
| <area href="classproton_1_1source.html" title="A point of origin for messages." alt="source" shape="rect" coords="0,56,59,80"/> |
| <area href="classproton_1_1target.html" title="A destination for messages." alt="target" shape="rect" coords="69,56,128,80"/> |
| </map> |
| </div></div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> |
| Public Types</h2></td></tr> |
| <tr class="memitem:a61db0571ab7d1a29ad77549ff99d6b3d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1terminus.html#a61db0571ab7d1a29ad77549ff99d6b3d">durability_mode</a> { <a class="el" href="classproton_1_1terminus.html#a61db0571ab7d1a29ad77549ff99d6b3dafdced71ad3dc05c5221439eddc3573e8">NONDURABLE</a>, |
| <a class="el" href="classproton_1_1terminus.html#a61db0571ab7d1a29ad77549ff99d6b3da07731dff0bf77faf2dc60a19c925e3c4">CONFIGURATION</a>, |
| <a class="el" href="classproton_1_1terminus.html#a61db0571ab7d1a29ad77549ff99d6b3da9a971a7b3eb61a4e22701f1f4099909f">UNSETTLED_STATE</a> |
| }</td></tr> |
| <tr class="memdesc:a61db0571ab7d1a29ad77549ff99d6b3d"><td class="mdescLeft"> </td><td class="mdescRight">The persistence mode of the source or target. <a href="classproton_1_1terminus.html#a61db0571ab7d1a29ad77549ff99d6b3d">More...</a><br /></td></tr> |
| <tr class="separator:a61db0571ab7d1a29ad77549ff99d6b3d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a348690a43df146eca928a8c06034a1eb"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1terminus.html#a348690a43df146eca928a8c06034a1eb">expiry_policy</a> { <a class="el" href="classproton_1_1terminus.html#a348690a43df146eca928a8c06034a1eba7201cfe403ee6d4b4b717d146e38bee1">LINK_CLOSE</a>, |
| <a class="el" href="classproton_1_1terminus.html#a348690a43df146eca928a8c06034a1ebac028e516a1a662691a25993ab4f86c09">SESSION_CLOSE</a>, |
| <a class="el" href="classproton_1_1terminus.html#a348690a43df146eca928a8c06034a1ebad1b07c50c2dc77892c0254442e206a23">CONNECTION_CLOSE</a>, |
| <a class="el" href="classproton_1_1terminus.html#a348690a43df146eca928a8c06034a1eba3a267f9424d4d555780a8d26209c8118">NEVER</a> |
| }</td></tr> |
| <tr class="memdesc:a348690a43df146eca928a8c06034a1eb"><td class="mdescLeft"> </td><td class="mdescRight">When expiration of the source or target begins. <a href="classproton_1_1terminus.html#a348690a43df146eca928a8c06034a1eb">More...</a><br /></td></tr> |
| <tr class="separator:a348690a43df146eca928a8c06034a1eb"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:afc97dbb9b04812da5be8a41eb9434904"><td class="memItemLeft" align="right" valign="top"><a id="afc97dbb9b04812da5be8a41eb9434904"></a> |
| enum <a class="el" href="classproton_1_1terminus.html#a348690a43df146eca928a8c06034a1eb">expiry_policy</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1terminus.html#afc97dbb9b04812da5be8a41eb9434904">expiry_policy</a> () const</td></tr> |
| <tr class="memdesc:afc97dbb9b04812da5be8a41eb9434904"><td class="mdescLeft"> </td><td class="mdescRight">Get the policy for when expiration begins. <br /></td></tr> |
| <tr class="separator:afc97dbb9b04812da5be8a41eb9434904"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a16d54f985193a3ce6ac69ffe10e8dfb6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1duration.html">duration</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1terminus.html#a16d54f985193a3ce6ac69ffe10e8dfb6">timeout</a> () const</td></tr> |
| <tr class="memdesc:a16d54f985193a3ce6ac69ffe10e8dfb6"><td class="mdescLeft"> </td><td class="mdescRight">The period after which the source is discarded on expiry. <a href="classproton_1_1terminus.html#a16d54f985193a3ce6ac69ffe10e8dfb6">More...</a><br /></td></tr> |
| <tr class="separator:a16d54f985193a3ce6ac69ffe10e8dfb6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aeb6439d6ea5d274a59dd8e90d97f31d8"><td class="memItemLeft" align="right" valign="top"><a id="aeb6439d6ea5d274a59dd8e90d97f31d8"></a> |
| enum <a class="el" href="classproton_1_1terminus.html#a61db0571ab7d1a29ad77549ff99d6b3d">durability_mode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1terminus.html#aeb6439d6ea5d274a59dd8e90d97f31d8">durability_mode</a> ()</td></tr> |
| <tr class="memdesc:aeb6439d6ea5d274a59dd8e90d97f31d8"><td class="mdescLeft"> </td><td class="mdescRight">Get the durability flag. <br /></td></tr> |
| <tr class="separator:aeb6439d6ea5d274a59dd8e90d97f31d8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adcc4ef24adb8478230018c519aa636ec"><td class="memItemLeft" align="right" valign="top"><a id="adcc4ef24adb8478230018c519aa636ec"></a> |
| bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1terminus.html#adcc4ef24adb8478230018c519aa636ec">dynamic</a> () const</td></tr> |
| <tr class="memdesc:adcc4ef24adb8478230018c519aa636ec"><td class="mdescLeft"> </td><td class="mdescRight">True if the remote node is created dynamically. <br /></td></tr> |
| <tr class="separator:adcc4ef24adb8478230018c519aa636ec"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6a20cc0c11ce5a1e369fdd0a51f992f5"><td class="memItemLeft" align="right" valign="top"><a id="a6a20cc0c11ce5a1e369fdd0a51f992f5"></a> |
| bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1terminus.html#a6a20cc0c11ce5a1e369fdd0a51f992f5">anonymous</a> () const</td></tr> |
| <tr class="memdesc:a6a20cc0c11ce5a1e369fdd0a51f992f5"><td class="mdescLeft"> </td><td class="mdescRight">True if the remote node is an anonymous-relay. <br /></td></tr> |
| <tr class="separator:a6a20cc0c11ce5a1e369fdd0a51f992f5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab503c82e36aa618e6c6fb34feaad57b8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1value.html">value</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1terminus.html#ab503c82e36aa618e6c6fb34feaad57b8">node_properties</a> () const</td></tr> |
| <tr class="memdesc:ab503c82e36aa618e6c6fb34feaad57b8"><td class="mdescLeft"> </td><td class="mdescRight">Obtain a reference to the AMQP dynamic node properties for the terminus. <a href="classproton_1_1terminus.html#ab503c82e36aa618e6c6fb34feaad57b8">More...</a><br /></td></tr> |
| <tr class="separator:ab503c82e36aa618e6c6fb34feaad57b8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1c6bf68ea1dcbd3b2a0897adb628c1ee"><td class="memItemLeft" align="right" valign="top"><a id="a1c6bf68ea1dcbd3b2a0897adb628c1ee"></a> |
| std::vector< <a class="el" href="classproton_1_1symbol.html">symbol</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1terminus.html#a1c6bf68ea1dcbd3b2a0897adb628c1ee">capabilities</a> () const</td></tr> |
| <tr class="memdesc:a1c6bf68ea1dcbd3b2a0897adb628c1ee"><td class="mdescLeft"> </td><td class="mdescRight">Extension capabilities that are supported/requested. <br /></td></tr> |
| <tr class="separator:a1c6bf68ea1dcbd3b2a0897adb628c1ee"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>One end of a link, either a source or a target. </p> |
| <p>The source terminus is where messages originate; the target terminus is where they go.</p> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="classproton_1_1link.html" title="A named channel for sending or receiving messages.">proton::link</a> </dd></dl> |
| </div><h2 class="groupheader">Member Enumeration Documentation</h2> |
| <a id="a61db0571ab7d1a29ad77549ff99d6b3d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a61db0571ab7d1a29ad77549ff99d6b3d">◆ </a></span>durability_mode</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum <a class="el" href="classproton_1_1terminus.html#a61db0571ab7d1a29ad77549ff99d6b3d">durability_mode</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The persistence mode of the source or target. </p> |
| <table class="fieldtable"> |
| <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a61db0571ab7d1a29ad77549ff99d6b3dafdced71ad3dc05c5221439eddc3573e8"></a>NONDURABLE </td><td class="fielddoc"><p>No persistence. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a61db0571ab7d1a29ad77549ff99d6b3da07731dff0bf77faf2dc60a19c925e3c4"></a>CONFIGURATION </td><td class="fielddoc"><p>Only configuration is persisted. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a61db0571ab7d1a29ad77549ff99d6b3da9a971a7b3eb61a4e22701f1f4099909f"></a>UNSETTLED_STATE </td><td class="fielddoc"><p>Configuration and unsettled state are persisted. </p> |
| </td></tr> |
| </table> |
| |
| </div> |
| </div> |
| <a id="a348690a43df146eca928a8c06034a1eb"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a348690a43df146eca928a8c06034a1eb">◆ </a></span>expiry_policy</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum <a class="el" href="classproton_1_1terminus.html#a348690a43df146eca928a8c06034a1eb">expiry_policy</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>When expiration of the source or target begins. </p> |
| <table class="fieldtable"> |
| <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a348690a43df146eca928a8c06034a1eba7201cfe403ee6d4b4b717d146e38bee1"></a>LINK_CLOSE </td><td class="fielddoc"><p>When the link is closed. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a348690a43df146eca928a8c06034a1ebac028e516a1a662691a25993ab4f86c09"></a>SESSION_CLOSE </td><td class="fielddoc"><p>When the containing session is closed. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a348690a43df146eca928a8c06034a1ebad1b07c50c2dc77892c0254442e206a23"></a>CONNECTION_CLOSE </td><td class="fielddoc"><p>When the containing connection is closed. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a348690a43df146eca928a8c06034a1eba3a267f9424d4d555780a8d26209c8118"></a>NEVER </td><td class="fielddoc"><p>The terminus never expires. </p> |
| </td></tr> |
| </table> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a16d54f985193a3ce6ac69ffe10e8dfb6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a16d54f985193a3ce6ac69ffe10e8dfb6">◆ </a></span>timeout()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classproton_1_1duration.html">duration</a> timeout </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The period after which the source is discarded on expiry. </p> |
| <p>The duration is rounded to the nearest second. </p> |
| |
| </div> |
| </div> |
| <a id="ab503c82e36aa618e6c6fb34feaad57b8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab503c82e36aa618e6c6fb34feaad57b8">◆ </a></span>node_properties()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classproton_1_1value.html">value</a> node_properties </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Obtain a reference to the AMQP dynamic node properties for the terminus. </p> |
| <p>See also lifetime_policy. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>proton/<a class="el" href="terminus_8hpp_source.html">terminus.hpp</a></li> |
| </ul> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceproton.html">proton</a></li><li class="navelem"><a class="el" href="classproton_1_1terminus.html">terminus</a></li> |
| <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
