| <!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: reconnect_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_1reconnect__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_1reconnect__options-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">reconnect_options</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><b>Unsettled API</b> - Options for reconnect and failover after connection loss. |
| <a href="classproton_1_1reconnect__options.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="reconnect__options_8hpp_source.html">reconnect_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:ac327dafeb06728192df6cb94dde35edc"><td class="memItemLeft" align="right" valign="top"><a id="ac327dafeb06728192df6cb94dde35edc"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1reconnect__options.html#ac327dafeb06728192df6cb94dde35edc">reconnect_options</a> ()</td></tr> |
| <tr class="memdesc:ac327dafeb06728192df6cb94dde35edc"><td class="mdescLeft"> </td><td class="mdescRight">Create an empty set of options. <br /></td></tr> |
| <tr class="separator:ac327dafeb06728192df6cb94dde35edc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aef23a4a6b4f399f86ba458e855e0ca08"><td class="memItemLeft" align="right" valign="top"><a id="aef23a4a6b4f399f86ba458e855e0ca08"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1reconnect__options.html#aef23a4a6b4f399f86ba458e855e0ca08">reconnect_options</a> (const <a class="el" href="classproton_1_1reconnect__options.html">reconnect_options</a> &)</td></tr> |
| <tr class="memdesc:aef23a4a6b4f399f86ba458e855e0ca08"><td class="mdescLeft"> </td><td class="mdescRight">Copy options. <br /></td></tr> |
| <tr class="separator:aef23a4a6b4f399f86ba458e855e0ca08"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aea298c3d006e10b7da6608591949b270"><td class="memItemLeft" align="right" valign="top"><a id="aea298c3d006e10b7da6608591949b270"></a> |
| <a class="el" href="classproton_1_1reconnect__options.html">reconnect_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1reconnect__options.html#aea298c3d006e10b7da6608591949b270">operator=</a> (const <a class="el" href="classproton_1_1reconnect__options.html">reconnect_options</a> &)</td></tr> |
| <tr class="memdesc:aea298c3d006e10b7da6608591949b270"><td class="mdescLeft"> </td><td class="mdescRight">Copy options. <br /></td></tr> |
| <tr class="separator:aea298c3d006e10b7da6608591949b270"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a700d91bfa7a95ee851dd94eda092721b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1reconnect__options.html">reconnect_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1reconnect__options.html#a700d91bfa7a95ee851dd94eda092721b">delay</a> (<a class="el" href="classproton_1_1duration.html">duration</a>)</td></tr> |
| <tr class="memdesc:a700d91bfa7a95ee851dd94eda092721b"><td class="mdescLeft"> </td><td class="mdescRight">The base value for recurring delays. <a href="classproton_1_1reconnect__options.html#a700d91bfa7a95ee851dd94eda092721b">More...</a><br /></td></tr> |
| <tr class="separator:a700d91bfa7a95ee851dd94eda092721b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8456389a8174cf6d2ae2550e05e3e650"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1reconnect__options.html">reconnect_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1reconnect__options.html#a8456389a8174cf6d2ae2550e05e3e650">delay_multiplier</a> (float)</td></tr> |
| <tr class="memdesc:a8456389a8174cf6d2ae2550e05e3e650"><td class="mdescLeft"> </td><td class="mdescRight">The scaling multiplier for successive reconnect delays. <a href="classproton_1_1reconnect__options.html#a8456389a8174cf6d2ae2550e05e3e650">More...</a><br /></td></tr> |
| <tr class="separator:a8456389a8174cf6d2ae2550e05e3e650"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7840ff5254abe6996b44e3906cf1445b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1reconnect__options.html">reconnect_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1reconnect__options.html#a7840ff5254abe6996b44e3906cf1445b">max_delay</a> (<a class="el" href="classproton_1_1duration.html">duration</a>)</td></tr> |
| <tr class="memdesc:a7840ff5254abe6996b44e3906cf1445b"><td class="mdescLeft"> </td><td class="mdescRight">The maximum delay between successive connect attempts. <a href="classproton_1_1reconnect__options.html#a7840ff5254abe6996b44e3906cf1445b">More...</a><br /></td></tr> |
| <tr class="separator:a7840ff5254abe6996b44e3906cf1445b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7e6b1a75735da02638374a317a232428"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1reconnect__options.html">reconnect_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1reconnect__options.html#a7e6b1a75735da02638374a317a232428">max_attempts</a> (int)</td></tr> |
| <tr class="memdesc:a7e6b1a75735da02638374a317a232428"><td class="mdescLeft"> </td><td class="mdescRight">The maximum number of reconnect attempts. <a href="classproton_1_1reconnect__options.html#a7e6b1a75735da02638374a317a232428">More...</a><br /></td></tr> |
| <tr class="separator:a7e6b1a75735da02638374a317a232428"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a342bae3e139b785604e4ed0c7599a068"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1reconnect__options.html">reconnect_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1reconnect__options.html#a342bae3e139b785604e4ed0c7599a068">failover_urls</a> (const std::vector< std::string > &conn_urls)</td></tr> |
| <tr class="memdesc:a342bae3e139b785604e4ed0c7599a068"><td class="mdescLeft"> </td><td class="mdescRight">Deprecated - use <a class="el" href="classproton_1_1connection__options.html#abcfa30511c5b02318105ff214ea6eab7" title="Unsettled API - Set Fail-over URLs.">connection_options::failover_urls</a> Alternative connection URLs used for failover. <a href="classproton_1_1reconnect__options.html#a342bae3e139b785604e4ed0c7599a068">More...</a><br /></td></tr> |
| <tr class="separator:a342bae3e139b785604e4ed0c7599a068"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p><b>Unsettled API</b> - Options for reconnect and failover after connection loss. </p> |
| <p>These options determine a series of delays to coordinate reconnection attempts. They may be open-ended or limited in time. They may be evenly spaced or increasing at an exponential rate.</p> |
| <p>Normal value semantics: copy or assign creates a separate copy of the options.</p> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="classproton_1_1messaging__handler.html" title="Handler for Proton messaging events.">messaging_handler</a>, <a class="el" href="classproton_1_1connection__options.html#ad053f0ac823eefd100731c1b5248e7e8" title="Unsettled API - Set reconnect timing options.">connection_options::reconnect()</a> </dd></dl> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a700d91bfa7a95ee851dd94eda092721b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a700d91bfa7a95ee851dd94eda092721b">◆ </a></span>delay()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classproton_1_1reconnect__options.html">reconnect_options</a>& delay </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 base value for recurring delays. </p> |
| <p>The default is 10 milliseconds. </p> |
| |
| </div> |
| </div> |
| <a id="a8456389a8174cf6d2ae2550e05e3e650"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8456389a8174cf6d2ae2550e05e3e650">◆ </a></span>delay_multiplier()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classproton_1_1reconnect__options.html">reconnect_options</a>& delay_multiplier </td> |
| <td>(</td> |
| <td class="paramtype">float </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The scaling multiplier for successive reconnect delays. </p> |
| <p>The default is 2.0. </p> |
| |
| </div> |
| </div> |
| <a id="a7840ff5254abe6996b44e3906cf1445b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7840ff5254abe6996b44e3906cf1445b">◆ </a></span>max_delay()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classproton_1_1reconnect__options.html">reconnect_options</a>& max_delay </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 maximum delay between successive connect attempts. </p> |
| <p>The default <a class="el" href="classproton_1_1duration.html#acebdd3ee364870f89665ca128e97a4d7" title="Wait forever.">duration::FOREVER</a>, meaning no limit. </p> |
| |
| </div> |
| </div> |
| <a id="a7e6b1a75735da02638374a317a232428"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7e6b1a75735da02638374a317a232428">◆ </a></span>max_attempts()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classproton_1_1reconnect__options.html">reconnect_options</a>& max_attempts </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The maximum number of reconnect attempts. </p> |
| <p>The default is 0, meaning no limit. </p> |
| |
| </div> |
| </div> |
| <a id="a342bae3e139b785604e4ed0c7599a068"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a342bae3e139b785604e4ed0c7599a068">◆ </a></span>failover_urls()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classproton_1_1reconnect__options.html">reconnect_options</a>& failover_urls </td> |
| <td>(</td> |
| <td class="paramtype">const std::vector< std::string > & </td> |
| <td class="paramname"><em>conn_urls</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Deprecated - use <a class="el" href="classproton_1_1connection__options.html#abcfa30511c5b02318105ff214ea6eab7" title="Unsettled API - Set Fail-over URLs.">connection_options::failover_urls</a> Alternative connection URLs used for failover. </p> |
| <p>There are none by default. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>proton/<a class="el" href="reconnect__options_8hpp_source.html">reconnect_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_1reconnect__options.html">reconnect_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> |
