<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.3.1"/>
<title>xrootd: XrdClientUrlSet.hh 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="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 style="padding-left: 0.5em;">
<div id="projectname">xrootd
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_a463079fa6e81dce85c7d5903b67b82e.html">XrdClient</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">XrdClientUrlSet.hh</div> </div>
</div><!--header-->
<div class="contents">
<a href="XrdClientUrlSet_8hh.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 _XRC_URLSET_H</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor"></span><span class="preprocessor">#define _XRC_URLSET_H</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor"></span><span class="comment">/******************************************************************************/</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">/* X r d C l i e n t U r l S e t . h h */</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">/* */</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">/* Author: Fabrizio Furano (INFN Padova, 2004) */</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">/* Adapted from TXNetFile (root.cern.ch) originally done by */</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">/* Alvise Dorigo, Fabrizio Furano, INFN Padova, 2003 */</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">/* Revised by G. Ganis, CERN, June 2005 */</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">/* */</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">/* This file is part of the XRootD software suite. */</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">/* XRootD is free software: you can redistribute it and/or modify it under */</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">/* the terms of the GNU Lesser General Public License as published by the */</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">/* Free Software Foundation, either version 3 of the License, or (at your */</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">/* option) any later version. */</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">/* */</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">/* XRootD is distributed in the hope that it will be useful, but WITHOUT */</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">/* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or */</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">/* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public */</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">/* License for more details. */</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> <span class="comment">/* You should have received a copy of the GNU Lesser General Public License */</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/* along with XRootD in a file called COPYING.LESSER (LGPL license) and file */</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">/* COPYING (GPL license). If not, see <http://www.gnu.org/licenses/>. */</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">/* */</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">/* The copyright holder's institutional names and contributor's names may not */</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">/* be used to endorse or promote products derived from this software without */</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">/* specific prior written permission of the institution or contributor. */</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">/******************************************************************************/</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// //</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// A container for multiple urls to be resolved through DNS aliases //</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// //</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"></span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#include "<a class="code" href="XrdClientConst_8hh.html">XrdClient/XrdClientConst.hh</a>"</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#include "<a class="code" href="XrdClientVector_8hh.html">XrdClient/XrdClientVector.hh</a>"</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#include "<a class="code" href="XrdOucString_8hh.html">XrdOuc/XrdOucString.hh</a>"</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">using namespace </span>std;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="code" href="XrdClientUrlSet_8hh.html#a0038d428dedc6a34e3ef440c61df2e3f"> 45</a></span> <span class="keyword">class </span><a class="code" href="classXrdClientUrlInfo.html">XrdClientUrlInfo</a>;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">typedef</span> <a class="code" href="classXrdClientVector.html">XrdClientVector<XrdClientUrlInfo*></a> <a class="code" href="XrdClientUrlSet_8hh.html#a0038d428dedc6a34e3ef440c61df2e3f">UrlArray</a>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">//</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">// Manages a set of XrdClientUrlInfo objects and provides a set</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">// of utilities to resolve multiple addresses from the dns</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// and to pick urls sequentially and randomly an url</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">//</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="code" href="classXrdClientUrlSet.html"> 55</a></span> <span class="keyword">class </span><a class="code" href="classXrdClientUrlSet.html">XrdClientUrlSet</a> {</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="code" href="classXrdClientUrlSet.html#aecc109c6fff8c1cc71f718b0cb30d720"> 57</a></span>  <a class="code" href="classXrdClientVector.html">UrlArray</a> <a class="code" href="classXrdClientUrlSet.html#aecc109c6fff8c1cc71f718b0cb30d720">fUrlArray</a>;</div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="code" href="classXrdClientUrlSet.html#aa58dfa793cac228d1cb0834e51fe3812"> 58</a></span>  <a class="code" href="classXrdClientVector.html">UrlArray</a> <a class="code" href="classXrdClientUrlSet.html#aa58dfa793cac228d1cb0834e51fe3812">fTmpUrlArray</a>;</div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="code" href="classXrdClientUrlSet.html#abdcf8497857b9d4a868bb017ab5ad52d"> 59</a></span>  <a class="code" href="classXrdOucString.html">XrdOucString</a> <a class="code" href="classXrdClientUrlSet.html#abdcf8497857b9d4a868bb017ab5ad52d">fPathName</a>;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="code" href="classXrdClientUrlSet.html#a444c418ca9aacd77547c79fa17ff613d"> 61</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classXrdClientUrlSet.html#a444c418ca9aacd77547c79fa17ff613d">fIsValid</a>;</div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="code" href="classXrdClientUrlSet.html#a60d2e6130c03a8cd662d89cff28c4fac"> 62</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classXrdClientUrlSet.html#a60d2e6130c03a8cd662d89cff28c4fac">fSeed</a>;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordtype">void</span> CheckPort(<span class="keywordtype">int</span> &port);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">void</span> ConvertDNSAlias(<a class="code" href="classXrdClientVector.html">UrlArray</a>& urls, <a class="code" href="classXrdOucString.html">XrdOucString</a> proto,</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="classXrdOucString.html">XrdOucString</a> host, <a class="code" href="classXrdOucString.html">XrdOucString</a> file);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">double</span> GetRandom(<span class="keywordtype">int</span> seed = 0);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <a class="code" href="classXrdClientUrlSet.html">XrdClientUrlSet</a>(<a class="code" href="classXrdOucString.html">XrdOucString</a> urls);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  ~<a class="code" href="classXrdClientUrlSet.html">XrdClientUrlSet</a>();</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="comment">// Returns the final resolved list of servers</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <a class="code" href="classXrdOucString.html">XrdOucString</a> GetServers();</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment">// Gets the subsequent Url, the one after the last given</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <a class="code" href="classXrdClientUrlInfo.html">XrdClientUrlInfo</a> *GetNextUrl();</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="comment">// From the remaining urls we pick a random one. Without reinsert.</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="comment">// i.e. while there are not considered urls, never pick an already seen one</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="classXrdClientUrlInfo.html">XrdClientUrlInfo</a> *GetARandomUrl();</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="comment">// Given a seed, use that to pick an url</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="comment">// the effect will be that, given the same list, the same seed will pick the same url</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="classXrdClientUrlInfo.html">XrdClientUrlInfo</a> *GetARandomUrl(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> seed);</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">void</span> Rewind();</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">void</span> ShowUrls();</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">void</span> EraseUrl(<a class="code" href="classXrdClientUrlInfo.html">XrdClientUrlInfo</a> *url);</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="comment">// Returns the number of urls</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"><a class="code" href="classXrdClientUrlSet.html#ab94929782dfe9dd1d5a884be354fc185"> 91</a></span>  <span class="keywordtype">int</span> <a class="code" href="classXrdClientUrlSet.html#ab94929782dfe9dd1d5a884be354fc185">Size</a>() { <span class="keywordflow">return</span> fUrlArray.GetSize(); }</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>  <span class="comment">// Returns the pathfile extracted from the CTOR's argument</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"><a class="code" href="classXrdClientUrlSet.html#a4a911275a0a700e22765e45230ec0491"> 94</a></span>  <a class="code" href="classXrdOucString.html">XrdOucString</a> <a class="code" href="classXrdClientUrlSet.html#a4a911275a0a700e22765e45230ec0491">GetFile</a>() { <span class="keywordflow">return</span> fPathName; }</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div>
<div class="line"><a name="l00096"></a><span class="lineno"><a class="code" href="classXrdClientUrlSet.html#ad5e2f888467a4eb967f99d70b9f12ca6"> 96</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classXrdClientUrlSet.html#ad5e2f888467a4eb967f99d70b9f12ca6">IsValid</a>() { <span class="keywordflow">return</span> fIsValid; } <span class="comment">// Spot malformations</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> };</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
distrib
>
Fedora
>
18
>
x86_64
>
media
>
updates
>
by-pkgid
>
749e483016bbc41594aeb77eb13e3491
>
files
>
200
