OSS_SNMP.Cache.html 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164
  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_SNMP.html"><i class="icon-th"></i> OSS_SNMP</a></li>
  24. </ul>
  25. </li>
  26. <li class="dropdown" id="charts-menu">
  27. <a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
  28. 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>
  29. </li>
  30. <li class="dropdown" id="reports-menu">
  31. <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
  32. Reports <b class="caret"></b></a><ul class="dropdown-menu">
  33. <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
  34. <span class="label label-info">39</span></a></li>
  35. <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
  36. <ul><li>todo 
  37. <span class="label label-info">1</span>
  38. </li></ul></a></li>
  39. <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
  40. <span class="label label-info">0</span></a></li>
  41. </ul>
  42. </li>
  43. </ul></div>
  44. </div></div>
  45. <div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
  46. </div>
  47. <div id="___" class="container">
  48. <noscript><div class="alert alert-warning">
  49. Javascript is disabled; several features are only available
  50. if Javascript is enabled.
  51. </div></noscript>
  52. <div class="row">
  53. <div class="span4">
  54. <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">
  55. <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>
  56. </div>
  57. <ul class="side-nav nav nav-list">
  58. <li class="nav-header">
  59. <i class="icon-custom icon-method"></i> Methods</li>
  60. <li class="nav-header protected">» Protected</li>
  61. <li class="method protected "><a href="#clear" title="clear :: "><span class="description">clear()
  62. </span><pre>clear()</pre></a></li>
  63. <li class="method protected "><a href="#clearAll" title="clearAll :: "><span class="description">clearAll()
  64. </span><pre>clearAll()</pre></a></li>
  65. <li class="method protected "><a href="#load" title="load :: "><span class="description">load()
  66. </span><pre>load()</pre></a></li>
  67. <li class="method protected "><a href="#save" title="save :: "><span class="description">save()
  68. </span><pre>save()</pre></a></li>
  69. </ul>
  70. </div>
  71. <div class="span8">
  72. <a name="%5COSS_SNMP%5CCache" id="\OSS_SNMP\Cache"></a><ul class="breadcrumb">
  73. <li>
  74. <a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
  75. </li>
  76. <li><a href="../namespaces/OSS_SNMP.html">OSS_SNMP</a></li>
  77. <li class="active">
  78. <span class="divider">\</span><a href="../classes/OSS_SNMP.Cache.html">Cache</a>
  79. </li>
  80. </ul>
  81. <div href="../classes/OSS_SNMP.Cache.html" class="element class">
  82. <p class="short_description">An abstract cache for storing results of SNMP queries .</p>
  83. <div class="details">
  84. <p class="long_description"><p>See the implementation in \OSS_SNMP\Cache\Basic for proper examples and documentation.</p></p>
  85. <table class="table table-bordered">
  86. <tr>
  87. <th>see</th>
  88. <td>\OSS_SNMP\Cache\Basic</td>
  89. </tr>
  90. <tr>
  91. <th>copyright</th>
  92. <td>Copyright (c) 2012, Open Source Solutions Limited, Dublin, Ireland</td>
  93. </tr>
  94. <tr>
  95. <th>author</th>
  96. <td><a href="mailto:barry@opensolutions.ie">Barry O'Donovan</a></td>
  97. </tr>
  98. </table>
  99. <h3>
  100. <i class="icon-custom icon-method"></i> Methods</h3>
  101. <a name="clear" id="clear"></a><div class="element clickable method protected clear" data-toggle="collapse" data-target=".clear .collapse">
  102. <h2>clear()
  103. </h2>
  104. <pre>clear($varName) </pre>
  105. <div class="labels"></div>
  106. <div class="row collapse"><div class="detail-description">
  107. <p class="long_description"></p>
  108. <h3>Parameters</h3>
  109. <div class="subelement argument">
  110. <h4>$varName</h4>
  111. <code></code>
  112. </div>
  113. </div></div>
  114. </div>
  115. <a name="clearAll" id="clearAll"></a><div class="element clickable method protected clearAll" data-toggle="collapse" data-target=".clearAll .collapse">
  116. <h2>clearAll()
  117. </h2>
  118. <pre>clearAll() </pre>
  119. <div class="labels"></div>
  120. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  121. </div>
  122. <a name="load" id="load"></a><div class="element clickable method protected load" data-toggle="collapse" data-target=".load .collapse">
  123. <h2>load()
  124. </h2>
  125. <pre>load($varName) </pre>
  126. <div class="labels"></div>
  127. <div class="row collapse"><div class="detail-description">
  128. <p class="long_description"></p>
  129. <h3>Parameters</h3>
  130. <div class="subelement argument">
  131. <h4>$varName</h4>
  132. <code></code>
  133. </div>
  134. </div></div>
  135. </div>
  136. <a name="save" id="save"></a><div class="element clickable method protected save" data-toggle="collapse" data-target=".save .collapse">
  137. <h2>save()
  138. </h2>
  139. <pre>save($varName, $varValue) </pre>
  140. <div class="labels"></div>
  141. <div class="row collapse"><div class="detail-description">
  142. <p class="long_description"></p>
  143. <h3>Parameters</h3>
  144. <div class="subelement argument">
  145. <h4>$varName</h4>
  146. <code></code>
  147. </div>
  148. <div class="subelement argument">
  149. <h4>$varValue</h4>
  150. <code></code>
  151. </div>
  152. </div></div>
  153. </div>
  154. </div>
  155. </div>
  156. </div>
  157. </div>
  158. <div class="row"><footer class="span12">
  159. 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>
  160. Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a5</a> and<br>
  161. generated on 2012-06-22T10:05:27+01:00.<br></footer></div>
  162. </div>
  163. </body>
  164. </html>