| <!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: target_options</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_1target__options.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-methods">Public Member Functions</a> | |
| <a href="classproton_1_1target__options-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">target_options</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Options for creating a target node for a sender or receiver. |
| <a href="classproton_1_1target__options.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="target__options_8hpp_source.html">target_options.hpp</a>></code></p> |
| <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:add127463954d31c61475058fe14aef52"><td class="memItemLeft" align="right" valign="top"><a id="add127463954d31c61475058fe14aef52"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1target__options.html#add127463954d31c61475058fe14aef52">target_options</a> ()</td></tr> |
| <tr class="memdesc:add127463954d31c61475058fe14aef52"><td class="mdescLeft"> </td><td class="mdescRight">Create an empty set of options. <br /></td></tr> |
| <tr class="separator:add127463954d31c61475058fe14aef52"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a19876222bb570ce8369d6024499faf05"><td class="memItemLeft" align="right" valign="top"><a id="a19876222bb570ce8369d6024499faf05"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1target__options.html#a19876222bb570ce8369d6024499faf05">target_options</a> (const <a class="el" href="classproton_1_1target__options.html">target_options</a> &)</td></tr> |
| <tr class="memdesc:a19876222bb570ce8369d6024499faf05"><td class="mdescLeft"> </td><td class="mdescRight">Copy options. <br /></td></tr> |
| <tr class="separator:a19876222bb570ce8369d6024499faf05"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa7c2b9b076f3d98fa3bc67d3bd4fcffd"><td class="memItemLeft" align="right" valign="top"><a id="aa7c2b9b076f3d98fa3bc67d3bd4fcffd"></a> |
| <a class="el" href="classproton_1_1target__options.html">target_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1target__options.html#aa7c2b9b076f3d98fa3bc67d3bd4fcffd">operator=</a> (const <a class="el" href="classproton_1_1target__options.html">target_options</a> &)</td></tr> |
| <tr class="memdesc:aa7c2b9b076f3d98fa3bc67d3bd4fcffd"><td class="mdescLeft"> </td><td class="mdescRight">Copy options. <br /></td></tr> |
| <tr class="separator:aa7c2b9b076f3d98fa3bc67d3bd4fcffd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a39a0acbf2c7de97e77df483ca9c4c6a9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1target__options.html">target_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1target__options.html#a39a0acbf2c7de97e77df483ca9c4c6a9">address</a> (const std::string &addr)</td></tr> |
| <tr class="memdesc:a39a0acbf2c7de97e77df483ca9c4c6a9"><td class="mdescLeft"> </td><td class="mdescRight">Set the address for the target. <a href="classproton_1_1target__options.html#a39a0acbf2c7de97e77df483ca9c4c6a9">More...</a><br /></td></tr> |
| <tr class="separator:a39a0acbf2c7de97e77df483ca9c4c6a9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acc2d56132d2a7a0b644429b78ff00756"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1target__options.html">target_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1target__options.html#acc2d56132d2a7a0b644429b78ff00756">dynamic</a> (bool)</td></tr> |
| <tr class="memdesc:acc2d56132d2a7a0b644429b78ff00756"><td class="mdescLeft"> </td><td class="mdescRight">Request that a node be dynamically created by the remote peer. <a href="classproton_1_1target__options.html#acc2d56132d2a7a0b644429b78ff00756">More...</a><br /></td></tr> |
| <tr class="separator:acc2d56132d2a7a0b644429b78ff00756"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5daa885470cf76a7224f5f177a95f70d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1target__options.html">target_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1target__options.html#a5daa885470cf76a7224f5f177a95f70d">anonymous</a> (bool)</td></tr> |
| <tr class="memdesc:a5daa885470cf76a7224f5f177a95f70d"><td class="mdescLeft"> </td><td class="mdescRight">Request an anonymous node on the remote peer. <a href="classproton_1_1target__options.html#a5daa885470cf76a7224f5f177a95f70d">More...</a><br /></td></tr> |
| <tr class="separator:a5daa885470cf76a7224f5f177a95f70d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8ebe0e28560c7873712674314ac9547d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1target__options.html">target_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1target__options.html#a8ebe0e28560c7873712674314ac9547d">durability_mode</a> (enum <a class="el" href="classproton_1_1target.html#a61db0571ab7d1a29ad77549ff99d6b3d">target::durability_mode</a>)</td></tr> |
| <tr class="memdesc:a8ebe0e28560c7873712674314ac9547d"><td class="mdescLeft"> </td><td class="mdescRight">Control the persistence of the target node. <a href="classproton_1_1target__options.html#a8ebe0e28560c7873712674314ac9547d">More...</a><br /></td></tr> |
| <tr class="separator:a8ebe0e28560c7873712674314ac9547d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a14a86cafc12d543ad6f9c3be88fbd7b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1target__options.html">target_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1target__options.html#a14a86cafc12d543ad6f9c3be88fbd7b6">timeout</a> (<a class="el" href="classproton_1_1duration.html">duration</a>)</td></tr> |
| <tr class="memdesc:a14a86cafc12d543ad6f9c3be88fbd7b6"><td class="mdescLeft"> </td><td class="mdescRight">The expiry period after which the target is discarded. <a href="classproton_1_1target__options.html#a14a86cafc12d543ad6f9c3be88fbd7b6">More...</a><br /></td></tr> |
| <tr class="separator:a14a86cafc12d543ad6f9c3be88fbd7b6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3ee55474d84d67e826dc56f40b848b5b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1target__options.html">target_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1target__options.html#a3ee55474d84d67e826dc56f40b848b5b">expiry_policy</a> (enum <a class="el" href="classproton_1_1target.html#a348690a43df146eca928a8c06034a1eb">target::expiry_policy</a>)</td></tr> |
| <tr class="memdesc:a3ee55474d84d67e826dc56f40b848b5b"><td class="mdescLeft"> </td><td class="mdescRight">Control when the clock for expiration begins. <a href="classproton_1_1target__options.html#a3ee55474d84d67e826dc56f40b848b5b">More...</a><br /></td></tr> |
| <tr class="separator:a3ee55474d84d67e826dc56f40b848b5b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aec90fa88e34bccd5a121baa6c7e9e95a"><td class="memItemLeft" align="right" valign="top"><a id="aec90fa88e34bccd5a121baa6c7e9e95a"></a> |
| <a class="el" href="classproton_1_1target__options.html">target_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1target__options.html#aec90fa88e34bccd5a121baa6c7e9e95a">capabilities</a> (const std::vector< <a class="el" href="classproton_1_1symbol.html">symbol</a> > &)</td></tr> |
| <tr class="memdesc:aec90fa88e34bccd5a121baa6c7e9e95a"><td class="mdescLeft"> </td><td class="mdescRight">Extension capabilities that are supported/requested. <br /></td></tr> |
| <tr class="separator:aec90fa88e34bccd5a121baa6c7e9e95a"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Options for creating a target node for a sender or receiver. </p> |
| <p>Options can be "chained". For more information see <a class="el" href="classproton_1_1connection__options.html">proton::connection_options</a>.</p> |
| <p>Normal value semantics: copy or assign creates a separate copy of the options. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a39a0acbf2c7de97e77df483ca9c4c6a9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a39a0acbf2c7de97e77df483ca9c4c6a9">◆ </a></span>address()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classproton_1_1target__options.html">target_options</a>& address </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>addr</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set the address for the target. </p> |
| <p>It is unset by default. The address is ignored if <a class="el" href="classproton_1_1target__options.html#acc2d56132d2a7a0b644429b78ff00756" title="Request that a node be dynamically created by the remote peer.">dynamic()</a> is true. </p> |
| |
| </div> |
| </div> |
| <a id="acc2d56132d2a7a0b644429b78ff00756"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acc2d56132d2a7a0b644429b78ff00756">◆ </a></span>dynamic()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classproton_1_1target__options.html">target_options</a>& dynamic </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Request that a node be dynamically created by the remote peer. </p> |
| <p>The default is false. Any specified target <a class="el" href="classproton_1_1target__options.html#a39a0acbf2c7de97e77df483ca9c4c6a9" title="Set the address for the target.">address()</a> is ignored if true. </p> |
| |
| </div> |
| </div> |
| <a id="a5daa885470cf76a7224f5f177a95f70d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5daa885470cf76a7224f5f177a95f70d">◆ </a></span>anonymous()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classproton_1_1target__options.html">target_options</a>& anonymous </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Request an anonymous node on the remote peer. </p> |
| <p>The default is false. Any specified target <a class="el" href="classproton_1_1target__options.html#a39a0acbf2c7de97e77df483ca9c4c6a9" title="Set the address for the target.">address()</a> is ignored if true. </p> |
| |
| </div> |
| </div> |
| <a id="a8ebe0e28560c7873712674314ac9547d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8ebe0e28560c7873712674314ac9547d">◆ </a></span>durability_mode()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classproton_1_1target__options.html">target_options</a>& durability_mode </td> |
| <td>(</td> |
| <td class="paramtype">enum <a class="el" href="classproton_1_1target.html#a61db0571ab7d1a29ad77549ff99d6b3d">target::durability_mode</a> </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Control the persistence of the target node. </p> |
| <p>The default is <a class="el" href="classproton_1_1terminus.html#a61db0571ab7d1a29ad77549ff99d6b3dafdced71ad3dc05c5221439eddc3573e8" title="No persistence.">target::NONDURABLE</a>, meaning non-persistent. </p> |
| |
| </div> |
| </div> |
| <a id="a14a86cafc12d543ad6f9c3be88fbd7b6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a14a86cafc12d543ad6f9c3be88fbd7b6">◆ </a></span>timeout()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classproton_1_1target__options.html">target_options</a>& timeout </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classproton_1_1duration.html">duration</a> </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The expiry period after which the target is discarded. </p> |
| <p>The default is no timeout. </p> |
| |
| </div> |
| </div> |
| <a id="a3ee55474d84d67e826dc56f40b848b5b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3ee55474d84d67e826dc56f40b848b5b">◆ </a></span>expiry_policy()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classproton_1_1target__options.html">target_options</a>& expiry_policy </td> |
| <td>(</td> |
| <td class="paramtype">enum <a class="el" href="classproton_1_1target.html#a348690a43df146eca928a8c06034a1eb">target::expiry_policy</a> </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Control when the clock for expiration begins. </p> |
| <p>The default is <a class="el" href="classproton_1_1terminus.html#a348690a43df146eca928a8c06034a1eba7201cfe403ee6d4b4b717d146e38bee1" title="When the link is closed.">target::LINK_CLOSE</a>. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>proton/<a class="el" href="target__options_8hpp_source.html">target_options.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_1target__options.html">target_options</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> |
