blob: b4b782976a8440d72be8bcec6b04f811cd7e9145 [file] [log] [blame]
<!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: source_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&amp;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
&#160;<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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classproton_1_1source__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> &#124;
<a href="classproton_1_1source__options-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">source_options</div> </div>
</div><!--header-->
<div class="contents">
<p>Options for creating a source node for a sender or receiver.
<a href="classproton_1_1source__options.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="source__options_8hpp_source.html">source_options.hpp</a>&gt;</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:afb2122d3d1a1f504c7cb23ea1093afcf"><td class="memItemLeft" align="right" valign="top"><a id="afb2122d3d1a1f504c7cb23ea1093afcf"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1source__options.html#afb2122d3d1a1f504c7cb23ea1093afcf">source_options</a> ()</td></tr>
<tr class="memdesc:afb2122d3d1a1f504c7cb23ea1093afcf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an empty set of options. <br /></td></tr>
<tr class="separator:afb2122d3d1a1f504c7cb23ea1093afcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d2323580261c3bce5c41cb93d72bff9"><td class="memItemLeft" align="right" valign="top"><a id="a1d2323580261c3bce5c41cb93d72bff9"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1source__options.html#a1d2323580261c3bce5c41cb93d72bff9">source_options</a> (const <a class="el" href="classproton_1_1source__options.html">source_options</a> &amp;)</td></tr>
<tr class="memdesc:a1d2323580261c3bce5c41cb93d72bff9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy options. <br /></td></tr>
<tr class="separator:a1d2323580261c3bce5c41cb93d72bff9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c7e157cd06e40dd7fd243fcb47297be"><td class="memItemLeft" align="right" valign="top"><a id="a4c7e157cd06e40dd7fd243fcb47297be"></a>
<a class="el" href="classproton_1_1source__options.html">source_options</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1source__options.html#a4c7e157cd06e40dd7fd243fcb47297be">operator=</a> (const <a class="el" href="classproton_1_1source__options.html">source_options</a> &amp;)</td></tr>
<tr class="memdesc:a4c7e157cd06e40dd7fd243fcb47297be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy options. <br /></td></tr>
<tr class="separator:a4c7e157cd06e40dd7fd243fcb47297be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36fa9e64134459cfe70707e0439ba850"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1source__options.html">source_options</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1source__options.html#a36fa9e64134459cfe70707e0439ba850">address</a> (const std::string &amp;)</td></tr>
<tr class="memdesc:a36fa9e64134459cfe70707e0439ba850"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the address for the source. <a href="classproton_1_1source__options.html#a36fa9e64134459cfe70707e0439ba850">More...</a><br /></td></tr>
<tr class="separator:a36fa9e64134459cfe70707e0439ba850"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab491bddac8a47b9478c748f43ab583d7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1source__options.html">source_options</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1source__options.html#ab491bddac8a47b9478c748f43ab583d7">dynamic</a> (bool)</td></tr>
<tr class="memdesc:ab491bddac8a47b9478c748f43ab583d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request that a node be dynamically created by the remote peer. <a href="classproton_1_1source__options.html#ab491bddac8a47b9478c748f43ab583d7">More...</a><br /></td></tr>
<tr class="separator:ab491bddac8a47b9478c748f43ab583d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5b5466b8ec3d24975fccb7f394fec38"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1source__options.html">source_options</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1source__options.html#af5b5466b8ec3d24975fccb7f394fec38">anonymous</a> (bool)</td></tr>
<tr class="memdesc:af5b5466b8ec3d24975fccb7f394fec38"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request an anonymous node on the remote peer. <a href="classproton_1_1source__options.html#af5b5466b8ec3d24975fccb7f394fec38">More...</a><br /></td></tr>
<tr class="separator:af5b5466b8ec3d24975fccb7f394fec38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41ffaf202d22b3276c15bfcf5b5c3ed6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1source__options.html">source_options</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1source__options.html#a41ffaf202d22b3276c15bfcf5b5c3ed6">distribution_mode</a> (enum <a class="el" href="classproton_1_1source.html#ad049690d03cac384636e0c2055726089">source::distribution_mode</a>)</td></tr>
<tr class="memdesc:a41ffaf202d22b3276c15bfcf5b5c3ed6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Control whether messages are browsed or consumed. <a href="classproton_1_1source__options.html#a41ffaf202d22b3276c15bfcf5b5c3ed6">More...</a><br /></td></tr>
<tr class="separator:a41ffaf202d22b3276c15bfcf5b5c3ed6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89176218ec0f2754c6499935368627ab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1source__options.html">source_options</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1source__options.html#a89176218ec0f2754c6499935368627ab">durability_mode</a> (enum <a class="el" href="classproton_1_1source.html#a61db0571ab7d1a29ad77549ff99d6b3d">source::durability_mode</a>)</td></tr>
<tr class="memdesc:a89176218ec0f2754c6499935368627ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Control the persistence of the source node. <a href="classproton_1_1source__options.html#a89176218ec0f2754c6499935368627ab">More...</a><br /></td></tr>
<tr class="separator:a89176218ec0f2754c6499935368627ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5fca9a55327631935b124badfebea989"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1source__options.html">source_options</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1source__options.html#a5fca9a55327631935b124badfebea989">timeout</a> (<a class="el" href="classproton_1_1duration.html">duration</a>)</td></tr>
<tr class="memdesc:a5fca9a55327631935b124badfebea989"><td class="mdescLeft">&#160;</td><td class="mdescRight">The expiry period after which the source is discarded. <a href="classproton_1_1source__options.html#a5fca9a55327631935b124badfebea989">More...</a><br /></td></tr>
<tr class="separator:a5fca9a55327631935b124badfebea989"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad9e94ccdd35ae9bd3cfd730d5749760"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1source__options.html">source_options</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1source__options.html#aad9e94ccdd35ae9bd3cfd730d5749760">expiry_policy</a> (enum <a class="el" href="classproton_1_1source.html#a348690a43df146eca928a8c06034a1eb">source::expiry_policy</a>)</td></tr>
<tr class="memdesc:aad9e94ccdd35ae9bd3cfd730d5749760"><td class="mdescLeft">&#160;</td><td class="mdescRight">Control when the clock for expiration begins. <a href="classproton_1_1source__options.html#aad9e94ccdd35ae9bd3cfd730d5749760">More...</a><br /></td></tr>
<tr class="separator:aad9e94ccdd35ae9bd3cfd730d5749760"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a38c4697708d223e8163d301e92f6af"><td class="memItemLeft" align="right" valign="top"><a id="a9a38c4697708d223e8163d301e92f6af"></a>
<a class="el" href="classproton_1_1source__options.html">source_options</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1source__options.html#a9a38c4697708d223e8163d301e92f6af">filters</a> (const <a class="el" href="classproton_1_1source.html#ad5af497ef0602d13b06773c910994fd7">source::filter_map</a> &amp;)</td></tr>
<tr class="memdesc:a9a38c4697708d223e8163d301e92f6af"><td class="mdescLeft">&#160;</td><td class="mdescRight"><b>Unsettled API</b> - Specify a filter mechanism on the source that restricts message flow to a subset of the available messages. <br /></td></tr>
<tr class="separator:a9a38c4697708d223e8163d301e92f6af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeaddb5ce3dec75cc6e55f3249adfe454"><td class="memItemLeft" align="right" valign="top"><a id="aeaddb5ce3dec75cc6e55f3249adfe454"></a>
<a class="el" href="classproton_1_1source__options.html">source_options</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1source__options.html#aeaddb5ce3dec75cc6e55f3249adfe454">capabilities</a> (const std::vector&lt; <a class="el" href="classproton_1_1symbol.html">symbol</a> &gt; &amp;)</td></tr>
<tr class="memdesc:aeaddb5ce3dec75cc6e55f3249adfe454"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extension capabilities that are supported/requested. <br /></td></tr>
<tr class="separator:aeaddb5ce3dec75cc6e55f3249adfe454"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Options for creating a source 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>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="broker_8cpp-example.html#_a12">broker.cpp</a>, <a class="el" href="client_8cpp-example.html#_a1">client.cpp</a>, <a class="el" href="server_direct_8cpp-example.html#_a13">server_direct.cpp</a>, and <a class="el" href="service_bus_8cpp-example.html#_a0">service_bus.cpp</a>.</dd>
</dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a36fa9e64134459cfe70707e0439ba850"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36fa9e64134459cfe70707e0439ba850">&#9670;&nbsp;</a></span>address()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classproton_1_1source__options.html">source_options</a>&amp; address </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the address for the source. </p>
<p>It is unset by default. The address is ignored if <a class="el" href="classproton_1_1source__options.html#ab491bddac8a47b9478c748f43ab583d7" title="Request that a node be dynamically created by the remote peer.">dynamic()</a> is true. </p>
</div>
</div>
<a id="ab491bddac8a47b9478c748f43ab583d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab491bddac8a47b9478c748f43ab583d7">&#9670;&nbsp;</a></span>dynamic()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classproton_1_1source__options.html">source_options</a>&amp; dynamic </td>
<td>(</td>
<td class="paramtype">bool&#160;</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 source <a class="el" href="classproton_1_1source__options.html#a36fa9e64134459cfe70707e0439ba850" title="Set the address for the source.">address()</a> is ignored. </p>
</div>
</div>
<a id="af5b5466b8ec3d24975fccb7f394fec38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5b5466b8ec3d24975fccb7f394fec38">&#9670;&nbsp;</a></span>anonymous()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classproton_1_1source__options.html">source_options</a>&amp; anonymous </td>
<td>(</td>
<td class="paramtype">bool&#160;</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_1source__options.html#a36fa9e64134459cfe70707e0439ba850" title="Set the address for the source.">address()</a> is ignored if true. </p>
</div>
</div>
<a id="a41ffaf202d22b3276c15bfcf5b5c3ed6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41ffaf202d22b3276c15bfcf5b5c3ed6">&#9670;&nbsp;</a></span>distribution_mode()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classproton_1_1source__options.html">source_options</a>&amp; distribution_mode </td>
<td>(</td>
<td class="paramtype">enum <a class="el" href="classproton_1_1source.html#ad049690d03cac384636e0c2055726089">source::distribution_mode</a>&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Control whether messages are browsed or consumed. </p>
<p>The default is <a class="el" href="classproton_1_1source.html#ad049690d03cac384636e0c2055726089aed3ef32890b6da0919b57254c5206c62" title="Once transferred, the message is unavailable to other links.">source::MOVE</a>, meaning consumed. </p>
</div>
</div>
<a id="a89176218ec0f2754c6499935368627ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89176218ec0f2754c6499935368627ab">&#9670;&nbsp;</a></span>durability_mode()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classproton_1_1source__options.html">source_options</a>&amp; durability_mode </td>
<td>(</td>
<td class="paramtype">enum <a class="el" href="classproton_1_1source.html#a61db0571ab7d1a29ad77549ff99d6b3d">source::durability_mode</a>&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Control the persistence of the source node. </p>
<p>The default is <a class="el" href="classproton_1_1terminus.html#a61db0571ab7d1a29ad77549ff99d6b3dafdced71ad3dc05c5221439eddc3573e8" title="No persistence.">source::NONDURABLE</a>, meaning non-persistent. </p>
</div>
</div>
<a id="a5fca9a55327631935b124badfebea989"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5fca9a55327631935b124badfebea989">&#9670;&nbsp;</a></span>timeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classproton_1_1source__options.html">source_options</a>&amp; timeout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classproton_1_1duration.html">duration</a>&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The expiry period after which the source is discarded. </p>
<p>The default is no timeout. </p>
</div>
</div>
<a id="aad9e94ccdd35ae9bd3cfd730d5749760"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad9e94ccdd35ae9bd3cfd730d5749760">&#9670;&nbsp;</a></span>expiry_policy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classproton_1_1source__options.html">source_options</a>&amp; expiry_policy </td>
<td>(</td>
<td class="paramtype">enum <a class="el" href="classproton_1_1source.html#a348690a43df146eca928a8c06034a1eb">source::expiry_policy</a>&#160;</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.">source::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="source__options_8hpp_source.html">source_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_1source__options.html">source_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>