<!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: XrdOucCache.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_a84cd9d3995a3fdd61364d705353c9e4.html">XrdOuc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">XrdOucCache.hh</div> </div>
</div><!--header-->
<div class="contents">
<a href="XrdOucCache_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 __XRDOUCCACHE_HH__</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor"></span><span class="preprocessor">#define __XRDOUCCACHE_HH__</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 O u c C a c h e . 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">/* (c) 2011 by the Board of Trustees of the Leland Stanford, Jr., University */</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">/* All Rights Reserved */</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">/* Produced by Andrew Hanushevsky for Stanford University under contract */</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">/* DE-AC02-76-SFO0515 with the Department of Energy */</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="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include "<a class="code" href="XrdSysPthread_8hh.html">XrdSys/XrdSysPthread.hh</a>"</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">/* The classes defined here can be used to implement a general cache for</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> data from an arbitrary source (e.g. files, sockets, etc); as follows:</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> 1. Create an instance of XrdOucCacheIO. This object is used to actually</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> bring in missing data into the cache or write out dirty cache pages.</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> There can be many instances of this class, as needed. However, make sure</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> that there is a 1-to-1 unique correspondence between data and its CacheIO</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> object. Violating this may cause the same data to be cached multiple</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> times and if the cache is writable the data may be inconsistent!</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"></span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> 2. Create an instance of XrdOucCache. You can specify various cache</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> handling parameters (see the class definition). You can also define</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> additional instances if you want more than one cache. The specific cache</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> you create will be defined by an implementation that derives from these</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> classes. For instance, an implementation of a memory cache is defined</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> in "XrdOucCacheDram.hh".</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"></span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> 3. Use the Attach() method in XrdOucCache to attach your XrdOucCacheIO</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> object with a cache instance. The method returns a remanufactured</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> XrdOucCacheIO object that interposes the cache in front of the original</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> XrdOucCacheIO. This allows you to transparently use the cache.</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"></span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> 4. When finished using the remanufactured XrdOucCacheIO object, use its</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> Detach() method to remove the association from the cache. Other actions</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> are defined by the actual implementation. For instance XrdOucCacheDram</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> also releases any assigned cache pages, writes out any dirty pages, and</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> may optionally delete the object when all references have been removed.</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"></span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> 5. You may delete cache instances as well. Just be sure that no associations</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> still exist using the XrdOucCache::isAttached() method. Otherwise, the</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> cache destructor will wait until all attached objects are detached.</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"></span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> Example:</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> class physIO : public XrdOucCacheIO {...}; // Define required methods</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> class xCache : public XrdOucCache {...}; // The cache implementation</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> XrdOucCache::Parms myParms; // Set any desired parameters</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> XrdOucCache *myCache;</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> XrdOucCacheIO *cacheIO;</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> xCache theCache; // Implementation instance</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"></span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> myCache = theCache.Create(myParms); // Create a cache instance</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> cacheIO = myCache->Attach(physIO); // Interpose the cache</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"></span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> // Use cacheIO (fronted by myCache) instead of physIO. When done...</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"></span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> delete cacheIO->Detach(); // Deletes cacheIO and physIO</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment">/******************************************************************************/</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">/* C l a s s X r d O u c C a c h e S t a t s */</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment">/******************************************************************************/</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">/* The XrdOucCacheStats object holds statistics on cache usage. It is available</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> in for each XrdOucCacheIO and each XrdOucCache object. The former usually</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> identifies a specific file while the latter provides summary information.</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a name="l00092"></a><span class="lineno"><a class="code" href="classXrdOucCacheStats.html"> 92</a></span> <span class="keyword">class </span><a class="code" href="classXrdOucCacheStats.html">XrdOucCacheStats</a></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> {</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00095"></a><span class="lineno"><a class="code" href="classXrdOucCacheStats.html#ac2e7bfbeef716c0cd66e7468c1886f77"> 95</a></span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <a class="code" href="classXrdOucCacheStats.html#ac2e7bfbeef716c0cd66e7468c1886f77">BytesPead</a>; <span class="comment">// Bytes read via preread (not included in BytesRead)</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"><a class="code" href="classXrdOucCacheStats.html#a80d6b1d06b62f8eabfccedc2900cb4f4"> 96</a></span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <a class="code" href="classXrdOucCacheStats.html#a80d6b1d06b62f8eabfccedc2900cb4f4">BytesRead</a>; <span class="comment">// Total number of bytes read into the cache</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"><a class="code" href="classXrdOucCacheStats.html#a48700c08838bdfe074447bdcc133cb2c"> 97</a></span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <a class="code" href="classXrdOucCacheStats.html#a48700c08838bdfe074447bdcc133cb2c">BytesGet</a>; <span class="comment">// Number of bytes delivered from the cache</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"><a class="code" href="classXrdOucCacheStats.html#a334b183c662ae481ddebbb3de33ca51e"> 98</a></span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <a class="code" href="classXrdOucCacheStats.html#a334b183c662ae481ddebbb3de33ca51e">BytesPass</a>; <span class="comment">// Number of bytes read but not cached</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"><a class="code" href="classXrdOucCacheStats.html#afbbae4d472b289459bb00c2be5c810c6"> 99</a></span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <a class="code" href="classXrdOucCacheStats.html#afbbae4d472b289459bb00c2be5c810c6">BytesWrite</a>; <span class="comment">// Total number of bytes written from the cache</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"><a class="code" href="classXrdOucCacheStats.html#a3780fdcfbf6563d11ed66c71f3778149"> 100</a></span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <a class="code" href="classXrdOucCacheStats.html#a3780fdcfbf6563d11ed66c71f3778149">BytesPut</a>; <span class="comment">// Number of bytes updated in the cache</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"><a class="code" href="classXrdOucCacheStats.html#a7d68c6931dc72701be8ae6c3a389ebd3"> 101</a></span> <span class="keywordtype">int</span> <a class="code" href="classXrdOucCacheStats.html#a7d68c6931dc72701be8ae6c3a389ebd3">Hits</a>; <span class="comment">// Number of times wanted data was in the cache</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"><a class="code" href="classXrdOucCacheStats.html#a63fe0d9967b0777303ff3428cb1854e5"> 102</a></span> <span class="keywordtype">int</span> <a class="code" href="classXrdOucCacheStats.html#a63fe0d9967b0777303ff3428cb1854e5">Miss</a>; <span class="comment">// Number of times wanted data was *not* in the cache</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"><a class="code" href="classXrdOucCacheStats.html#a35ba479d6fe206dea6acd861ccea6639"> 103</a></span> <span class="keywordtype">int</span> <a class="code" href="classXrdOucCacheStats.html#a35ba479d6fe206dea6acd861ccea6639">HitsPR</a>; <span class="comment">// Number of pages wanted data was just preread</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"><a class="code" href="classXrdOucCacheStats.html#a8ac9927763f0e864beddef6e44ee78b5"> 104</a></span> <span class="keywordtype">int</span> <a class="code" href="classXrdOucCacheStats.html#a8ac9927763f0e864beddef6e44ee78b5">MissPR</a>; <span class="comment">// Number of pages wanted data was just read</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div>
<div class="line"><a name="l00106"></a><span class="lineno"><a class="code" href="classXrdOucCacheStats.html#ad5058b5af3966575865efb4ca5090851"> 106</a></span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classXrdOucCacheStats.html#ad5058b5af3966575865efb4ca5090851">Get</a>(<a class="code" href="classXrdOucCacheStats.html">XrdOucCacheStats</a> &Dst)</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  {<a class="code" href="classXrdOucCacheStats.html#a8278b0fe173235fa0cc3265a7cd6ee17">sMutex</a>.<a class="code" href="classXrdSysMutex.html#a6dcffcf5ae5370f5aca882d38935fd69">Lock</a>();</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  Dst.<a class="code" href="classXrdOucCacheStats.html#a80d6b1d06b62f8eabfccedc2900cb4f4">BytesRead</a> = <a class="code" href="classXrdOucCacheStats.html#ac2e7bfbeef716c0cd66e7468c1886f77">BytesPead</a>; Dst.<a class="code" href="classXrdOucCacheStats.html#a48700c08838bdfe074447bdcc133cb2c">BytesGet</a> = <a class="code" href="classXrdOucCacheStats.html#a80d6b1d06b62f8eabfccedc2900cb4f4">BytesRead</a>;</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  Dst.<a class="code" href="classXrdOucCacheStats.html#a334b183c662ae481ddebbb3de33ca51e">BytesPass</a> = <a class="code" href="classXrdOucCacheStats.html#a334b183c662ae481ddebbb3de33ca51e">BytesPass</a>;</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  Dst.<a class="code" href="classXrdOucCacheStats.html#afbbae4d472b289459bb00c2be5c810c6">BytesWrite</a> = <a class="code" href="classXrdOucCacheStats.html#afbbae4d472b289459bb00c2be5c810c6">BytesWrite</a>; Dst.<a class="code" href="classXrdOucCacheStats.html#a3780fdcfbf6563d11ed66c71f3778149">BytesPut</a> = <a class="code" href="classXrdOucCacheStats.html#a3780fdcfbf6563d11ed66c71f3778149">BytesPut</a>;</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  Dst.<a class="code" href="classXrdOucCacheStats.html#a7d68c6931dc72701be8ae6c3a389ebd3">Hits</a> = <a class="code" href="classXrdOucCacheStats.html#a7d68c6931dc72701be8ae6c3a389ebd3">Hits</a>; Dst.<a class="code" href="classXrdOucCacheStats.html#a63fe0d9967b0777303ff3428cb1854e5">Miss</a> = <a class="code" href="classXrdOucCacheStats.html#a63fe0d9967b0777303ff3428cb1854e5">Miss</a>;</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  Dst.<a class="code" href="classXrdOucCacheStats.html#a35ba479d6fe206dea6acd861ccea6639">HitsPR</a> = <a class="code" href="classXrdOucCacheStats.html#a35ba479d6fe206dea6acd861ccea6639">HitsPR</a>; Dst.<a class="code" href="classXrdOucCacheStats.html#a8ac9927763f0e864beddef6e44ee78b5">MissPR</a> = <a class="code" href="classXrdOucCacheStats.html#a8ac9927763f0e864beddef6e44ee78b5">MissPR</a>;</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <a class="code" href="classXrdOucCacheStats.html#a8278b0fe173235fa0cc3265a7cd6ee17">sMutex</a>.<a class="code" href="classXrdSysMutex.html#ab5802ffb3112a55f06b5d0679ed6a772">UnLock</a>();</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  }</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div>
<div class="line"><a name="l00116"></a><span class="lineno"><a class="code" href="classXrdOucCacheStats.html#acd61263790993cacb6ee3d15d1b2851f"> 116</a></span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classXrdOucCacheStats.html#acd61263790993cacb6ee3d15d1b2851f">Add</a>(<a class="code" href="classXrdOucCacheStats.html">XrdOucCacheStats</a> &Src)</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  {<a class="code" href="classXrdOucCacheStats.html#a8278b0fe173235fa0cc3265a7cd6ee17">sMutex</a>.<a class="code" href="classXrdSysMutex.html#a6dcffcf5ae5370f5aca882d38935fd69">Lock</a>();</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <a class="code" href="classXrdOucCacheStats.html#a80d6b1d06b62f8eabfccedc2900cb4f4">BytesRead</a> += Src.<a class="code" href="classXrdOucCacheStats.html#ac2e7bfbeef716c0cd66e7468c1886f77">BytesPead</a>; <a class="code" href="classXrdOucCacheStats.html#a48700c08838bdfe074447bdcc133cb2c">BytesGet</a> += Src.<a class="code" href="classXrdOucCacheStats.html#a80d6b1d06b62f8eabfccedc2900cb4f4">BytesRead</a>;</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <a class="code" href="classXrdOucCacheStats.html#a334b183c662ae481ddebbb3de33ca51e">BytesPass</a> += Src.<a class="code" href="classXrdOucCacheStats.html#a334b183c662ae481ddebbb3de33ca51e">BytesPass</a>;</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <a class="code" href="classXrdOucCacheStats.html#afbbae4d472b289459bb00c2be5c810c6">BytesWrite</a> += Src.<a class="code" href="classXrdOucCacheStats.html#afbbae4d472b289459bb00c2be5c810c6">BytesWrite</a>; <a class="code" href="classXrdOucCacheStats.html#a3780fdcfbf6563d11ed66c71f3778149">BytesPut</a> += Src.<a class="code" href="classXrdOucCacheStats.html#a3780fdcfbf6563d11ed66c71f3778149">BytesPut</a>;</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <a class="code" href="classXrdOucCacheStats.html#a7d68c6931dc72701be8ae6c3a389ebd3">Hits</a> += Src.<a class="code" href="classXrdOucCacheStats.html#a7d68c6931dc72701be8ae6c3a389ebd3">Hits</a>; <a class="code" href="classXrdOucCacheStats.html#a63fe0d9967b0777303ff3428cb1854e5">Miss</a> += Src.<a class="code" href="classXrdOucCacheStats.html#a63fe0d9967b0777303ff3428cb1854e5">Miss</a>;</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <a class="code" href="classXrdOucCacheStats.html#a35ba479d6fe206dea6acd861ccea6639">HitsPR</a> += Src.<a class="code" href="classXrdOucCacheStats.html#a35ba479d6fe206dea6acd861ccea6639">HitsPR</a>; <a class="code" href="classXrdOucCacheStats.html#a8ac9927763f0e864beddef6e44ee78b5">MissPR</a> += Src.<a class="code" href="classXrdOucCacheStats.html#a8ac9927763f0e864beddef6e44ee78b5">MissPR</a>;</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <a class="code" href="classXrdOucCacheStats.html#a8278b0fe173235fa0cc3265a7cd6ee17">sMutex</a>.<a class="code" href="classXrdSysMutex.html#ab5802ffb3112a55f06b5d0679ed6a772">UnLock</a>();</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> </div>
<div class="line"><a name="l00126"></a><span class="lineno"><a class="code" href="classXrdOucCacheStats.html#a9ebe8e66050edf39eb1a34ced5a1cab7"> 126</a></span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classXrdOucCacheStats.html#acd61263790993cacb6ee3d15d1b2851f">Add</a>(<span class="keywordtype">long</span> <span class="keywordtype">long</span> &Dest, <span class="keywordtype">int</span> &Val)</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  {<a class="code" href="classXrdOucCacheStats.html#a8278b0fe173235fa0cc3265a7cd6ee17">sMutex</a>.<a class="code" href="classXrdSysMutex.html#a6dcffcf5ae5370f5aca882d38935fd69">Lock</a>(); Dest += Val; <a class="code" href="classXrdOucCacheStats.html#a8278b0fe173235fa0cc3265a7cd6ee17">sMutex</a>.<a class="code" href="classXrdSysMutex.html#ab5802ffb3112a55f06b5d0679ed6a772">UnLock</a>();}</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div>
<div class="line"><a name="l00129"></a><span class="lineno"><a class="code" href="classXrdOucCacheStats.html#aa15f8dc7ec194d57930f7dee4e2e20e9"> 129</a></span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classXrdOucCacheStats.html#aa15f8dc7ec194d57930f7dee4e2e20e9">Lock</a>() {<a class="code" href="classXrdOucCacheStats.html#a8278b0fe173235fa0cc3265a7cd6ee17">sMutex</a>.<a class="code" href="classXrdSysMutex.html#a6dcffcf5ae5370f5aca882d38935fd69">Lock</a>();}</div>
<div class="line"><a name="l00130"></a><span class="lineno"><a class="code" href="classXrdOucCacheStats.html#a39a09f9cf141fa62e7736ed4dba70ace"> 130</a></span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classXrdOucCacheStats.html#a39a09f9cf141fa62e7736ed4dba70ace">UnLock</a>() {<a class="code" href="classXrdOucCacheStats.html#a8278b0fe173235fa0cc3265a7cd6ee17">sMutex</a>.<a class="code" href="classXrdSysMutex.html#ab5802ffb3112a55f06b5d0679ed6a772">UnLock</a>();}</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div>
<div class="line"><a name="l00132"></a><span class="lineno"><a class="code" href="classXrdOucCacheStats.html#a04a67b2a3a4af4962a309f7cb1daa46a"> 132</a></span>  <a class="code" href="classXrdOucCacheStats.html#a04a67b2a3a4af4962a309f7cb1daa46a">XrdOucCacheStats</a>() : <a class="code" href="classXrdOucCacheStats.html#ac2e7bfbeef716c0cd66e7468c1886f77">BytesPead</a>(0), <a class="code" href="classXrdOucCacheStats.html#a80d6b1d06b62f8eabfccedc2900cb4f4">BytesRead</a>(0), <a class="code" href="classXrdOucCacheStats.html#a48700c08838bdfe074447bdcc133cb2c">BytesGet</a>(0),</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <a class="code" href="classXrdOucCacheStats.html#a334b183c662ae481ddebbb3de33ca51e">BytesPass</a>(0), <a class="code" href="classXrdOucCacheStats.html#afbbae4d472b289459bb00c2be5c810c6">BytesWrite</a>(0), <a class="code" href="classXrdOucCacheStats.html#a3780fdcfbf6563d11ed66c71f3778149">BytesPut</a>(0),</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <a class="code" href="classXrdOucCacheStats.html#a7d68c6931dc72701be8ae6c3a389ebd3">Hits</a>(0), <a class="code" href="classXrdOucCacheStats.html#a63fe0d9967b0777303ff3428cb1854e5">Miss</a>(0),</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <a class="code" href="classXrdOucCacheStats.html#a35ba479d6fe206dea6acd861ccea6639">HitsPR</a>(0), <a class="code" href="classXrdOucCacheStats.html#a8ac9927763f0e864beddef6e44ee78b5">MissPR</a>(0) {}</div>
<div class="line"><a name="l00136"></a><span class="lineno"><a class="code" href="classXrdOucCacheStats.html#a01a08f23795542239360dd5038aaf6c1"> 136</a></span>  <a class="code" href="classXrdOucCacheStats.html#a01a08f23795542239360dd5038aaf6c1">~XrdOucCacheStats</a>() {}</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00138"></a><span class="lineno"><a class="code" href="classXrdOucCacheStats.html#a8278b0fe173235fa0cc3265a7cd6ee17"> 138</a></span> <a class="code" href="classXrdSysMutex.html">XrdSysMutex</a> <a class="code" href="classXrdOucCacheStats.html#a8278b0fe173235fa0cc3265a7cd6ee17">sMutex</a>;</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> };</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment">/******************************************************************************/</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment">/* C l a s s X r d O u c C a c h e I O */</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment">/******************************************************************************/</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment">/* The XrdOucCacheIO object is responsible for interacting with the original</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> data source/target. It can be used with or without a front-end cache.</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"></span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> Six abstract methods are provided FSize(), Path(), Read(), Sync(), Trunc(),</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> and Write(). You must provide implementations for each as described below.</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"></span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> Four additional virtual methods are pre-defined: Base(), Detach(), and</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> Preread() (2x). Normally, there is no need to over-ride these methods.</span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"></span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> Finally, each object carries with it a XrdOucCacheStats object.</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> </div>
<div class="line"><a name="l00157"></a><span class="lineno"><a class="code" href="classXrdOucCacheIO.html"> 157</a></span> <span class="keyword">class </span><a class="code" href="classXrdOucCacheIO.html">XrdOucCacheIO</a></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> {</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment">// FSize() returns the current size of the file associated with this object.</span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment">// Success: size of the file in bytes.</span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment">// Failure: -errno associated with the error.</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="keyword">virtual</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <a class="code" href="classXrdOucCacheIO.html#a7779322dad085877d04d6ca3a4ac0f85">FSize</a>() = 0;</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment">// Path() returns the path name associated with this object.</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment">//</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="keyword">virtual</span></div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classXrdOucCacheIO.html#a0de427047c405cf6f57f3d3f7b14fc0c">Path</a>() = 0;</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment">// Read() places Length bytes in Buffer from a data source at Offset.</span></div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment">// When fronted by a cache, the cache is inspected first.</span></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment">// Success: actual number of bytes placed in Buffer.</span></div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment">// Failure: -errno associated with the error.</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="keyword">virtual</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="keywordtype">int</span> <a class="code" href="classXrdOucCacheIO.html#a833dfd2f6420bc35cd883834e193ced2">Read</a> (<span class="keywordtype">char</span> *Buffer, <span class="keywordtype">long</span> <span class="keywordtype">long</span> Offset, <span class="keywordtype">int</span> Length) = 0;</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> </div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment">// Sync() copies any outstanding modified bytes to the target.</span></div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> </div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment">// Success: return 0.</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment">// Failure: -errno associated with the error.</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="keyword">virtual</span></div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="keywordtype">int</span> <a class="code" href="classXrdOucCacheIO.html#a5abfe1277d158bdc8f63a705fed18de6">Sync</a>() = 0;</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> </div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment">// Trunc() truncates the file to the specified offset.</span></div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment">// Success: return 0.</span></div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment">// Failure: -errno associated with the error.</span></div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="keyword">virtual</span></div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="keywordtype">int</span> <a class="code" href="classXrdOucCacheIO.html#ad2bad696643a3a0bc2089edf19fade7c">Trunc</a>(<span class="keywordtype">long</span> <span class="keywordtype">long</span> Offset) = 0;</div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> </div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> </div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment">// Write() takes Length bytes in Buffer and writes to a data target at Offset.</span></div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment">// When fronted by a cache, the cache is updated as well.</span></div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> </div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment">// Success: actual number of bytes copied from the Buffer.</span></div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment">// Failure: -errno associated with the error.</span></div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="keyword">virtual</span></div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="keywordtype">int</span> <a class="code" href="classXrdOucCacheIO.html#aa34e477377e7d2e30f5cad43bf699fdb">Write</a>(<span class="keywordtype">char</span> *Buffer, <span class="keywordtype">long</span> <span class="keywordtype">long</span> Offset, <span class="keywordtype">int</span> Length) = 0;</div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> </div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment">// Base() returns the underlying XrdOucCacheIO object being used.</span></div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment">//</span></div>
<div class="line"><a name="l00206"></a><span class="lineno"><a class="code" href="classXrdOucCacheIO.html#ae482b57ad4dd867c305c6fc360fd5434"> 206</a></span> <span class="keyword">virtual</span> <a class="code" href="classXrdOucCacheIO.html">XrdOucCacheIO</a> *<a class="code" href="classXrdOucCacheIO.html#ae482b57ad4dd867c305c6fc360fd5434">Base</a>() {<span class="keywordflow">return</span> <span class="keyword">this</span>;}</div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> </div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment">// Detach() detaches the object from the cache. It must be called instead of</span></div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment">// using the delete operator since CacheIO objects may have multiple</span></div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment">// outstanding references and actual deletion may need to be defered.</span></div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment">// Detach() returns the underlying CacheIO object when the last</span></div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment">// reference has been removed and 0 otherwise. This allows to say</span></div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment">// something like "delete ioP->Detach()" if you want to make sure you</span></div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment">// delete the underlying object as well. Alternatively, use the optADB</span></div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment">// option when attaching a CacheIO object to a cache. This will delete</span></div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment">// underlying object and always return 0 to avoid a double delete.</span></div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment">// When not fronted by a cache, Detach() always returns itself. This</span></div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment">// makes its use consistent whether or not a cache is employed.</span></div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment">//</span></div>
<div class="line"><a name="l00220"></a><span class="lineno"><a class="code" href="classXrdOucCacheIO.html#a4f4c361d8a575067d5bdeb626993a457"> 220</a></span> <span class="keyword">virtual</span> <a class="code" href="classXrdOucCacheIO.html">XrdOucCacheIO</a> *<a class="code" href="classXrdOucCacheIO.html#a4f4c361d8a575067d5bdeb626993a457">Detach</a>() {<span class="keywordflow">return</span> <span class="keyword">this</span>;}</div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> </div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment">// Preread() places Length bytes into the cache from a data source at Offset.</span></div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment">// When there is no cache or the associated cache does not support or</span></div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment">// allow pre-reads, it's a no-op. Cache placement limits do not apply.</span></div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment">// To maximize parallelism, Peread() should called *after* obtaining</span></div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment">// the wanted bytes using Read(). If the cache implementation supports</span></div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment">// automatic prereads; you can setup parameters on how this should be</span></div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment">// done using the next the next structure and method. The following</span></div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment">// options can be specified:</span></div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment">//</span></div>
<div class="line"><a name="l00231"></a><span class="lineno"><a class="code" href="classXrdOucCacheIO.html#a6993a06bdb058085ebcf42a3d371a79c"> 231</a></span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classXrdOucCacheIO.html#a6993a06bdb058085ebcf42a3d371a79c">SingleUse</a> = 0x0001; <span class="comment">// Mark pages for single use</span></div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span> </div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="keyword">virtual</span></div>
<div class="line"><a name="l00234"></a><span class="lineno"><a class="code" href="classXrdOucCacheIO.html#aa0e2a02c569f7cecc8e612c8330a4618"> 234</a></span> <span class="keywordtype">void</span> <a class="code" href="classXrdOucCacheIO.html#aa0e2a02c569f7cecc8e612c8330a4618">Preread</a> (<span class="keywordtype">long</span> <span class="keywordtype">long</span> Offset, <span class="keywordtype">int</span> Length, <span class="keywordtype">int</span> Opts=0) {}</div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span> </div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment">// The following structure describes automatic preread parameters. These can be</span></div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment">// set at any time for each XrdOucCacheIO object. It can also be specified when</span></div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment">// creating a cache to establish the defaults (see XrdOucCache::Create()).</span></div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment">// Generally, an implementation that supports prereads should disable small</span></div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment">// prereads when minPages or loBound is set to zero; and should disable large</span></div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment">// prereads when maxiRead or maxPages is set to zero. Refer to the actual</span></div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment">// derived class implementation on how the cache handles prereads.</span></div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment">//</span></div>
<div class="line"><a name="l00244"></a><span class="lineno"><a class="code" href="structXrdOucCacheIO_1_1aprParms.html"> 244</a></span> <span class="keyword">struct </span><a class="code" href="structXrdOucCacheIO_1_1aprParms.html">aprParms</a></div>
<div class="line"><a name="l00245"></a><span class="lineno"><a class="code" href="structXrdOucCacheIO_1_1aprParms.html#a5d471e53f5c669b11fa5ec1488811922"> 245</a></span>  {<span class="keywordtype">int</span> <a class="code" href="structXrdOucCacheIO_1_1aprParms.html#a5d471e53f5c669b11fa5ec1488811922">Trigger</a>; <span class="comment">// preread if (rdln < Trigger) (0 -> pagesize+1)</span></div>
<div class="line"><a name="l00246"></a><span class="lineno"><a class="code" href="structXrdOucCacheIO_1_1aprParms.html#a4525d91bd6b47e4a85422f2a2cccce4d"> 246</a></span>  <span class="keywordtype">int</span> <a class="code" href="structXrdOucCacheIO_1_1aprParms.html#a4525d91bd6b47e4a85422f2a2cccce4d">prRecalc</a>; <span class="comment">// Recalc pr efficiency every prRecalc bytes (0->50M)</span></div>
<div class="line"><a name="l00247"></a><span class="lineno"><a class="code" href="structXrdOucCacheIO_1_1aprParms.html#a143f04aef6587a9c3713d9eb51659548"> 247</a></span>  <span class="keywordtype">int</span> <a class="code" href="structXrdOucCacheIO_1_1aprParms.html#a143f04aef6587a9c3713d9eb51659548">Reserve4</a>;</div>
<div class="line"><a name="l00248"></a><span class="lineno"><a class="code" href="structXrdOucCacheIO_1_1aprParms.html#a0dfb6d486584c20949e73d0d957c13f5"> 248</a></span>  <span class="keywordtype">short</span> <a class="code" href="structXrdOucCacheIO_1_1aprParms.html#a0dfb6d486584c20949e73d0d957c13f5">minPages</a>; <span class="comment">// If rdln/pgsz < min, preread minPages (0->off)</span></div>
<div class="line"><a name="l00249"></a><span class="lineno"><a class="code" href="structXrdOucCacheIO_1_1aprParms.html#a7e026de85607dddd42c9436e7a7f446d"> 249</a></span>  <span class="keywordtype">char</span> <a class="code" href="structXrdOucCacheIO_1_1aprParms.html#a7e026de85607dddd42c9436e7a7f446d">minPerf</a>; <span class="comment">// Minimum auto preread performance required (0->n/a)</span></div>
<div class="line"><a name="l00250"></a><span class="lineno"><a class="code" href="structXrdOucCacheIO_1_1aprParms.html#a1f326df35d47ae8501fe4aad690bb999"> 250</a></span>  <span class="keywordtype">char</span> <a class="code" href="structXrdOucCacheIO_1_1aprParms.html#a1f326df35d47ae8501fe4aad690bb999">Reserve1</a>;</div>
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span> </div>
<div class="line"><a name="l00252"></a><span class="lineno"><a class="code" href="structXrdOucCacheIO_1_1aprParms.html#a0471f920ca443315325dff137229d88c"> 252</a></span>  <a class="code" href="structXrdOucCacheIO_1_1aprParms.html#a0471f920ca443315325dff137229d88c">aprParms</a>() : <a class="code" href="structXrdOucCacheIO_1_1aprParms.html#a5d471e53f5c669b11fa5ec1488811922">Trigger</a>(0), <a class="code" href="structXrdOucCacheIO_1_1aprParms.html#a4525d91bd6b47e4a85422f2a2cccce4d">prRecalc</a>(0), <a class="code" href="structXrdOucCacheIO_1_1aprParms.html#a143f04aef6587a9c3713d9eb51659548">Reserve4</a>(0),</div>
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  <a class="code" href="structXrdOucCacheIO_1_1aprParms.html#a0dfb6d486584c20949e73d0d957c13f5">minPages</a>(0), <a class="code" href="structXrdOucCacheIO_1_1aprParms.html#a7e026de85607dddd42c9436e7a7f446d">minPerf</a>(90), <a class="code" href="structXrdOucCacheIO_1_1aprParms.html#a1f326df35d47ae8501fe4aad690bb999">Reserve1</a>(0)</div>
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  {}</div>
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  };</div>
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span> </div>
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="keyword">virtual</span></div>
<div class="line"><a name="l00258"></a><span class="lineno"><a class="code" href="classXrdOucCacheIO.html#a86c55134a5e42c917c2ce042ed189006"> 258</a></span> <span class="keywordtype">void</span> <a class="code" href="classXrdOucCacheIO.html#a86c55134a5e42c917c2ce042ed189006">Preread</a>(<a class="code" href="structXrdOucCacheIO_1_1aprParms.html">aprParms</a> &Parms) {}</div>
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span> </div>
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <span class="comment">// Here is where the stats about cache and I/O usage reside. There</span></div>
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="comment">// is a summary object in the associated cache as well.</span></div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="comment">//</span></div>
<div class="line"><a name="l00263"></a><span class="lineno"><a class="code" href="classXrdOucCacheIO.html#a73824eaf54fecd70b37e47b94bcc9963"> 263</a></span> <a class="code" href="classXrdOucCacheStats.html">XrdOucCacheStats</a> <a class="code" href="classXrdOucCacheIO.html#a73824eaf54fecd70b37e47b94bcc9963">Statistics</a>;</div>
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span> </div>
<div class="line"><a name="l00265"></a><span class="lineno"><a class="code" href="classXrdOucCacheIO.html#a976aa5d5d77f50d75f238d41ed75f54e"> 265</a></span> <span class="keyword">virtual</span> <a class="code" href="classXrdOucCacheIO.html#a976aa5d5d77f50d75f238d41ed75f54e">~XrdOucCacheIO</a>() {} <span class="comment">// Always use Detach() instead of direct delete!</span></div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span> };</div>
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span> </div>
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment">/******************************************************************************/</span></div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment">/* C l a s s X r d O u c C a c h e */</span></div>
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment">/******************************************************************************/</span></div>
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span>  </div>
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment">/* The XrdOucCache class is used to define an instance of a cache. There can</span></div>
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="comment"> be many such instances. Each instance is associated with one or more</span></div>
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment"> XrdOucCacheIO objects. Use the Attach() method in this class to create </span></div>
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="comment"> such associations.</span></div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span> </div>
<div class="line"><a name="l00278"></a><span class="lineno"><a class="code" href="classXrdOucCache.html"> 278</a></span> <span class="keyword">class </span><a class="code" href="classXrdOucCache.html">XrdOucCache</a></div>
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span> {</div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span> </div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="comment">/* Attach() must be called to obtain a new XrdOucCacheIO object that fronts an</span></div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="comment"> existing XrdOucCacheIO object with this cache.</span></div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="comment"> Upon success a pointer to a new XrdOucCacheIO object is returned</span></div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span> <span class="comment"> and must be used to read and write data with the cache interposed.</span></div>
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="comment"> Upon failure, the original XrdOucCacheIO object is returned with</span></div>
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment"> errno set. You can continue using the object without any cache.</span></div>
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment"> The following Attach() options are available and, when specified,</span></div>
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="comment"> override the default options associated with the cache, except for</span></div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment"> optRW, optNEW, and optWIN which are valid only for a r/w cache.</span></div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00292"></a><span class="lineno"><a class="code" href="classXrdOucCache.html#a9085a8c9a3264f9eefbd3cc8e89eb057"> 292</a></span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classXrdOucCache.html#a9085a8c9a3264f9eefbd3cc8e89eb057">optADB</a> = 0x1000; <span class="comment">// Automatically delete underlying CacheIO</span></div>
<div class="line"><a name="l00293"></a><span class="lineno"><a class="code" href="classXrdOucCache.html#afbce220996408bfd5ea464226fd63181"> 293</a></span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classXrdOucCache.html#afbce220996408bfd5ea464226fd63181">optFIS</a> = 0x0001; <span class="comment">// File is Structured (e.g. root file)</span></div>
<div class="line"><a name="l00294"></a><span class="lineno"><a class="code" href="classXrdOucCache.html#a4c511229451009b05f02fb1e7581ba51"> 294</a></span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classXrdOucCache.html#a4c511229451009b05f02fb1e7581ba51">optFIU</a> = 0x0002; <span class="comment">// File is Unstructured (e.g. unix file)</span></div>
<div class="line"><a name="l00295"></a><span class="lineno"><a class="code" href="classXrdOucCache.html#a52905a0e69f11300c131da45c3a1c3fe"> 295</a></span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classXrdOucCache.html#a52905a0e69f11300c131da45c3a1c3fe">optRW</a> = 0x0004; <span class="comment">// File is read/write (o/w read/only)</span></div>
<div class="line"><a name="l00296"></a><span class="lineno"><a class="code" href="classXrdOucCache.html#af89e5e169eec7162cffb8e8f4cb59bec"> 296</a></span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classXrdOucCache.html#af89e5e169eec7162cffb8e8f4cb59bec">optNEW</a> = 0x0014; <span class="comment">// File is new -> optRW (o/w read to write)</span></div>
<div class="line"><a name="l00297"></a><span class="lineno"><a class="code" href="classXrdOucCache.html#ab68a5c8b8f211c8ef8e0f42647c4fe51"> 297</a></span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classXrdOucCache.html#ab68a5c8b8f211c8ef8e0f42647c4fe51">optWIN</a> = 0x0024; <span class="comment">// File is new -> optRW use write-in cache</span></div>
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span> </div>
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="keyword">virtual</span></div>
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <a class="code" href="classXrdOucCacheIO.html">XrdOucCacheIO</a> *<a class="code" href="classXrdOucCache.html#a2645509802c7275ca672abdedb074c6e">Attach</a>(<a class="code" href="classXrdOucCacheIO.html">XrdOucCacheIO</a> *ioP, <span class="keywordtype">int</span> Options=0) = 0;</div>
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span> </div>
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="comment">/* isAttached()</span></div>
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <span class="comment"> Returns the number of CacheIO objects attached to this cache.</span></div>
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span> <span class="comment"> Hence, 0 (false) if none and true otherwise.</span></div>
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="keyword">virtual</span></div>
<div class="line"><a name="l00307"></a><span class="lineno"><a class="code" href="classXrdOucCache.html#a8cc64c5fc2c5650f6d4fe0e61fbaf70d"> 307</a></span> <span class="keywordtype">int</span> <a class="code" href="classXrdOucCache.html#a8cc64c5fc2c5650f6d4fe0e61fbaf70d">isAttached</a>() {<span class="keywordflow">return</span> 0;}</div>
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span> </div>
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment">/* You must first create an instance of a cache using the Create() method.</span></div>
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="comment"> The Parms structure is used to pass parameters about the cache and should</span></div>
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span> <span class="comment"> be filled in with values meaningful to the type of cache being created.</span></div>
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="comment"> The fields below, while oriented toward a memory cache, are sufficiently</span></div>
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="comment"> generic to apply to almost any kind of cache. Refer to the actual</span></div>
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="comment"> implementation in the derived class to see how these values are used.</span></div>
<div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00316"></a><span class="lineno"><a class="code" href="structXrdOucCache_1_1Parms.html"> 316</a></span> <span class="keyword">struct </span><a class="code" href="structXrdOucCache_1_1Parms.html">Parms</a></div>
<div class="line"><a name="l00317"></a><span class="lineno"><a class="code" href="structXrdOucCache_1_1Parms.html#a1d7c69e0a25583cbfe25a1a14bf3416d"> 317</a></span>  {<span class="keywordtype">long</span> <span class="keywordtype">long</span> <a class="code" href="structXrdOucCache_1_1Parms.html#a1d7c69e0a25583cbfe25a1a14bf3416d">CacheSize</a>; <span class="comment">// Size of cache in bytes (default 100MB)</span></div>
<div class="line"><a name="l00318"></a><span class="lineno"><a class="code" href="structXrdOucCache_1_1Parms.html#a375612632899d65160c87bc4fc9d6a30"> 318</a></span>  <span class="keywordtype">int</span> <a class="code" href="structXrdOucCache_1_1Parms.html#a375612632899d65160c87bc4fc9d6a30">PageSize</a>; <span class="comment">// Size of each page in bytes (default 32KB)</span></div>
<div class="line"><a name="l00319"></a><span class="lineno"><a class="code" href="structXrdOucCache_1_1Parms.html#a7d42014c1096233479cf98df50cc40f0"> 319</a></span>  <span class="keywordtype">int</span> <a class="code" href="structXrdOucCache_1_1Parms.html#a7d42014c1096233479cf98df50cc40f0">Max2Cache</a>; <span class="comment">// Largest read to cache (default PageSize)</span></div>
<div class="line"><a name="l00320"></a><span class="lineno"><a class="code" href="structXrdOucCache_1_1Parms.html#a49458dd935838262bae0e3b4d5c5c9de"> 320</a></span>  <span class="keywordtype">int</span> <a class="code" href="structXrdOucCache_1_1Parms.html#a49458dd935838262bae0e3b4d5c5c9de">MaxFiles</a>; <span class="comment">// Maximum number of files (default 256 or 8K)</span></div>
<div class="line"><a name="l00321"></a><span class="lineno"><a class="code" href="structXrdOucCache_1_1Parms.html#af7a2ac158532e8e2b9c71b03f8c6f454"> 321</a></span>  <span class="keywordtype">int</span> <a class="code" href="structXrdOucCache_1_1Parms.html#af7a2ac158532e8e2b9c71b03f8c6f454">Options</a>; <span class="comment">// Options as defined below (default r/o cache)</span></div>
<div class="line"><a name="l00322"></a><span class="lineno"><a class="code" href="structXrdOucCache_1_1Parms.html#a4b0f47ecb66617d143d78969d1966502"> 322</a></span>  <span class="keywordtype">int</span> <a class="code" href="structXrdOucCache_1_1Parms.html#a4b0f47ecb66617d143d78969d1966502">Reserve1</a>; <span class="comment">// Reserved for future use</span></div>
<div class="line"><a name="l00323"></a><span class="lineno"><a class="code" href="structXrdOucCache_1_1Parms.html#ada9a76c3bb50b61382f23f416b7fbd21"> 323</a></span>  <span class="keywordtype">int</span> <a class="code" href="structXrdOucCache_1_1Parms.html#ada9a76c3bb50b61382f23f416b7fbd21">Reserve2</a>; <span class="comment">// Reserved for future use</span></div>
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span> </div>
<div class="line"><a name="l00325"></a><span class="lineno"><a class="code" href="structXrdOucCache_1_1Parms.html#a2007e46868ecae72b4b95a74fbd6c3ef"> 325</a></span>  <a class="code" href="structXrdOucCache_1_1Parms.html#a2007e46868ecae72b4b95a74fbd6c3ef">Parms</a>() : <a class="code" href="structXrdOucCache_1_1Parms.html#a1d7c69e0a25583cbfe25a1a14bf3416d">CacheSize</a>(104857600), <a class="code" href="structXrdOucCache_1_1Parms.html#a375612632899d65160c87bc4fc9d6a30">PageSize</a>(32768),</div>
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span>  <a class="code" href="structXrdOucCache_1_1Parms.html#a7d42014c1096233479cf98df50cc40f0">Max2Cache</a>(0), <a class="code" href="structXrdOucCache_1_1Parms.html#a49458dd935838262bae0e3b4d5c5c9de">MaxFiles</a>(0), <a class="code" href="structXrdOucCache_1_1Parms.html#af7a2ac158532e8e2b9c71b03f8c6f454">Options</a>(0),</div>
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span>  <a class="code" href="structXrdOucCache_1_1Parms.html#a4b0f47ecb66617d143d78969d1966502">Reserve1</a>(0), <a class="code" href="structXrdOucCache_1_1Parms.html#ada9a76c3bb50b61382f23f416b7fbd21">Reserve2</a>(0) {}</div>
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span>  };</div>
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span> </div>
<div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="comment">// Valid option values in Parms::Options</span></div>
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="comment">//</span></div>
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span></div>
<div class="line"><a name="l00333"></a><span class="lineno"><a class="code" href="classXrdOucCache.html#a6e594fd7e7e04e5e7aca9295e06f7304"> 333</a></span> <a class="code" href="classXrdOucCache.html#a6e594fd7e7e04e5e7aca9295e06f7304">isServer</a> = 0x0010; <span class="comment">// This is server application (as opposed to a user app).</span></div>
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span>  <span class="comment">// Appropriate internal optimizations will be used.</span></div>
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span></div>
<div class="line"><a name="l00336"></a><span class="lineno"><a class="code" href="classXrdOucCache.html#a68742f8346e3cde3bd95a64023b2363b"> 336</a></span> <a class="code" href="classXrdOucCache.html#a68742f8346e3cde3bd95a64023b2363b">isStructured</a> = 0x0020; <span class="comment">// Optimize for structured files (e.g. root).</span></div>
<div class="line"><a name="l00337"></a><span class="lineno"> 337</span> </div>
<div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span></div>
<div class="line"><a name="l00339"></a><span class="lineno"><a class="code" href="classXrdOucCache.html#a86291cad9b672a79f27c7c588c783d7c"> 339</a></span> <a class="code" href="classXrdOucCache.html#a86291cad9b672a79f27c7c588c783d7c">canPreRead</a> = 0x0040; <span class="comment">// Enable pre-read operations (o/w ignored)</span></div>
<div class="line"><a name="l00340"></a><span class="lineno"> 340</span> </div>
<div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span></div>
<div class="line"><a name="l00342"></a><span class="lineno"><a class="code" href="classXrdOucCache.html#a99c9c5aef46b7ff58d6a0d6c0439fe72"> 342</a></span> <a class="code" href="classXrdOucCache.html#a99c9c5aef46b7ff58d6a0d6c0439fe72">logStats</a> = 0x0080; <span class="comment">// Display statistics upon detach</span></div>
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span> </div>
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span></div>
<div class="line"><a name="l00345"></a><span class="lineno"><a class="code" href="classXrdOucCache.html#a961257bc0575b8db8cd1cfa596df9ee3"> 345</a></span> <a class="code" href="classXrdOucCache.html#a961257bc0575b8db8cd1cfa596df9ee3">Serialized</a> = 0x0004; <span class="comment">// Caller ensures MRSW semantics</span></div>
<div class="line"><a name="l00346"></a><span class="lineno"> 346</span> </div>
<div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span></div>
<div class="line"><a name="l00348"></a><span class="lineno"><a class="code" href="classXrdOucCache.html#aed005f96670ad756895c4f926f66bd3c"> 348</a></span> <a class="code" href="classXrdOucCache.html#aed005f96670ad756895c4f926f66bd3c">ioMTSafe</a> = 0x0008; <span class="comment">// CacheIO object is MT-safe</span></div>
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span> </div>
<div class="line"><a name="l00350"></a><span class="lineno"> 350</span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span></div>
<div class="line"><a name="l00351"></a><span class="lineno"><a class="code" href="classXrdOucCache.html#ae43d280875bb74b1fb1164a5f3df85a0"> 351</a></span> <a class="code" href="classXrdOucCache.html#ae43d280875bb74b1fb1164a5f3df85a0">Debug</a> = 0x0003; <span class="comment">// Produce some debug messages (levels 0, 1, 2, or 3)</span></div>
<div class="line"><a name="l00352"></a><span class="lineno"> 352</span> </div>
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span> <span class="comment">/* Create() Creates an instance of a cache using the specified parameters.</span></div>
<div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="comment"> You must pass the cache parms and optionally any automatic</span></div>
<div class="line"><a name="l00355"></a><span class="lineno"> 355</span> <span class="comment"> pre-read parameters that will be used as future defaults.</span></div>
<div class="line"><a name="l00356"></a><span class="lineno"> 356</span> <span class="comment"> Upon success, returns a pointer to the cache. Otherwise, a null</span></div>
<div class="line"><a name="l00357"></a><span class="lineno"> 357</span> <span class="comment"> pointer is returned with errno set to indicate the problem.</span></div>
<div class="line"><a name="l00358"></a><span class="lineno"> 358</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <span class="keyword">virtual</span></div>
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span> <a class="code" href="classXrdOucCache.html">XrdOucCache</a> *<a class="code" href="classXrdOucCache.html#af80904bdb3dba94d56a1ad468f659f5b">Create</a>(<a class="code" href="structXrdOucCache_1_1Parms.html">Parms</a> &Params, <a class="code" href="structXrdOucCacheIO_1_1aprParms.html">XrdOucCacheIO::aprParms</a> *aprP=0) = 0;</div>
<div class="line"><a name="l00361"></a><span class="lineno"> 361</span> </div>
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span> <span class="comment">/* The following holds statistics for the cache itself. It is updated as</span></div>
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span> <span class="comment"> associated cacheIO objects are deleted and their statistics are added.</span></div>
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00365"></a><span class="lineno"><a class="code" href="classXrdOucCache.html#a89b2615554dc1099c278bb49fdb9fb80"> 365</a></span> <a class="code" href="classXrdOucCacheStats.html">XrdOucCacheStats</a> <a class="code" href="classXrdOucCache.html#a89b2615554dc1099c278bb49fdb9fb80">Stats</a>;</div>
<div class="line"><a name="l00366"></a><span class="lineno"> 366</span> </div>
<div class="line"><a name="l00367"></a><span class="lineno"><a class="code" href="classXrdOucCache.html#a68460197899d19bbab031e4006c53850"> 367</a></span>  <a class="code" href="classXrdOucCache.html#a68460197899d19bbab031e4006c53850">XrdOucCache</a>() {}</div>
<div class="line"><a name="l00368"></a><span class="lineno"><a class="code" href="classXrdOucCache.html#a920019fb8bc6cf710a2b71810cae6dfc"> 368</a></span> <span class="keyword">virtual</span> <a class="code" href="classXrdOucCache.html#a920019fb8bc6cf710a2b71810cae6dfc">~XrdOucCache</a>() {}</div>
<div class="line"><a name="l00369"></a><span class="lineno"> 369</span> };</div>
<div class="line"><a name="l00370"></a><span class="lineno"> 370</span> </div>
<div class="line"><a name="l00371"></a><span class="lineno"> 371</span> <span class="comment">/******************************************************************************/</span></div>
<div class="line"><a name="l00372"></a><span class="lineno"> 372</span> <span class="comment">/* C r e a t i n g C a c h e P l u g - I n s */</span></div>
<div class="line"><a name="l00373"></a><span class="lineno"> 373</span> <span class="comment">/******************************************************************************/</span></div>
<div class="line"><a name="l00374"></a><span class="lineno"> 374</span>  </div>
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span> <span class="comment">/* You can create a cache plug-in for those parts of the xrootd system that</span></div>
<div class="line"><a name="l00376"></a><span class="lineno"> 376</span> <span class="comment"> allow a dynamically selectable cache implementation (e.g. the proxy server</span></div>
<div class="line"><a name="l00377"></a><span class="lineno"> 377</span> <span class="comment"> plug-in supports cache plug-ins via the pss.cachelib directive).</span></div>
<div class="line"><a name="l00378"></a><span class="lineno"> 378</span> <span class="comment"></span></div>
<div class="line"><a name="l00379"></a><span class="lineno"> 379</span> <span class="comment"> Your plug-in must exist in a shared library and have the following extern C</span></div>
<div class="line"><a name="l00380"></a><span class="lineno"> 380</span> <span class="comment"> function defined:</span></div>
<div class="line"><a name="l00381"></a><span class="lineno"> 381</span> <span class="comment"></span></div>
<div class="line"><a name="l00382"></a><span class="lineno"> 382</span> <span class="comment"> extern "C"</span></div>
<div class="line"><a name="l00383"></a><span class="lineno"> 383</span> <span class="comment"> {</span></div>
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span> <span class="comment"> XrdOucCache *XrdOucGetCache(XrdSysLogger *Logger, // Where messages go</span></div>
<div class="line"><a name="l00385"></a><span class="lineno"> 385</span> <span class="comment"> const char *Config, // Config file used</span></div>
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span> <span class="comment"> const char *Parms); // Optional parm string</span></div>
<div class="line"><a name="l00387"></a><span class="lineno"> 387</span> <span class="comment"> }</span></div>
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span> <span class="comment"></span></div>
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span> <span class="comment"> When Logger is null, you should use cerr to output messages. Otherwise,</span></div>
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span> <span class="comment"> tie an instance XrdSysError to the passed logger.</span></div>
<div class="line"><a name="l00391"></a><span class="lineno"> 391</span> <span class="comment"> When Config is null, no configuration file is present. Otherwise, you need</span></div>
<div class="line"><a name="l00392"></a><span class="lineno"> 392</span> <span class="comment"> additional configuration information you should get it</span></div>
<div class="line"><a name="l00393"></a><span class="lineno"> 393</span> <span class="comment"> from that file in order to support single configuration.</span></div>
<div class="line"><a name="l00394"></a><span class="lineno"> 394</span> <span class="comment"> When Parms is null, no parameter string was specified.</span></div>
<div class="line"><a name="l00395"></a><span class="lineno"> 395</span> <span class="comment"></span></div>
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span> <span class="comment"> The call should return an instance of an XrdOucCache object upon success and</span></div>
<div class="line"><a name="l00397"></a><span class="lineno"> 397</span> <span class="comment"> a null pointer otherwise. The instance is used to create actual caches using</span></div>
<div class="line"><a name="l00398"></a><span class="lineno"> 398</span> <span class="comment"> the object's Create() method.</span></div>
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00400"></a><span class="lineno"> 400</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
>
278
