Files
wpscan/doc_yard/TyphoeusCache.html
Christian Mehlmauer cd5b45f98b docs
2013-06-09 16:07:04 +02:00

265 lines
7.5 KiB
HTML

<!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" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Class: TyphoeusCache
&mdash; Documentation by YARD 0.8.6.1
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '';
framesUrl = "frames.html#!" + escape(window.location.href);
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="_index.html">Index (T)</a> &raquo;
<span class="title">TyphoeusCache</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Class: TyphoeusCache
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName"><span class='object_link'><a href="CacheFileStore.html" title="CacheFileStore (class)">CacheFileStore</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="CacheFileStore.html" title="CacheFileStore (class)">CacheFileStore</a></span></li>
<li class="next">TyphoeusCache</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/common/typhoeus_cache.rb</dd>
</dl>
<div class="clear"></div>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="CacheFileStore.html" title="CacheFileStore (class)">CacheFileStore</a></span></h3>
<p class="inherited"><span class='object_link'><a href="CacheFileStore.html#serializer-instance_method" title="CacheFileStore#serializer (method)">#serializer</a></span>, <span class='object_link'><a href="CacheFileStore.html#storage_path-instance_method" title="CacheFileStore#storage_path (method)">#storage_path</a></span></p>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#get-instance_method" title="#get (instance method)">- (Object) <strong>get</strong>(request) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#set-instance_method" title="#set (instance method)">- (Object) <strong>set</strong>(request, response) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="CacheFileStore.html" title="CacheFileStore (class)">CacheFileStore</a></span></h3>
<p class="inherited"><span class='object_link'><a href="CacheFileStore.html#clean-instance_method" title="CacheFileStore#clean (method)">#clean</a></span>, <span class='object_link'><a href="CacheFileStore.html#get_entry_file_path-instance_method" title="CacheFileStore#get_entry_file_path (method)">#get_entry_file_path</a></span>, <span class='object_link'><a href="CacheFileStore.html#initialize-instance_method" title="CacheFileStore#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="CacheFileStore.html#read_entry-instance_method" title="CacheFileStore#read_entry (method)">#read_entry</a></span>, <span class='object_link'><a href="CacheFileStore.html#write_entry-instance_method" title="CacheFileStore#write_entry (method)">#write_entry</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="CacheFileStore.html#initialize-instance_method" title="CacheFileStore#initialize (method)">CacheFileStore</a></span></p>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="get-instance_method">
- (<tt>Object</tt>) <strong>get</strong>(request)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
18
19
20</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/typhoeus_cache.rb', line 18</span>
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
<span class='id identifier rubyid_read_entry'>read_entry</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_cache_key'>cache_key</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="set-instance_method">
- (<tt>Object</tt>) <strong>set</strong>(request, response)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
22
23
24</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/typhoeus_cache.rb', line 22</span>
<span class='kw'>def</span> <span class='id identifier rubyid_set'>set</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
<span class='id identifier rubyid_write_entry'>write_entry</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_cache_key'>cache_key</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_cache_ttl'>cache_ttl</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Jun 9 16:05:18 2013 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.6.1 (ruby-1.9.3).
</div>
</body>
</html>