OSS_SNMP.Cache.html 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165
  1. <!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  4. <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
  5. <meta charset="utf-8">
  6. <title>OSS_SNMP » \OSS_SNMP\Cache</title>
  7. <meta name="author" content="Mike van Riel">
  8. <meta name="description" content="">
  9. <link href="../css/template.css" rel="stylesheet" media="all">
  10. <script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
  11. <link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
  12. <link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
  13. <link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
  14. </head>
  15. <body>
  16. <div class="navbar navbar-fixed-top">
  17. <div class="navbar-inner"><div class="container">
  18. <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">OSS_SNMP</a><div class="nav-collapse"><ul class="nav">
  19. <li class="dropdown">
  20. <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
  21. API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
  22. <li><a>Namespaces</a></li>
  23. <li><a href="../namespaces/OSS.html"><i class="icon-th"></i> OSS</a></li>
  24. <li><a href="../namespaces/OSS_SNMP.html"><i class="icon-th"></i> OSS_SNMP</a></li>
  25. </ul>
  26. </li>
  27. <li class="dropdown" id="charts-menu">
  28. <a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
  29. Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
  30. </li>
  31. <li class="dropdown" id="reports-menu">
  32. <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
  33. Reports <b class="caret"></b></a><ul class="dropdown-menu">
  34. <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
  35. <span class="label label-info">32</span></a></li>
  36. <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
  37. <ul><li>todo 
  38. <span class="label label-info">1</span>
  39. </li></ul></a></li>
  40. <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
  41. <span class="label label-info">0</span></a></li>
  42. </ul>
  43. </li>
  44. </ul></div>
  45. </div></div>
  46. <div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
  47. </div>
  48. <div id="___" class="container">
  49. <noscript><div class="alert alert-warning">
  50. Javascript is disabled; several features are only available
  51. if Javascript is enabled.
  52. </div></noscript>
  53. <div class="row">
  54. <div class="span4">
  55. <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
  56. <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
  57. </div>
  58. <ul class="side-nav nav nav-list">
  59. <li class="nav-header">
  60. <i class="icon-custom icon-method"></i> Methods</li>
  61. <li class="nav-header protected">» Protected</li>
  62. <li class="method protected "><a href="#clear" title="clear :: "><span class="description">clear()
  63. </span><pre>clear()</pre></a></li>
  64. <li class="method protected "><a href="#clearAll" title="clearAll :: "><span class="description">clearAll()
  65. </span><pre>clearAll()</pre></a></li>
  66. <li class="method protected "><a href="#load" title="load :: "><span class="description">load()
  67. </span><pre>load()</pre></a></li>
  68. <li class="method protected "><a href="#save" title="save :: "><span class="description">save()
  69. </span><pre>save()</pre></a></li>
  70. </ul>
  71. </div>
  72. <div class="span8">
  73. <a name="%5COSS_SNMP%5CCache" id="\OSS_SNMP\Cache"></a><ul class="breadcrumb">
  74. <li>
  75. <a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
  76. </li>
  77. <li><a href="../namespaces/OSS_SNMP.html">OSS_SNMP</a></li>
  78. <li class="active">
  79. <span class="divider">\</span><a href="../classes/OSS_SNMP.Cache.html">Cache</a>
  80. </li>
  81. </ul>
  82. <div href="../classes/OSS_SNMP.Cache.html" class="element class">
  83. <p class="short_description">An abstract cache for storing results of SNMP queries .</p>
  84. <div class="details">
  85. <p class="long_description"><p>See the implementation in \OSS\Cache\Basic for proper examples and documentation.</p></p>
  86. <table class="table table-bordered">
  87. <tr>
  88. <th>see</th>
  89. <td>\OSS\Cache\Basic</td>
  90. </tr>
  91. <tr>
  92. <th>copyright</th>
  93. <td>Copyright (c) 2012, Open Source Solutions Limited, Dublin, Ireland</td>
  94. </tr>
  95. <tr>
  96. <th>author</th>
  97. <td><a href="mailto:barry@opensolutions.ie">Barry O'Donovan</a></td>
  98. </tr>
  99. </table>
  100. <h3>
  101. <i class="icon-custom icon-method"></i> Methods</h3>
  102. <a name="clear" id="clear"></a><div class="element clickable method protected clear" data-toggle="collapse" data-target=".clear .collapse">
  103. <h2>clear()
  104. </h2>
  105. <pre>clear($varName) </pre>
  106. <div class="labels"></div>
  107. <div class="row collapse"><div class="detail-description">
  108. <p class="long_description"></p>
  109. <h3>Parameters</h3>
  110. <div class="subelement argument">
  111. <h4>$varName</h4>
  112. <code></code>
  113. </div>
  114. </div></div>
  115. </div>
  116. <a name="clearAll" id="clearAll"></a><div class="element clickable method protected clearAll" data-toggle="collapse" data-target=".clearAll .collapse">
  117. <h2>clearAll()
  118. </h2>
  119. <pre>clearAll() </pre>
  120. <div class="labels"></div>
  121. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  122. </div>
  123. <a name="load" id="load"></a><div class="element clickable method protected load" data-toggle="collapse" data-target=".load .collapse">
  124. <h2>load()
  125. </h2>
  126. <pre>load($varName) </pre>
  127. <div class="labels"></div>
  128. <div class="row collapse"><div class="detail-description">
  129. <p class="long_description"></p>
  130. <h3>Parameters</h3>
  131. <div class="subelement argument">
  132. <h4>$varName</h4>
  133. <code></code>
  134. </div>
  135. </div></div>
  136. </div>
  137. <a name="save" id="save"></a><div class="element clickable method protected save" data-toggle="collapse" data-target=".save .collapse">
  138. <h2>save()
  139. </h2>
  140. <pre>save($varName, $varValue) </pre>
  141. <div class="labels"></div>
  142. <div class="row collapse"><div class="detail-description">
  143. <p class="long_description"></p>
  144. <h3>Parameters</h3>
  145. <div class="subelement argument">
  146. <h4>$varName</h4>
  147. <code></code>
  148. </div>
  149. <div class="subelement argument">
  150. <h4>$varValue</h4>
  151. <code></code>
  152. </div>
  153. </div></div>
  154. </div>
  155. </div>
  156. </div>
  157. </div>
  158. </div>
  159. <div class="row"><footer class="span12">
  160. Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
  161. Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a5</a> and<br>
  162. generated on 2012-06-20T19:41:09+01:00.<br></footer></div>
  163. </div>
  164. </body>
  165. </html>