| <!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: proton/reconnect_options.hpp Source File</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('reconnect__options_8hpp_source.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="headertitle"> |
| <div class="title">reconnect_options.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="reconnect__options_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef PROTON_RECONNECT_OPTIONS_HPP</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define PROTON_RECONNECT_OPTIONS_HPP</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/*</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * under the License.</span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "./internal/export.hpp"</span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "./internal/pn_unique_ptr.hpp"</span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="duration_8hpp.html">./duration.hpp</a>"</span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="source_8hpp.html">./source.hpp</a>"</span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <string></span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <vector></span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span><a class="code" href="namespaceproton.html">proton</a> {</div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div> |
| <div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classproton_1_1reconnect__options.html"> 49</a></span> <span class="keyword">class </span><a class="code" href="classproton_1_1reconnect__options.html">reconnect_options</a> {</div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classproton_1_1reconnect__options.html#ac327dafeb06728192df6cb94dde35edc"> 52</a></span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1reconnect__options.html#ac327dafeb06728192df6cb94dde35edc">reconnect_options</a>();</div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div> |
| <div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classproton_1_1reconnect__options.html#aef23a4a6b4f399f86ba458e855e0ca08"> 55</a></span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1reconnect__options.html#aef23a4a6b4f399f86ba458e855e0ca08">reconnect_options</a>(<span class="keyword">const</span> <a class="code" href="classproton_1_1reconnect__options.html">reconnect_options</a>&);</div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  PN_CPP_EXTERN ~<a class="code" href="classproton_1_1reconnect__options.html">reconnect_options</a>();</div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div> |
| <div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classproton_1_1reconnect__options.html#aea298c3d006e10b7da6608591949b270"> 60</a></span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1reconnect__options.html">reconnect_options</a>& <a class="code" href="classproton_1_1reconnect__options.html#aea298c3d006e10b7da6608591949b270">operator=</a>(<span class="keyword">const</span> <a class="code" href="classproton_1_1reconnect__options.html">reconnect_options</a>&);</div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div> |
| <div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classproton_1_1reconnect__options.html#a700d91bfa7a95ee851dd94eda092721b"> 64</a></span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1reconnect__options.html">reconnect_options</a>& <a class="code" href="classproton_1_1reconnect__options.html#a700d91bfa7a95ee851dd94eda092721b">delay</a>(<a class="code" href="classproton_1_1duration.html">duration</a>);</div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  </div> |
| <div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classproton_1_1reconnect__options.html#a8456389a8174cf6d2ae2550e05e3e650"> 68</a></span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1reconnect__options.html">reconnect_options</a>& <a class="code" href="classproton_1_1reconnect__options.html#a8456389a8174cf6d2ae2550e05e3e650">delay_multiplier</a>(<span class="keywordtype">float</span>);</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div> |
| <div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="classproton_1_1reconnect__options.html#a7840ff5254abe6996b44e3906cf1445b"> 72</a></span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1reconnect__options.html">reconnect_options</a>& <a class="code" href="classproton_1_1reconnect__options.html#a7840ff5254abe6996b44e3906cf1445b">max_delay</a>(<a class="code" href="classproton_1_1duration.html">duration</a>);</div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div> |
| <div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="classproton_1_1reconnect__options.html#a7e6b1a75735da02638374a317a232428"> 76</a></span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1reconnect__options.html">reconnect_options</a>& <a class="code" href="classproton_1_1reconnect__options.html#a7e6b1a75735da02638374a317a232428">max_attempts</a>(<span class="keywordtype">int</span>);</div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  </div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  PN_CPP_DEPRECATED(<span class="stringliteral">"use connection_options::failover_urls()"</span>)</div> |
| <div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="classproton_1_1reconnect__options.html#a342bae3e139b785604e4ed0c7599a068"> 82</a></span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1reconnect__options.html">reconnect_options</a>& <a class="code" href="classproton_1_1reconnect__options.html#a342bae3e139b785604e4ed0c7599a068">failover_urls</a>(const std::vector<std::<span class="keywordtype">string</span>>& conn_urls);</div> |
| <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  </div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  private:</div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  class impl;</div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  internal::pn_unique_ptr<impl> impl_;</div> |
| <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  </div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  friend class <a class="code" href="classproton_1_1connection__options.html">connection_options</a>;</div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  friend class <a class="code" href="classproton_1_1container.html">container</a>;</div> |
| <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> };</div> |
| <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  </div> |
| <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> } <span class="comment">// proton</span></div> |
| <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  </div> |
| <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="preprocessor">#endif // PROTON_RECONNECT_OPTIONS_HPP</span></div> |
| </div><!-- fragment --></div><!-- contents --> |
| </div><!-- doc-content --> |
| <div class="ttc" id="asource_8hpp_html"><div class="ttname"><a href="source_8hpp.html">source.hpp</a></div><div class="ttdoc">A point of origin for messages.</div></div> |
| <div class="ttc" id="aclassproton_1_1reconnect__options_html_aef23a4a6b4f399f86ba458e855e0ca08"><div class="ttname"><a href="classproton_1_1reconnect__options.html#aef23a4a6b4f399f86ba458e855e0ca08">proton::reconnect_options::reconnect_options</a></div><div class="ttdeci">reconnect_options(const reconnect_options &)</div><div class="ttdoc">Copy options.</div></div> |
| <div class="ttc" id="aclassproton_1_1container_html"><div class="ttname"><a href="classproton_1_1container.html">proton::container</a></div><div class="ttdoc">A top-level container of connections, sessions, and links.</div><div class="ttdef"><b>Definition:</b> container.hpp:50</div></div> |
| <div class="ttc" id="aclassproton_1_1reconnect__options_html"><div class="ttname"><a href="classproton_1_1reconnect__options.html">proton::reconnect_options</a></div><div class="ttdoc">Unsettled API - Options for reconnect and failover after connection loss.</div><div class="ttdef"><b>Definition:</b> reconnect_options.hpp:49</div></div> |
| <div class="ttc" id="aclassproton_1_1reconnect__options_html_a7e6b1a75735da02638374a317a232428"><div class="ttname"><a href="classproton_1_1reconnect__options.html#a7e6b1a75735da02638374a317a232428">proton::reconnect_options::max_attempts</a></div><div class="ttdeci">reconnect_options & max_attempts(int)</div><div class="ttdoc">The maximum number of reconnect attempts.</div></div> |
| <div class="ttc" id="aclassproton_1_1connection__options_html"><div class="ttname"><a href="classproton_1_1connection__options.html">proton::connection_options</a></div><div class="ttdoc">Options for creating a connection.</div><div class="ttdef"><b>Definition:</b> connection_options.hpp:67</div></div> |
| <div class="ttc" id="aclassproton_1_1duration_html"><div class="ttname"><a href="classproton_1_1duration.html">proton::duration</a></div><div class="ttdoc">A span of time in milliseconds.</div><div class="ttdef"><b>Definition:</b> duration.hpp:39</div></div> |
| <div class="ttc" id="aclassproton_1_1reconnect__options_html_a8456389a8174cf6d2ae2550e05e3e650"><div class="ttname"><a href="classproton_1_1reconnect__options.html#a8456389a8174cf6d2ae2550e05e3e650">proton::reconnect_options::delay_multiplier</a></div><div class="ttdeci">reconnect_options & delay_multiplier(float)</div><div class="ttdoc">The scaling multiplier for successive reconnect delays.</div></div> |
| <div class="ttc" id="aclassproton_1_1reconnect__options_html_ac327dafeb06728192df6cb94dde35edc"><div class="ttname"><a href="classproton_1_1reconnect__options.html#ac327dafeb06728192df6cb94dde35edc">proton::reconnect_options::reconnect_options</a></div><div class="ttdeci">reconnect_options()</div><div class="ttdoc">Create an empty set of options.</div></div> |
| <div class="ttc" id="aclassproton_1_1reconnect__options_html_aea298c3d006e10b7da6608591949b270"><div class="ttname"><a href="classproton_1_1reconnect__options.html#aea298c3d006e10b7da6608591949b270">proton::reconnect_options::operator=</a></div><div class="ttdeci">reconnect_options & operator=(const reconnect_options &)</div><div class="ttdoc">Copy options.</div></div> |
| <div class="ttc" id="aclassproton_1_1reconnect__options_html_a700d91bfa7a95ee851dd94eda092721b"><div class="ttname"><a href="classproton_1_1reconnect__options.html#a700d91bfa7a95ee851dd94eda092721b">proton::reconnect_options::delay</a></div><div class="ttdeci">reconnect_options & delay(duration)</div><div class="ttdoc">The base value for recurring delays.</div></div> |
| <div class="ttc" id="aclassproton_1_1reconnect__options_html_a342bae3e139b785604e4ed0c7599a068"><div class="ttname"><a href="classproton_1_1reconnect__options.html#a342bae3e139b785604e4ed0c7599a068">proton::reconnect_options::failover_urls</a></div><div class="ttdeci">reconnect_options & failover_urls(const std::vector< std::string > &conn_urls)</div><div class="ttdoc">Deprecated - use connection_options::failover_urls Alternative connection URLs used for failover.</div></div> |
| <div class="ttc" id="anamespaceproton_html"><div class="ttname"><a href="namespaceproton.html">proton</a></div><div class="ttdoc">The main Proton namespace.</div><div class="ttdef"><b>Definition:</b> annotation_key.hpp:33</div></div> |
| <div class="ttc" id="aclassproton_1_1reconnect__options_html_a7840ff5254abe6996b44e3906cf1445b"><div class="ttname"><a href="classproton_1_1reconnect__options.html#a7840ff5254abe6996b44e3906cf1445b">proton::reconnect_options::max_delay</a></div><div class="ttdeci">reconnect_options & max_delay(duration)</div><div class="ttdoc">The maximum delay between successive connect attempts.</div></div> |
| <div class="ttc" id="aduration_8hpp_html"><div class="ttname"><a href="duration_8hpp.html">duration.hpp</a></div><div class="ttdoc">A span of time in milliseconds.</div></div> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_3a71568e5d046e5ed52679664c3002a5.html">proton</a></li><li class="navelem"><a class="el" href="reconnect__options_8hpp.html">reconnect_options.hpp</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> |
