| <!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.Utilities.ReconnectLocationPool 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&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&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="namespaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities.html">Utilities</a></li><li class="navelem"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html">ReconnectLocationPool</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Client.Utilities.ReconnectLocationPool Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <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:aa4bc41ed30deb842c6176419204f8ce5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#aa4bc41ed30deb842c6176419204f8ce5">ReconnectLocationPool</a> ()</td></tr> |
| <tr class="memdesc:aa4bc41ed30deb842c6176419204f8ce5"><td class="mdescLeft"> </td><td class="mdescRight">Create a default empty reconnect location pool <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#aa4bc41ed30deb842c6176419204f8ce5">More...</a><br /></td></tr> |
| <tr class="separator:aa4bc41ed30deb842c6176419204f8ce5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af1f99e7e87183d0074668c1b351dd342"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#af1f99e7e87183d0074668c1b351dd342">ReconnectLocationPool</a> (ICollection< <a class="el" href="structApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectLocation.html">ReconnectLocation</a> > locations)</td></tr> |
| <tr class="memdesc:af1f99e7e87183d0074668c1b351dd342"><td class="mdescLeft"> </td><td class="mdescRight">Create a new reconnection location pool with the provided initial entries. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#af1f99e7e87183d0074668c1b351dd342">More...</a><br /></td></tr> |
| <tr class="separator:af1f99e7e87183d0074668c1b351dd342"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7b233a0953202a04db578f12a3a2fddc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#a7b233a0953202a04db578f12a3a2fddc">Shuffle</a> ()</td></tr> |
| <tr class="memdesc:a7b233a0953202a04db578f12a3a2fddc"><td class="mdescLeft"> </td><td class="mdescRight">Shuffle the elements in the pool producing a new randomized sequence of reconnection locations based on the original set. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#a7b233a0953202a04db578f12a3a2fddc">More...</a><br /></td></tr> |
| <tr class="separator:a7b233a0953202a04db578f12a3a2fddc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a261481348b2db8ec78690ee1884e7218"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html">ReconnectLocationPool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#a261481348b2db8ec78690ee1884e7218">Add</a> (<a class="el" href="structApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectLocation.html">ReconnectLocation</a> location)</td></tr> |
| <tr class="memdesc:a261481348b2db8ec78690ee1884e7218"><td class="mdescLeft"> </td><td class="mdescRight">Adds the given location to this pool if it is not already contained within. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#a261481348b2db8ec78690ee1884e7218">More...</a><br /></td></tr> |
| <tr class="separator:a261481348b2db8ec78690ee1884e7218"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a89e67afef83da96a80ec729b30bfe742"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html">ReconnectLocationPool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#a89e67afef83da96a80ec729b30bfe742">AddAll</a> (IEnumerable< <a class="el" href="structApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectLocation.html">ReconnectLocation</a> > locations)</td></tr> |
| <tr class="memdesc:a89e67afef83da96a80ec729b30bfe742"><td class="mdescLeft"> </td><td class="mdescRight">Adds the given enumeration of locations to this pool, filtering for duplicates. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#a89e67afef83da96a80ec729b30bfe742">More...</a><br /></td></tr> |
| <tr class="separator:a89e67afef83da96a80ec729b30bfe742"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6c1bacf443525e89d106b14816bcc325"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html">ReconnectLocationPool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#a6c1bacf443525e89d106b14816bcc325">AddFirst</a> (<a class="el" href="structApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectLocation.html">ReconnectLocation</a> location)</td></tr> |
| <tr class="memdesc:a6c1bacf443525e89d106b14816bcc325"><td class="mdescLeft"> </td><td class="mdescRight">Adds the given location to this pool at the front if it is not already contained within. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#a6c1bacf443525e89d106b14816bcc325">More...</a><br /></td></tr> |
| <tr class="separator:a6c1bacf443525e89d106b14816bcc325"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa487fb18923aba443cad9be1aeedfb35"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#aa487fb18923aba443cad9be1aeedfb35">Remove</a> (<a class="el" href="structApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectLocation.html">ReconnectLocation</a> location)</td></tr> |
| <tr class="memdesc:aa487fb18923aba443cad9be1aeedfb35"><td class="mdescLeft"> </td><td class="mdescRight">Removes the given location from the pool if present. If a value was removed this method return true otherwise it returns false. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#aa487fb18923aba443cad9be1aeedfb35">More...</a><br /></td></tr> |
| <tr class="separator:aa487fb18923aba443cad9be1aeedfb35"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a21ced511c800001829075824064f38f5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html">ReconnectLocationPool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#a21ced511c800001829075824064f38f5">RemoveAll</a> ()</td></tr> |
| <tr class="memdesc:a21ced511c800001829075824064f38f5"><td class="mdescLeft"> </td><td class="mdescRight">Removes all current entries from this pool leaving it in an empty state. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#a21ced511c800001829075824064f38f5">More...</a><br /></td></tr> |
| <tr class="separator:a21ced511c800001829075824064f38f5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5995f0e1ecbbc3da75217aaf8696a0e9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#a5995f0e1ecbbc3da75217aaf8696a0e9">ReplaceAll</a> (IEnumerable< <a class="el" href="structApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectLocation.html">ReconnectLocation</a> > replacements)</td></tr> |
| <tr class="memdesc:a5995f0e1ecbbc3da75217aaf8696a0e9"><td class="mdescLeft"> </td><td class="mdescRight">Removes all currently configured <a class="el" href="structApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectLocation.html" title="Represents a fixed location that can be used for connection by the client should the initially specif...">ReconnectLocation</a> values from the pool and replaces them with the new set given. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#a5995f0e1ecbbc3da75217aaf8696a0e9">More...</a><br /></td></tr> |
| <tr class="separator:a5995f0e1ecbbc3da75217aaf8696a0e9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8f23161e3eb91b6e0210ddec24e4ca27"><td class="memItemLeft" align="right" valign="top">IList< <a class="el" href="structApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectLocation.html">ReconnectLocation</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#a8f23161e3eb91b6e0210ddec24e4ca27">ToList</a> ()</td></tr> |
| <tr class="memdesc:a8f23161e3eb91b6e0210ddec24e4ca27"><td class="mdescLeft"> </td><td class="mdescRight">Returns a list that contains a copy of each element contained in this reconnect location pool which can be empty if the pool is empty. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#a8f23161e3eb91b6e0210ddec24e4ca27">More...</a><br /></td></tr> |
| <tr class="separator:a8f23161e3eb91b6e0210ddec24e4ca27"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac2b51ebf703bf9e761a99344cc4e542e"><td class="memItemLeft" align="right" valign="top"><a id="ac2b51ebf703bf9e761a99344cc4e542e"></a> |
| override string </td><td class="memItemRight" valign="bottom"><b>ToString</b> ()</td></tr> |
| <tr class="separator:ac2b51ebf703bf9e761a99344cc4e542e"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a6c315c7a6cde6cd6aabfe08b1b676fd1"><td class="memItemLeft" align="right" valign="top"><a id="a6c315c7a6cde6cd6aabfe08b1b676fd1"></a> |
| static void </td><td class="memItemRight" valign="bottom"><b>ShuffleMe</b> (IList< <a class="el" href="structApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectLocation.html">ReconnectLocation</a> > list)</td></tr> |
| <tr class="separator:a6c315c7a6cde6cd6aabfe08b1b676fd1"><td class="memSeparator" colspan="2"> </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:a344fc116d4a14a27188610d16f1ae35d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#a344fc116d4a14a27188610d16f1ae35d">Count</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a344fc116d4a14a27188610d16f1ae35d"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current number of entries that are stored in the pool. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#a344fc116d4a14a27188610d16f1ae35d">More...</a><br /></td></tr> |
| <tr class="separator:a344fc116d4a14a27188610d16f1ae35d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a81723655b977177d296b13b40deef205"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#a81723655b977177d296b13b40deef205">IsEmpty</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a81723655b977177d296b13b40deef205"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the reconnection location pool is empty or not <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#a81723655b977177d296b13b40deef205">More...</a><br /></td></tr> |
| <tr class="separator:a81723655b977177d296b13b40deef205"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af262c7ff308fe8fe26c68997d208e2a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectLocation.html">ReconnectLocation</a>? </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#af262c7ff308fe8fe26c68997d208e2a3">Next</a><code> [get]</code></td></tr> |
| <tr class="memdesc:af262c7ff308fe8fe26c68997d208e2a3"><td class="mdescLeft"> </td><td class="mdescRight">Returns the next reconnection location from the pool and moves its place in the pool to the end of the list meaning it will eventually be returned again unless removed from the pool. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1ReconnectLocationPool.html#af262c7ff308fe8fe26c68997d208e2a3">More...</a><br /></td></tr> |
| <tr class="separator:af262c7ff308fe8fe26c68997d208e2a3"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="aa4bc41ed30deb842c6176419204f8ce5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa4bc41ed30deb842c6176419204f8ce5">◆ </a></span>ReconnectLocationPool() <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.Utilities.ReconnectLocationPool.ReconnectLocationPool </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>Create a default empty reconnect location pool </p> |
| |
| </div> |
| </div> |
| <a id="af1f99e7e87183d0074668c1b351dd342"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af1f99e7e87183d0074668c1b351dd342">◆ </a></span>ReconnectLocationPool() <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.Utilities.ReconnectLocationPool.ReconnectLocationPool </td> |
| <td>(</td> |
| <td class="paramtype">ICollection< <a class="el" href="structApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectLocation.html">ReconnectLocation</a> > </td> |
| <td class="paramname"><em>locations</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 location pool with the provided initial entries. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">locations</td><td>The initial collection of entries to add to the pool</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a261481348b2db8ec78690ee1884e7218"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a261481348b2db8ec78690ee1884e7218">◆ </a></span>Add()</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_1Utilities_1_1ReconnectLocationPool.html">ReconnectLocationPool</a> Apache.Qpid.Proton.Client.Utilities.ReconnectLocationPool.Add </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectLocation.html">ReconnectLocation</a> </td> |
| <td class="paramname"><em>location</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>Adds the given location to this pool if it is not already contained within. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">location</td><td>The new location to be added to the pool</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This reconnect locations pool</dd></dl> |
| |
| </div> |
| </div> |
| <a id="a89e67afef83da96a80ec729b30bfe742"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a89e67afef83da96a80ec729b30bfe742">◆ </a></span>AddAll()</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_1Utilities_1_1ReconnectLocationPool.html">ReconnectLocationPool</a> Apache.Qpid.Proton.Client.Utilities.ReconnectLocationPool.AddAll </td> |
| <td>(</td> |
| <td class="paramtype">IEnumerable< <a class="el" href="structApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectLocation.html">ReconnectLocation</a> > </td> |
| <td class="paramname"><em>locations</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>Adds the given enumeration of locations to this pool, filtering for duplicates. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">locations</td><td>The enumeration of locations to be added to the pool</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This reconnect locations pool</dd></dl> |
| |
| </div> |
| </div> |
| <a id="a6c1bacf443525e89d106b14816bcc325"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6c1bacf443525e89d106b14816bcc325">◆ </a></span>AddFirst()</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_1Utilities_1_1ReconnectLocationPool.html">ReconnectLocationPool</a> Apache.Qpid.Proton.Client.Utilities.ReconnectLocationPool.AddFirst </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectLocation.html">ReconnectLocation</a> </td> |
| <td class="paramname"><em>location</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>Adds the given location to this pool at the front if it is not already contained within. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">location</td><td>The new location to be added to the pool</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This reconnect locations pool</dd></dl> |
| |
| </div> |
| </div> |
| <a id="aa487fb18923aba443cad9be1aeedfb35"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa487fb18923aba443cad9be1aeedfb35">◆ </a></span>Remove()</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.Utilities.ReconnectLocationPool.Remove </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectLocation.html">ReconnectLocation</a> </td> |
| <td class="paramname"><em>location</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>Removes the given location from the pool if present. If a value was removed this method return true otherwise it returns false. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">location</td><td>The location that should be removed from the pool</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>true if a value was removed from the pool, and false otherwise</dd></dl> |
| |
| </div> |
| </div> |
| <a id="a21ced511c800001829075824064f38f5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a21ced511c800001829075824064f38f5">◆ </a></span>RemoveAll()</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_1Utilities_1_1ReconnectLocationPool.html">ReconnectLocationPool</a> Apache.Qpid.Proton.Client.Utilities.ReconnectLocationPool.RemoveAll </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>Removes all current entries from this pool leaving it in an empty state. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">location</td><td>The location to remove</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This reconnection location pool instance</dd></dl> |
| |
| </div> |
| </div> |
| <a id="a5995f0e1ecbbc3da75217aaf8696a0e9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5995f0e1ecbbc3da75217aaf8696a0e9">◆ </a></span>ReplaceAll()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache.Qpid.Proton.Client.Utilities.ReconnectLocationPool.ReplaceAll </td> |
| <td>(</td> |
| <td class="paramtype">IEnumerable< <a class="el" href="structApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectLocation.html">ReconnectLocation</a> > </td> |
| <td class="paramname"><em>replacements</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>Removes all currently configured <a class="el" href="structApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectLocation.html" title="Represents a fixed location that can be used for connection by the client should the initially specif...">ReconnectLocation</a> values from the pool and replaces them with the new set given. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">replacements</td><td>The new set of <a class="el" href="structApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectLocation.html" title="Represents a fixed location that can be used for connection by the client should the initially specif...">ReconnectLocation</a> values to serve from this pool</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a7b233a0953202a04db578f12a3a2fddc"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7b233a0953202a04db578f12a3a2fddc">◆ </a></span>Shuffle()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache.Qpid.Proton.Client.Utilities.ReconnectLocationPool.Shuffle </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>Shuffle the elements in the pool producing a new randomized sequence of reconnection locations based on the original set. </p> |
| |
| </div> |
| </div> |
| <a id="a8f23161e3eb91b6e0210ddec24e4ca27"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8f23161e3eb91b6e0210ddec24e4ca27">◆ </a></span>ToList()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">IList<<a class="el" href="structApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectLocation.html">ReconnectLocation</a>> Apache.Qpid.Proton.Client.Utilities.ReconnectLocationPool.ToList </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>Returns a list that contains a copy of each element contained in this reconnect location pool which can be empty if the pool is empty. </p> |
| <dl class="section return"><dt>Returns</dt><dd></dd></dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="a344fc116d4a14a27188610d16f1ae35d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a344fc116d4a14a27188610d16f1ae35d">◆ </a></span>Count</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.Utilities.ReconnectLocationPool.Count</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the current number of entries that are stored in the pool. </p> |
| |
| </div> |
| </div> |
| <a id="a81723655b977177d296b13b40deef205"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a81723655b977177d296b13b40deef205">◆ </a></span>IsEmpty</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.Utilities.ReconnectLocationPool.IsEmpty</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Checks if the reconnection location pool is empty or not </p> |
| |
| </div> |
| </div> |
| <a id="af262c7ff308fe8fe26c68997d208e2a3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af262c7ff308fe8fe26c68997d208e2a3">◆ </a></span>Next</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="structApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectLocation.html">ReconnectLocation</a>? Apache.Qpid.Proton.Client.Utilities.ReconnectLocationPool.Next</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the next reconnection location from the pool and moves its place in the pool to the end of the list meaning it will eventually be returned again unless removed from the pool. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>src/Proton.Client/Client/Utilities/ReconnectLocationPool.cs</li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <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> |
