Google Git
Sign in
apache / qpid-site / refs/heads/asf-site / . / content / releases / qpid-proton-dotnet-1.0.0-M10 / api / classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html
blob: 26147c9e6f7a44b1a3622a45b70a6eaf9276e9a2 [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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Proton DotNet: Apache.Qpid.Proton.Client.ReconnectOptions Class Reference</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="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>
<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">Proton DotNet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceApache.html">Apache</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid.html">Qpid</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton.html">Proton</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html">Client</a></li><li class="navelem"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html">ReconnectOptions</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Client.ReconnectOptions Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Reconnection options which will control how a connection deals will connection loss and or inability to connect to the host it was provided at create time.
<a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Apache.Qpid.Proton.Client.ReconnectOptions:</div>
<div class="dyncontent">
<div class="center">
<img src="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.png" alt=""/>
</div></div>
<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:abb587ab4e2cf10de5ca529bb6bce792c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#abb587ab4e2cf10de5ca529bb6bce792c">ReconnectOptions</a> ()</td></tr>
<tr class="memdesc:abb587ab4e2cf10de5ca529bb6bce792c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a default reconnect options instance. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#abb587ab4e2cf10de5ca529bb6bce792c">More...</a><br /></td></tr>
<tr class="separator:abb587ab4e2cf10de5ca529bb6bce792c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f4a15af77ae5260df399c0535b031de"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#a1f4a15af77ae5260df399c0535b031de">ReconnectOptions</a> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html">ReconnectOptions</a> other)</td></tr>
<tr class="memdesc:a1f4a15af77ae5260df399c0535b031de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new reconnection options instance whose settings are copied from the instance provided. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#a1f4a15af77ae5260df399c0535b031de">More...</a><br /></td></tr>
<tr class="separator:a1f4a15af77ae5260df399c0535b031de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09e6056cc20fd54b42f407e09ab78581"><td class="memItemLeft" align="right" valign="top">virtual object&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#a09e6056cc20fd54b42f407e09ab78581">Clone</a> ()</td></tr>
<tr class="memdesc:a09e6056cc20fd54b42f407e09ab78581"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clone this options instance, changes to the cloned options are not reflected in this options instance. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#a09e6056cc20fd54b42f407e09ab78581">More...</a><br /></td></tr>
<tr class="separator:a09e6056cc20fd54b42f407e09ab78581"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57324572cfbcb0e03993b9f04e3f104f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html">ReconnectOptions</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#a57324572cfbcb0e03993b9f04e3f104f">AddReconnectLocation</a> (string host, int port)</td></tr>
<tr class="memdesc:a57324572cfbcb0e03993b9f04e3f104f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds the given host and port to the collection of locations where a connection reconnect attempt can be made. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#a57324572cfbcb0e03993b9f04e3f104f">More...</a><br /></td></tr>
<tr class="separator:a57324572cfbcb0e03993b9f04e3f104f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a2337fad3e1dfaa4c182933ac6defcdca"><td class="memItemLeft" align="right" valign="top"><a id="a2337fad3e1dfaa4c182933ac6defcdca"></a>
static readonly bool&#160;</td><td class="memItemRight" valign="bottom"><b>DEFAULT_RECONNECT_ENABLED</b> = false</td></tr>
<tr class="separator:a2337fad3e1dfaa4c182933ac6defcdca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f614fe73e22d0172dc1192d2e125ecb"><td class="memItemLeft" align="right" valign="top"><a id="a2f614fe73e22d0172dc1192d2e125ecb"></a>
static readonly int&#160;</td><td class="memItemRight" valign="bottom"><b>INFINITE</b> = -1</td></tr>
<tr class="separator:a2f614fe73e22d0172dc1192d2e125ecb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adff6b94d58a8aea87065a03d636019c8"><td class="memItemLeft" align="right" valign="top"><a id="adff6b94d58a8aea87065a03d636019c8"></a>
static readonly int&#160;</td><td class="memItemRight" valign="bottom"><b>DEFAULT_WARN_AFTER_RECONNECT_ATTEMPTS</b> = 10</td></tr>
<tr class="separator:adff6b94d58a8aea87065a03d636019c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad82f9e959e594b8b684f6df20e85e054"><td class="memItemLeft" align="right" valign="top"><a id="ad82f9e959e594b8b684f6df20e85e054"></a>
static readonly int&#160;</td><td class="memItemRight" valign="bottom"><b>DEFAULT_RECONNECT_DELAY</b> = 10</td></tr>
<tr class="separator:ad82f9e959e594b8b684f6df20e85e054"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc12e7b0be80c02941204a9afe239c0d"><td class="memItemLeft" align="right" valign="top"><a id="afc12e7b0be80c02941204a9afe239c0d"></a>
static readonly int&#160;</td><td class="memItemRight" valign="bottom"><b>DEFAULT_MAX_RECONNECT_DELAY</b> = 30_000</td></tr>
<tr class="separator:afc12e7b0be80c02941204a9afe239c0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a443f27936386b471cb46235ed3a596ad"><td class="memItemLeft" align="right" valign="top"><a id="a443f27936386b471cb46235ed3a596ad"></a>
static readonly bool&#160;</td><td class="memItemRight" valign="bottom"><b>DEFAULT_USE_RECONNECT_BACKOFF</b> = true</td></tr>
<tr class="separator:a443f27936386b471cb46235ed3a596ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49e20cd7cb71f04191fe04542ca8510c"><td class="memItemLeft" align="right" valign="top"><a id="a49e20cd7cb71f04191fe04542ca8510c"></a>
static readonly double&#160;</td><td class="memItemRight" valign="bottom"><b>DEFAULT_RECONNECT_BACKOFF_MULTIPLIER</b> = 2.0d</td></tr>
<tr class="separator:a49e20cd7cb71f04191fe04542ca8510c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a0d33b9bf211ffdec78e125aba7098e84"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#a0d33b9bf211ffdec78e125aba7098e84">ReconnectEnabled</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a0d33b9bf211ffdec78e125aba7098e84"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure if a connection will attempt reconnection if connection is lost or cannot be established to the primary host provided at create time. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#a0d33b9bf211ffdec78e125aba7098e84">More...</a><br /></td></tr>
<tr class="separator:a0d33b9bf211ffdec78e125aba7098e84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a412a6301a26757de9ff6609fcf3b3156"><td class="memItemLeft" align="right" valign="top">IReadOnlyCollection&lt; <a class="el" href="structApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectLocation.html">ReconnectLocation</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#a412a6301a26757de9ff6609fcf3b3156">ReconnectLocations</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a412a6301a26757de9ff6609fcf3b3156"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to get or set the list of reconnection locations that are available from these options. The returned collection is read-only amd the provided collection is copied in this options own collection. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#a412a6301a26757de9ff6609fcf3b3156">More...</a><br /></td></tr>
<tr class="separator:a412a6301a26757de9ff6609fcf3b3156"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a712a961db86798db8380841c261f6ffa"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#a712a961db86798db8380841c261f6ffa">WarnAfterReconnectAttempts</a> = DEFAULT_WARN_AFTER_RECONNECT_ATTEMPTS<code> [get, set]</code></td></tr>
<tr class="memdesc:a712a961db86798db8380841c261f6ffa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Controls how often the client will log a message indicating that a reconnection is being attempted. The default is to log every 10 connection attempts. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#a712a961db86798db8380841c261f6ffa">More...</a><br /></td></tr>
<tr class="separator:a712a961db86798db8380841c261f6ffa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4855b204cd39739650f95d98be1a981"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#af4855b204cd39739650f95d98be1a981">MaxInitialConnectionAttempts</a> = INFINITE<code> [get, set]</code></td></tr>
<tr class="memdesc:af4855b204cd39739650f95d98be1a981"><td class="mdescLeft">&#160;</td><td class="mdescRight">For a client that has never connected to a remote peer before this option controls how many attempts are made to connect before reporting the connection as failed. The default behavior is to use the value of maxReconnectAttempts. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#af4855b204cd39739650f95d98be1a981">More...</a><br /></td></tr>
<tr class="separator:af4855b204cd39739650f95d98be1a981"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ece77ba3b4320338d6811b50e4e928a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#a4ece77ba3b4320338d6811b50e4e928a">MaxReconnectAttempts</a> = INFINITE<code> [get, set]</code></td></tr>
<tr class="memdesc:a4ece77ba3b4320338d6811b50e4e928a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of reconnection attempts allowed before reporting the connection as failed to the client. The default is no limit or (-1). <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#a4ece77ba3b4320338d6811b50e4e928a">More...</a><br /></td></tr>
<tr class="separator:a4ece77ba3b4320338d6811b50e4e928a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9aeb15209ee078c68e9ac3ef604b308c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#a9aeb15209ee078c68e9ac3ef604b308c">ReconnectDelay</a> = DEFAULT_RECONNECT_DELAY<code> [get, set]</code></td></tr>
<tr class="memdesc:a9aeb15209ee078c68e9ac3ef604b308c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Controls the delay between successive reconnection attempts, defaults to 10 milliseconds. If the back off option is not enabled this value remains constant. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#a9aeb15209ee078c68e9ac3ef604b308c">More...</a><br /></td></tr>
<tr class="separator:a9aeb15209ee078c68e9ac3ef604b308c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afbcc65048d2508b3947985e106ac5550"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#afbcc65048d2508b3947985e106ac5550">MaxReconnectDelay</a> = DEFAULT_MAX_RECONNECT_DELAY<code> [get, set]</code></td></tr>
<tr class="memdesc:afbcc65048d2508b3947985e106ac5550"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum time that the client will wait before attempting a reconnect. This value is only used when the back off feature is enabled to ensure that the delay does not grow too large. Defaults to 30 seconds as the max time between successive connection attempts. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#afbcc65048d2508b3947985e106ac5550">More...</a><br /></td></tr>
<tr class="separator:afbcc65048d2508b3947985e106ac5550"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90e846b089379a1f35c443663efdd2e5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#a90e846b089379a1f35c443663efdd2e5">UseReconnectBackOff</a> = DEFAULT_USE_RECONNECT_BACKOFF<code> [get, set]</code></td></tr>
<tr class="memdesc:a90e846b089379a1f35c443663efdd2e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Controls whether the time between reconnection attempts should grow based on a configured multiplier. This option defaults to true. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#a90e846b089379a1f35c443663efdd2e5">More...</a><br /></td></tr>
<tr class="separator:a90e846b089379a1f35c443663efdd2e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f7dd79458aec8936905442e81095a24"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#a2f7dd79458aec8936905442e81095a24">ReconnectBackOffMultiplier</a> = DEFAULT_RECONNECT_BACKOFF_MULTIPLIER<code> [get, set]</code></td></tr>
<tr class="memdesc:a2f7dd79458aec8936905442e81095a24"><td class="mdescLeft">&#160;</td><td class="mdescRight">The multiplier used to grow the reconnection delay value, defaults to 2.0d. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#a2f7dd79458aec8936905442e81095a24">More...</a><br /></td></tr>
<tr class="separator:a2f7dd79458aec8936905442e81095a24"><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>Reconnection options which will control how a connection deals will connection loss and or inability to connect to the host it was provided at create time. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="abb587ab4e2cf10de5ca529bb6bce792c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb587ab4e2cf10de5ca529bb6bce792c">&#9670;&nbsp;</a></span>ReconnectOptions() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Apache.Qpid.Proton.Client.ReconnectOptions.ReconnectOptions </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a default reconnect options instance. </p>
</div>
</div>
<a id="a1f4a15af77ae5260df399c0535b031de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f4a15af77ae5260df399c0535b031de">&#9670;&nbsp;</a></span>ReconnectOptions() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Apache.Qpid.Proton.Client.ReconnectOptions.ReconnectOptions </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html">ReconnectOptions</a>&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new reconnection options instance whose settings are copied from the instance provided. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The reconnect options instance to copy</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a57324572cfbcb0e03993b9f04e3f104f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57324572cfbcb0e03993b9f04e3f104f">&#9670;&nbsp;</a></span>AddReconnectLocation()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html">ReconnectOptions</a> Apache.Qpid.Proton.Client.ReconnectOptions.AddReconnectLocation </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>host</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>port</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds the given host and port to the collection of locations where a connection reconnect attempt can be made. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">host</td><td>The host where the connection is made</td></tr>
<tr><td class="paramname">port</td><td>The port on the host where the connection is made</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This reconnection options instance.</dd></dl>
</div>
</div>
<a id="a09e6056cc20fd54b42f407e09ab78581"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09e6056cc20fd54b42f407e09ab78581">&#9670;&nbsp;</a></span>Clone()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual object Apache.Qpid.Proton.Client.ReconnectOptions.Clone </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clone this options instance, changes to the cloned options are not reflected in this options instance. </p>
<dl class="section return"><dt>Returns</dt><dd>A deep copy of this options instance.</dd></dl>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a id="af4855b204cd39739650f95d98be1a981"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4855b204cd39739650f95d98be1a981">&#9670;&nbsp;</a></span>MaxInitialConnectionAttempts</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Apache.Qpid.Proton.Client.ReconnectOptions.MaxInitialConnectionAttempts = INFINITE</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>For a client that has never connected to a remote peer before this option controls how many attempts are made to connect before reporting the connection as failed. The default behavior is to use the value of maxReconnectAttempts. </p>
</div>
</div>
<a id="a4ece77ba3b4320338d6811b50e4e928a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ece77ba3b4320338d6811b50e4e928a">&#9670;&nbsp;</a></span>MaxReconnectAttempts</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Apache.Qpid.Proton.Client.ReconnectOptions.MaxReconnectAttempts = INFINITE</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of reconnection attempts allowed before reporting the connection as failed to the client. The default is no limit or (-1). </p>
</div>
</div>
<a id="afbcc65048d2508b3947985e106ac5550"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afbcc65048d2508b3947985e106ac5550">&#9670;&nbsp;</a></span>MaxReconnectDelay</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Apache.Qpid.Proton.Client.ReconnectOptions.MaxReconnectDelay = DEFAULT_MAX_RECONNECT_DELAY</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The maximum time that the client will wait before attempting a reconnect. This value is only used when the back off feature is enabled to ensure that the delay does not grow too large. Defaults to 30 seconds as the max time between successive connection attempts. </p>
</div>
</div>
<a id="a2f7dd79458aec8936905442e81095a24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f7dd79458aec8936905442e81095a24">&#9670;&nbsp;</a></span>ReconnectBackOffMultiplier</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double Apache.Qpid.Proton.Client.ReconnectOptions.ReconnectBackOffMultiplier = DEFAULT_RECONNECT_BACKOFF_MULTIPLIER</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The multiplier used to grow the reconnection delay value, defaults to 2.0d. </p>
</div>
</div>
<a id="a9aeb15209ee078c68e9ac3ef604b308c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9aeb15209ee078c68e9ac3ef604b308c">&#9670;&nbsp;</a></span>ReconnectDelay</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Apache.Qpid.Proton.Client.ReconnectOptions.ReconnectDelay = DEFAULT_RECONNECT_DELAY</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Controls the delay between successive reconnection attempts, defaults to 10 milliseconds. If the back off option is not enabled this value remains constant. </p>
</div>
</div>
<a id="a0d33b9bf211ffdec78e125aba7098e84"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d33b9bf211ffdec78e125aba7098e84">&#9670;&nbsp;</a></span>ReconnectEnabled</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Apache.Qpid.Proton.Client.ReconnectOptions.ReconnectEnabled</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Configure if a connection will attempt reconnection if connection is lost or cannot be established to the primary host provided at create time. </p>
</div>
</div>
<a id="a412a6301a26757de9ff6609fcf3b3156"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a412a6301a26757de9ff6609fcf3b3156">&#9670;&nbsp;</a></span>ReconnectLocations</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">IReadOnlyCollection&lt;<a class="el" href="structApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectLocation.html">ReconnectLocation</a>&gt; Apache.Qpid.Proton.Client.ReconnectOptions.ReconnectLocations</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to get or set the list of reconnection locations that are available from these options. The returned collection is read-only amd the provided collection is copied in this options own collection. </p>
</div>
</div>
<a id="a90e846b089379a1f35c443663efdd2e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90e846b089379a1f35c443663efdd2e5">&#9670;&nbsp;</a></span>UseReconnectBackOff</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Apache.Qpid.Proton.Client.ReconnectOptions.UseReconnectBackOff = DEFAULT_USE_RECONNECT_BACKOFF</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Controls whether the time between reconnection attempts should grow based on a configured multiplier. This option defaults to true. </p>
</div>
</div>
<a id="a712a961db86798db8380841c261f6ffa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a712a961db86798db8380841c261f6ffa">&#9670;&nbsp;</a></span>WarnAfterReconnectAttempts</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Apache.Qpid.Proton.Client.ReconnectOptions.WarnAfterReconnectAttempts = DEFAULT_WARN_AFTER_RECONNECT_ATTEMPTS</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Controls how often the client will log a message indicating that a reconnection is being attempted. The default is to log every 10 connection attempts. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Proton.Client/Client/ReconnectOptions.cs</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>