<!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 Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="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 class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#nested-classes">Classes</a> | <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-attribs">Public Attributes</a> | <a href="#pub-static-attribs">Static Public Attributes</a> | <a href="classXrdOucCache-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">XrdOucCache Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="XrdOucCache_8hh_source.html">XrdOucCache.hh</a>></code></p> <div class="dynheader"> Collaboration diagram for XrdOucCache:</div> <div class="dyncontent"> <div class="center"><img src="classXrdOucCache__coll__graph.png" border="0" usemap="#XrdOucCache_coll__map" alt="Collaboration graph"/></div> <map name="XrdOucCache_coll__map" id="XrdOucCache_coll__map"> <area shape="rect" id="node2" href="classXrdOucCacheStats.html" title="XrdOucCacheStats" alt="" coords="5,96,139,123"/><area shape="rect" id="node4" href="classXrdSysMutex.html" title="XrdSysMutex" alt="" coords="21,5,123,32"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Classes</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structXrdOucCache_1_1Parms.html">Parms</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a2645509802c7275ca672abdedb074c6e"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classXrdOucCacheIO.html">XrdOucCacheIO</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdOucCache.html#a2645509802c7275ca672abdedb074c6e">Attach</a> (<a class="el" href="classXrdOucCacheIO.html">XrdOucCacheIO</a> *ioP, int Options=0)=0</td></tr> <tr class="separator:a2645509802c7275ca672abdedb074c6e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8cc64c5fc2c5650f6d4fe0e61fbaf70d"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdOucCache.html#a8cc64c5fc2c5650f6d4fe0e61fbaf70d">isAttached</a> ()</td></tr> <tr class="separator:a8cc64c5fc2c5650f6d4fe0e61fbaf70d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af80904bdb3dba94d56a1ad468f659f5b"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classXrdOucCache.html">XrdOucCache</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdOucCache.html#af80904bdb3dba94d56a1ad468f659f5b">Create</a> (<a class="el" href="structXrdOucCache_1_1Parms.html">Parms</a> &Params, <a class="el" href="structXrdOucCacheIO_1_1aprParms.html">XrdOucCacheIO::aprParms</a> *aprP=0)=0</td></tr> <tr class="separator:af80904bdb3dba94d56a1ad468f659f5b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a68460197899d19bbab031e4006c53850"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdOucCache.html#a68460197899d19bbab031e4006c53850">XrdOucCache</a> ()</td></tr> <tr class="separator:a68460197899d19bbab031e4006c53850"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a920019fb8bc6cf710a2b71810cae6dfc"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdOucCache.html#a920019fb8bc6cf710a2b71810cae6dfc">~XrdOucCache</a> ()</td></tr> <tr class="separator:a920019fb8bc6cf710a2b71810cae6dfc"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> Public Attributes</h2></td></tr> <tr class="memitem:a89b2615554dc1099c278bb49fdb9fb80"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXrdOucCacheStats.html">XrdOucCacheStats</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdOucCache.html#a89b2615554dc1099c278bb49fdb9fb80">Stats</a></td></tr> <tr class="separator:a89b2615554dc1099c278bb49fdb9fb80"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a> Static Public Attributes</h2></td></tr> <tr class="memitem:a9085a8c9a3264f9eefbd3cc8e89eb057"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdOucCache.html#a9085a8c9a3264f9eefbd3cc8e89eb057">optADB</a> = 0x1000</td></tr> <tr class="separator:a9085a8c9a3264f9eefbd3cc8e89eb057"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:afbce220996408bfd5ea464226fd63181"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdOucCache.html#afbce220996408bfd5ea464226fd63181">optFIS</a> = 0x0001</td></tr> <tr class="separator:afbce220996408bfd5ea464226fd63181"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4c511229451009b05f02fb1e7581ba51"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdOucCache.html#a4c511229451009b05f02fb1e7581ba51">optFIU</a> = 0x0002</td></tr> <tr class="separator:a4c511229451009b05f02fb1e7581ba51"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a52905a0e69f11300c131da45c3a1c3fe"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdOucCache.html#a52905a0e69f11300c131da45c3a1c3fe">optRW</a> = 0x0004</td></tr> <tr class="separator:a52905a0e69f11300c131da45c3a1c3fe"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af89e5e169eec7162cffb8e8f4cb59bec"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdOucCache.html#af89e5e169eec7162cffb8e8f4cb59bec">optNEW</a> = 0x0014</td></tr> <tr class="separator:af89e5e169eec7162cffb8e8f4cb59bec"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab68a5c8b8f211c8ef8e0f42647c4fe51"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdOucCache.html#ab68a5c8b8f211c8ef8e0f42647c4fe51">optWIN</a> = 0x0024</td></tr> <tr class="separator:ab68a5c8b8f211c8ef8e0f42647c4fe51"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6e594fd7e7e04e5e7aca9295e06f7304"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdOucCache.html#a6e594fd7e7e04e5e7aca9295e06f7304">isServer</a> = 0x0010</td></tr> <tr class="separator:a6e594fd7e7e04e5e7aca9295e06f7304"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a68742f8346e3cde3bd95a64023b2363b"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdOucCache.html#a68742f8346e3cde3bd95a64023b2363b">isStructured</a> = 0x0020</td></tr> <tr class="separator:a68742f8346e3cde3bd95a64023b2363b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a86291cad9b672a79f27c7c588c783d7c"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdOucCache.html#a86291cad9b672a79f27c7c588c783d7c">canPreRead</a> = 0x0040</td></tr> <tr class="separator:a86291cad9b672a79f27c7c588c783d7c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a99c9c5aef46b7ff58d6a0d6c0439fe72"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdOucCache.html#a99c9c5aef46b7ff58d6a0d6c0439fe72">logStats</a> = 0x0080</td></tr> <tr class="separator:a99c9c5aef46b7ff58d6a0d6c0439fe72"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a961257bc0575b8db8cd1cfa596df9ee3"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdOucCache.html#a961257bc0575b8db8cd1cfa596df9ee3">Serialized</a> = 0x0004</td></tr> <tr class="separator:a961257bc0575b8db8cd1cfa596df9ee3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aed005f96670ad756895c4f926f66bd3c"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdOucCache.html#aed005f96670ad756895c4f926f66bd3c">ioMTSafe</a> = 0x0008</td></tr> <tr class="separator:aed005f96670ad756895c4f926f66bd3c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae43d280875bb74b1fb1164a5f3df85a0"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdOucCache.html#ae43d280875bb74b1fb1164a5f3df85a0">Debug</a> = 0x0003</td></tr> <tr class="separator:ae43d280875bb74b1fb1164a5f3df85a0"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a68460197899d19bbab031e4006c53850"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">XrdOucCache::XrdOucCache </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a920019fb8bc6cf710a2b71810cae6dfc"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual XrdOucCache::~XrdOucCache </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a2645509802c7275ca672abdedb074c6e"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="classXrdOucCacheIO.html">XrdOucCacheIO</a>* XrdOucCache::Attach </td> <td>(</td> <td class="paramtype"><a class="el" href="classXrdOucCacheIO.html">XrdOucCacheIO</a> * </td> <td class="paramname"><em>ioP</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>Options</em> = <code>0</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="af80904bdb3dba94d56a1ad468f659f5b"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="classXrdOucCache.html">XrdOucCache</a>* XrdOucCache::Create </td> <td>(</td> <td class="paramtype"><a class="el" href="structXrdOucCache_1_1Parms.html">Parms</a> & </td> <td class="paramname"><em>Params</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="structXrdOucCacheIO_1_1aprParms.html">XrdOucCacheIO::aprParms</a> * </td> <td class="paramname"><em>aprP</em> = <code>0</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a8cc64c5fc2c5650f6d4fe0e61fbaf70d"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual int XrdOucCache::isAttached </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <h2 class="groupheader">Member Data Documentation</h2> <a class="anchor" id="a86291cad9b672a79f27c7c588c783d7c"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const int XrdOucCache::canPreRead = 0x0040</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="ae43d280875bb74b1fb1164a5f3df85a0"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const int XrdOucCache::Debug = 0x0003</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="aed005f96670ad756895c4f926f66bd3c"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const int XrdOucCache::ioMTSafe = 0x0008</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a6e594fd7e7e04e5e7aca9295e06f7304"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const int XrdOucCache::isServer = 0x0010</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a68742f8346e3cde3bd95a64023b2363b"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const int XrdOucCache::isStructured = 0x0020</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a99c9c5aef46b7ff58d6a0d6c0439fe72"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const int XrdOucCache::logStats = 0x0080</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a9085a8c9a3264f9eefbd3cc8e89eb057"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const int XrdOucCache::optADB = 0x1000</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="afbce220996408bfd5ea464226fd63181"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const int XrdOucCache::optFIS = 0x0001</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a4c511229451009b05f02fb1e7581ba51"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const int XrdOucCache::optFIU = 0x0002</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="af89e5e169eec7162cffb8e8f4cb59bec"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const int XrdOucCache::optNEW = 0x0014</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a52905a0e69f11300c131da45c3a1c3fe"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const int XrdOucCache::optRW = 0x0004</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="ab68a5c8b8f211c8ef8e0f42647c4fe51"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const int XrdOucCache::optWIN = 0x0024</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a961257bc0575b8db8cd1cfa596df9ee3"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const int XrdOucCache::Serialized = 0x0004</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a89b2615554dc1099c278bb49fdb9fb80"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classXrdOucCacheStats.html">XrdOucCacheStats</a> XrdOucCache::Stats</td> </tr> </table> </div><div class="memdoc"> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="XrdOucCache_8hh_source.html">XrdOucCache.hh</a></li> </ul> </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>