| Current File : //proc/thread-self/root/kunden/usr/share/gems/doc/memcache-client-1.8.5/rdoc/Cache.html |
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module Cache - memcache-client-1.8.5 Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "./";
var index_rel_prefix = "./";
</script>
<script src="./js/navigation.js" defer></script>
<script src="./js/search.js" defer></script>
<script src="./js/search_index.js" defer></script>
<script src="./js/searcher.js" defer></script>
<script src="./js/darkfish.js" defer></script>
<link href="./css/fonts.css" rel="stylesheet">
<link href="./css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="module">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="./index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="./table_of_contents.html#pages">Pages</a>
<a href="./table_of_contents.html#classes">Classes</a>
<a href="./table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-add">::add</a>
<li ><a href="#method-c-delete">::delete</a>
<li ><a href="#method-c-get">::get</a>
<li ><a href="#method-c-logger">::logger</a>
<li ><a href="#method-c-put">::put</a>
<li ><a href="#method-c-reset">::reset</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-Cache">
<h1 id="module-Cache" class="module">
module Cache
</h1>
<section class="description">
<p>A utility wrapper around the <a href="MemCache.html"><code>MemCache</code></a> client to simplify cache access. All methods silently ignore <a href="MemCache.html"><code>MemCache</code></a> errors.</p>
<p>This API is deprecated, please use the Rails.cache API or your own wrapper API around <a href="MemCache.html"><code>MemCache</code></a>.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-add" class="method-detail ">
<div class="method-heading">
<span class="method-name">add</span><span
class="method-args">(key, value, expiry = 0)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets <code>value</code> in the cache at <code>key</code>, with an optional <code>expiry</code> time in seconds. If <code>key</code> already exists in cache, returns nil.</p>
<div class="method-source-code" id="add-source">
<pre><span class="ruby-comment"># File lib/memcache_util.rb, line 69</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">add</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>, <span class="ruby-identifier">expiry</span> = <span class="ruby-value">0</span>)
<span class="ruby-identifier">start_time</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>
<span class="ruby-identifier">response</span> = <span class="ruby-constant">CACHE</span>.<span class="ruby-identifier">add</span> <span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>, <span class="ruby-identifier">expiry</span>
<span class="ruby-identifier">elapsed</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">start_time</span>
<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-string">'MemCache Add (%0.6f) %s'</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">elapsed</span>, <span class="ruby-identifier">key</span>])
(<span class="ruby-identifier">response</span> <span class="ruby-operator">==</span> <span class="ruby-string">"STORED\r\n"</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">value</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">MemCache</span><span class="ruby-operator">::</span><span class="ruby-constant">MemCacheError</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">err</span>
<span class="ruby-constant">ActiveRecord</span><span class="ruby-operator">::</span><span class="ruby-constant">Base</span>.<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"MemCache Error: #{err.message}"</span>
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-delete" class="method-detail ">
<div class="method-heading">
<span class="method-name">delete</span><span
class="method-args">(key, delay = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Deletes <code>key</code> from the cache in <code>delay</code> seconds.</p>
<div class="method-source-code" id="delete-source">
<pre><span class="ruby-comment"># File lib/memcache_util.rb, line 83</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">delete</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">delay</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">start_time</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>
<span class="ruby-constant">CACHE</span>.<span class="ruby-identifier">delete</span> <span class="ruby-identifier">key</span>, <span class="ruby-identifier">delay</span>
<span class="ruby-identifier">elapsed</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">start_time</span>
<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-string">'MemCache Delete (%0.6f) %s'</span> <span class="ruby-operator">%</span>
[<span class="ruby-identifier">elapsed</span>, <span class="ruby-identifier">key</span>])
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">MemCache</span><span class="ruby-operator">::</span><span class="ruby-constant">MemCacheError</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">err</span>
<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"MemCache Error: #{err.message}"</span>
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-get" class="method-detail ">
<div class="method-heading">
<span class="method-name">get</span><span
class="method-args">(key, expiry = 0) { || ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the object at <code>key</code> from the cache if successful, or nil if either the object is not in the cache or if there was an error attermpting to access the cache.</p>
<p>If there is a cache miss and a block is given the result of the block will be stored in the cache with optional <code>expiry</code>, using the <code>add</code> method rather than <code>set</code>.</p>
<div class="method-source-code" id="get-source">
<pre><span class="ruby-comment"># File lib/memcache_util.rb, line 31</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">get</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">expiry</span> = <span class="ruby-value">0</span>)
<span class="ruby-identifier">start_time</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>
<span class="ruby-identifier">value</span> = <span class="ruby-constant">CACHE</span>.<span class="ruby-identifier">get</span> <span class="ruby-identifier">key</span>
<span class="ruby-identifier">elapsed</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">start_time</span>
<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-string">'MemCache Get (%0.6f) %s'</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">elapsed</span>, <span class="ruby-identifier">key</span>])
<span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">block_given?</span> <span class="ruby-keyword">then</span>
<span class="ruby-identifier">value</span> = <span class="ruby-keyword">yield</span>
<span class="ruby-identifier">add</span> <span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>, <span class="ruby-identifier">expiry</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">value</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">MemCache</span><span class="ruby-operator">::</span><span class="ruby-constant">MemCacheError</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">err</span>
<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"MemCache Error: #{err.message}"</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span> <span class="ruby-keyword">then</span>
<span class="ruby-identifier">value</span> = <span class="ruby-keyword">yield</span>
<span class="ruby-identifier">put</span> <span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>, <span class="ruby-identifier">expiry</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-logger" class="method-detail ">
<div class="method-heading">
<span class="method-name">logger</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Try to return a logger object that does not rely on ActiveRecord for logging.</p>
<div class="method-source-code" id="logger-source">
<pre><span class="ruby-comment"># File lib/memcache_util.rb, line 13</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">logger</span>
<span class="ruby-ivar">@logger</span> <span class="ruby-operator">||=</span> <span class="ruby-keyword">if</span> <span class="ruby-keyword">defined?</span> <span class="ruby-constant">Rails</span>.<span class="ruby-identifier">logger</span> <span class="ruby-comment"># Rails 2.1 +</span>
<span class="ruby-constant">Rails</span>.<span class="ruby-identifier">logger</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-keyword">defined?</span> <span class="ruby-constant">RAILS_DEFAULT_LOGGER</span> <span class="ruby-comment"># Rails 1.2.2 +</span>
<span class="ruby-constant">RAILS_DEFAULT_LOGGER</span>
<span class="ruby-keyword">else</span>
<span class="ruby-constant">ActiveRecord</span><span class="ruby-operator">::</span><span class="ruby-constant">Base</span>.<span class="ruby-identifier">logger</span> <span class="ruby-comment"># ... very old Rails.</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-put" class="method-detail ">
<div class="method-heading">
<span class="method-name">put</span><span
class="method-args">(key, value, expiry = 0)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets <code>value</code> in the cache at <code>key</code>, with an optional <code>expiry</code> time in seconds.</p>
<div class="method-source-code" id="put-source">
<pre><span class="ruby-comment"># File lib/memcache_util.rb, line 54</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">put</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>, <span class="ruby-identifier">expiry</span> = <span class="ruby-value">0</span>)
<span class="ruby-identifier">start_time</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>
<span class="ruby-constant">CACHE</span>.<span class="ruby-identifier">set</span> <span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>, <span class="ruby-identifier">expiry</span>
<span class="ruby-identifier">elapsed</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">start_time</span>
<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-string">'MemCache Set (%0.6f) %s'</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">elapsed</span>, <span class="ruby-identifier">key</span>])
<span class="ruby-identifier">value</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">MemCache</span><span class="ruby-operator">::</span><span class="ruby-constant">MemCacheError</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">err</span>
<span class="ruby-constant">ActiveRecord</span><span class="ruby-operator">::</span><span class="ruby-constant">Base</span>.<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"MemCache Error: #{err.message}"</span>
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-reset" class="method-detail ">
<div class="method-heading">
<span class="method-name">reset</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Resets all connections to <a href="MemCache.html"><code>MemCache</code></a> servers.</p>
<div class="method-source-code" id="reset-source">
<pre><span class="ruby-comment"># File lib/memcache_util.rb, line 98</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">reset</span>
<span class="ruby-constant">CACHE</span>.<span class="ruby-identifier">reset</span>
<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-string">'MemCache Connections Reset'</span>
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.3.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>