<!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: XrdClientEnv.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">XrdClientEnv.hh</div> </div> </div><!--header--> <div class="contents"> <a href="XrdClientEnv_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 XRD_CENV_H</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor"></span><span class="preprocessor">#define XRD_CENV_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 E n v . 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 */</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">/* INFN Padova, 2003 */</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">// Singleton used to handle the default parameter values //</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="XrdOucEnv_8hh.html">XrdOuc/XrdOucEnv.hh</a>"</span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#include "<a class="code" href="XrdSysPthread_8hh.html">XrdSys/XrdSysPthread.hh</a>"</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#include <string.h></span></div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div> <div class="line"><a name="l00044"></a><span class="lineno"><a class="code" href="XrdClientEnv_8hh.html#aa93f68f714455e6702f0a1499a35a391"> 44</a></span> <span class="preprocessor">#define EnvGetLong(x) XrdClientEnv::Instance()->ShellGetInt(x)</span></div> <div class="line"><a name="l00045"></a><span class="lineno"><a class="code" href="XrdClientEnv_8hh.html#a5604599d7795c1acd4f4f203ac04452b"> 45</a></span> <span class="preprocessor"></span><span class="preprocessor">#define EnvGetString(x) XrdClientEnv::Instance()->ShellGet(x)</span></div> <div class="line"><a name="l00046"></a><span class="lineno"><a class="code" href="XrdClientEnv_8hh.html#acdc3957f040c5b28498df6a734c01b0e"> 46</a></span> <span class="preprocessor"></span><span class="preprocessor">#define EnvPutString(name, val) XrdClientEnv::Instance()->Put(name, val)</span></div> <div class="line"><a name="l00047"></a><span class="lineno"><a class="code" href="XrdClientEnv_8hh.html#a2c0fcebc218979dd21b15f3f63729395"> 47</a></span> <span class="preprocessor"></span><span class="preprocessor">#define EnvPutInt(name, val) XrdClientEnv::Instance()->PutInt(name, val)</span></div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00049"></a><span class="lineno"><a class="code" href="classXrdClientEnv.html"> 49</a></span> <span class="keyword">class </span><a class="code" href="classXrdClientEnv.html">XrdClientEnv</a> {</div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">private</span>:</div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div> <div class="line"><a name="l00052"></a><span class="lineno"><a class="code" href="classXrdClientEnv.html#a642864b9e134171bb7fdff7c0175d8c1"> 52</a></span>  <a class="code" href="classXrdOucEnv.html">XrdOucEnv</a> *<a class="code" href="classXrdClientEnv.html#a642864b9e134171bb7fdff7c0175d8c1">fOucEnv</a>;</div> <div class="line"><a name="l00053"></a><span class="lineno"><a class="code" href="classXrdClientEnv.html#ab9efe63278df5d27bc10960a7e41ecb6"> 53</a></span>  <a class="code" href="classXrdSysRecMutex.html">XrdSysRecMutex</a> <a class="code" href="classXrdClientEnv.html#ab9efe63278df5d27bc10960a7e41ecb6">fMutex</a>;</div> <div class="line"><a name="l00054"></a><span class="lineno"><a class="code" href="classXrdClientEnv.html#a20418609583629fdb399439a68327db4"> 54</a></span>  <span class="keyword">static</span> <a class="code" href="classXrdClientEnv.html">XrdClientEnv</a> *<a class="code" href="classXrdClientEnv.html#a20418609583629fdb399439a68327db4">fgInstance</a>;</div> <div class="line"><a name="l00055"></a><span class="lineno"><a class="code" href="classXrdClientEnv.html#adc5faf210bdeda2a4aa39a9746372194"> 55</a></span>  <a class="code" href="classXrdOucEnv.html">XrdOucEnv</a> *<a class="code" href="classXrdClientEnv.html#adc5faf210bdeda2a4aa39a9746372194">fShellEnv</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>  <span class="keyword">protected</span>:</div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="classXrdClientEnv.html#a9bfaba2ff9a99120f1acd76665c309a4">XrdClientEnv</a>();</div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <a class="code" href="classXrdClientEnv.html#a706224826806e5309431ee41919919f3">~XrdClientEnv</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"> 61</span>  <span class="comment">//---------------------------------------------------------------------------</span></div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"></span> <span class="comment">//---------------------------------------------------------------------------</span></div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">bool</span> <a class="code" href="classXrdClientEnv.html#a84b109b7ec59590891acb8c83bcdbc1a">ImportStr</a>( <span class="keyword">const</span> <span class="keywordtype">char</span> *varname );</div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">bool</span> <a class="code" href="classXrdClientEnv.html#ac36d0572f92bc05cf66471f5ace417f0">ImportInt</a>( <span class="keyword">const</span> <span class="keywordtype">char</span> *varname );</div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">public</span>:</div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div> <div class="line"><a name="l00070"></a><span class="lineno"><a class="code" href="classXrdClientEnv.html#aa772c0af8a5ccbf27e19bfbc90c9d9de"> 70</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code" href="classXrdClientEnv.html#aa772c0af8a5ccbf27e19bfbc90c9d9de">Get</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *varname) {</div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *res;</div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="classXrdSysMutexHelper.html">XrdSysMutexHelper</a> m(<a class="code" href="classXrdClientEnv.html#ab9efe63278df5d27bc10960a7e41ecb6">fMutex</a>);</div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  res = <a class="code" href="classXrdClientEnv.html#a642864b9e134171bb7fdff7c0175d8c1">fOucEnv</a>-><a class="code" href="classXrdOucEnv.html#a7f42a7080d25c693962e509d1f2066df">Get</a>(varname);</div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">return</span> res;</div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  }</div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div> <div class="line"><a name="l00078"></a><span class="lineno"><a class="code" href="classXrdClientEnv.html#a7a1009874ec652574e8199e04a1b0ccf"> 78</a></span>  <span class="keywordtype">long</span> <a class="code" href="classXrdClientEnv.html#a7a1009874ec652574e8199e04a1b0ccf">GetInt</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *varname) {</div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordtype">long</span> res;</div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <a class="code" href="classXrdSysMutexHelper.html">XrdSysMutexHelper</a> m(<a class="code" href="classXrdClientEnv.html#ab9efe63278df5d27bc10960a7e41ecb6">fMutex</a>);</div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  res = <a class="code" href="classXrdClientEnv.html#a642864b9e134171bb7fdff7c0175d8c1">fOucEnv</a>-><a class="code" href="classXrdOucEnv.html#a1d216be30e3ee3b2d7fe5f0b6801896b">GetInt</a>(varname);</div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">return</span> res;</div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  }</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="comment">//---------------------------------------------------------------------------</span></div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"></span> <span class="comment">//---------------------------------------------------------------------------</span></div> <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classXrdClientEnv.html#a957b32027139190b988841fd700c1609">ShellGet</a>( <span class="keyword">const</span> <span class="keywordtype">char</span> *varname );</div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="comment">//---------------------------------------------------------------------------</span></div> <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"></span> <span class="comment">//---------------------------------------------------------------------------</span></div> <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">long</span> <a class="code" href="classXrdClientEnv.html#a9aabe34320b18e6bfc0a6c3dd3195319">ShellGetInt</a>( <span class="keyword">const</span> <span class="keywordtype">char</span> *varname );</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"><a class="code" href="classXrdClientEnv.html#a9722e4a9fa3fa29543320c43b11f2bfa"> 99</a></span>  <span class="keywordtype">void</span> <a class="code" href="classXrdClientEnv.html#a9722e4a9fa3fa29543320c43b11f2bfa">Put</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *varname, <span class="keyword">const</span> <span class="keywordtype">char</span> *value) {</div> <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <a class="code" href="classXrdSysMutexHelper.html">XrdSysMutexHelper</a> m(<a class="code" href="classXrdClientEnv.html#ab9efe63278df5d27bc10960a7e41ecb6">fMutex</a>);</div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <a class="code" href="classXrdClientEnv.html#a642864b9e134171bb7fdff7c0175d8c1">fOucEnv</a>-><a class="code" href="classXrdOucEnv.html#ab6c3a4596790e0588850224d04792b8e">Put</a>(varname, value);</div> <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  }</div> <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div> <div class="line"><a name="l00105"></a><span class="lineno"><a class="code" href="classXrdClientEnv.html#a11638736c99d9abcfbc448e266f12aac"> 105</a></span>  <span class="keywordtype">void</span> <a class="code" href="classXrdClientEnv.html#a11638736c99d9abcfbc448e266f12aac">PutInt</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *varname, <span class="keywordtype">long</span> value) {</div> <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <a class="code" href="classXrdSysMutexHelper.html">XrdSysMutexHelper</a> m(<a class="code" href="classXrdClientEnv.html#ab9efe63278df5d27bc10960a7e41ecb6">fMutex</a>);</div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <a class="code" href="classXrdClientEnv.html#a642864b9e134171bb7fdff7c0175d8c1">fOucEnv</a>-><a class="code" href="classXrdOucEnv.html#a0be80f70bb349e5bc4e30f8335f38791">PutInt</a>(varname, value);</div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  }</div> <div class="line"><a name="l00110"></a><span class="lineno"><a class="code" href="classXrdClientEnv.html#a652cb0e9a2824a1c46a2cb95ea52bf8e"> 110</a></span>  <span class="keywordtype">void</span> <a class="code" href="classXrdClientEnv.html#a652cb0e9a2824a1c46a2cb95ea52bf8e">Lock</a>()</div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  {</div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <a class="code" href="classXrdClientEnv.html#ab9efe63278df5d27bc10960a7e41ecb6">fMutex</a>.<a class="code" href="classXrdSysMutex.html#a6dcffcf5ae5370f5aca882d38935fd69">Lock</a>();</div> <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  }</div> <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div> <div class="line"><a name="l00115"></a><span class="lineno"><a class="code" href="classXrdClientEnv.html#ae422756de7bbc7092cb56ebf1aef1834"> 115</a></span>  <span class="keywordtype">void</span> <a class="code" href="classXrdClientEnv.html#ae422756de7bbc7092cb56ebf1aef1834">UnLock</a>()</div> <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  {</div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <a class="code" href="classXrdClientEnv.html#ab9efe63278df5d27bc10960a7e41ecb6">fMutex</a>.<a class="code" href="classXrdSysMutex.html#ab5802ffb3112a55f06b5d0679ed6a772">UnLock</a>();</div> <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  }</div> <div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div> <div class="line"><a name="l00120"></a><span class="lineno"><a class="code" href="classXrdClientEnv.html#ac12ed40ffb16feb93cbe5aafcce611a9"> 120</a></span>  <span class="keywordtype">int</span> <a class="code" href="classXrdClientEnv.html#ac12ed40ffb16feb93cbe5aafcce611a9">ReInitLock</a>()</div> <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  {</div> <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordflow">return</span> <a class="code" href="classXrdClientEnv.html#ab9efe63278df5d27bc10960a7e41ecb6">fMutex</a>.<a class="code" href="classXrdSysRecMutex.html#af63b6874dc61fe03bacf4370e0be8511">ReInitRecMutex</a>();</div> <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  }</div> <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div> <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keyword">static</span> <a class="code" href="classXrdClientEnv.html">XrdClientEnv</a> *<a class="code" href="classXrdClientEnv.html#aac95a6e2e6d883203e18e235b315ac72">Instance</a>();</div> <div class="line"><a name="l00126"></a><span class="lineno"> 126</span> };</div> <div class="line"><a name="l00127"></a><span class="lineno"> 127</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>