← Back
Editing: Memcache.html
<?xml version="1.0" encoding="iso-8859-1"?> <!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> <title>Class: Rack::Session::Memcache</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> <meta http-equiv="Content-Script-Type" content="text/javascript" /> <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" /> <script type="text/javascript"> // <![CDATA[ function popupCode( url ) { window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400") } function toggleCode( id ) { if ( document.getElementById ) elem = document.getElementById( id ); else if ( document.all ) elem = eval( "document.all." + id ); else return false; elemStyle = elem.style; if ( elemStyle.display != "block" ) { elemStyle.display = "block" } else { elemStyle.display = "none" } return true; } // Make codeblocks hidden by default document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" ) // ]]> </script> </head> <body> <div id="classHeader"> <table class="header-table"> <tr class="top-aligned-row"> <td><strong>Class</strong></td> <td class="class-name-in-header">Rack::Session::Memcache</td> </tr> <tr class="top-aligned-row"> <td><strong>In:</strong></td> <td> <a href="../../../files/lib/rack/session/memcache_rb.html"> lib/rack/session/memcache.rb </a> <br /> </td> </tr> <tr class="top-aligned-row"> <td><strong>Parent:</strong></td> <td> <a href="Abstract/ID.html"> Abstract::ID </a> </td> </tr> </table> </div> <!-- banner header --> <div id="bodyContent"> <div id="contextContent"> <div id="description"> <p> <a href="Memcache.html">Rack::Session::Memcache</a> provides simple cookie based session management. <a href="../Session.html">Session</a> data is stored in memcached. The corresponding session key is maintained in the cookie. You may treat <a href="Memcache.html">Session::Memcache</a> as you would <a href="Pool.html">Session::Pool</a> with the following caveats. </p> <ul> <li>Setting :expire_after to 0 would note to the <a href="Memcache.html">Memcache</a> server to hang onto the session data until it would drop it according to it‘s own specifications. However, the cookie sent to the client would expire immediately. </li> </ul> <p> Note that memcache does drop data before it may be listed to expire. For a full description of behaviour, please see memcache‘s documentation. </p> </div> </div> <div id="method-list"> <h3 class="section-bar">Methods</h3> <div class="name-list"> <a href="#M000188">destroy_session</a> <a href="#M000185">generate_sid</a> <a href="#M000186">get_session</a> <a href="#M000184">new</a> <a href="#M000187">set_session</a> <a href="#M000189">with_lock</a> </div> </div> </div> <!-- if includes --> <div id="section"> <div id="constants-list"> <h3 class="section-bar">Constants</h3> <div class="name-list"> <table summary="Constants"> <tr class="top-aligned-row context-row"> <td class="context-item-name">DEFAULT_OPTIONS</td> <td>=</td> <td class="context-item-value">Abstract::ID::DEFAULT_OPTIONS.merge \ :namespace => 'rack:session', :memcache_server => 'localhost:11211'</td> </tr> </table> </div> </div> <div id="attribute-list"> <h3 class="section-bar">Attributes</h3> <div class="name-list"> <table> <tr class="top-aligned-row context-row"> <td class="context-item-name">mutex</td> <td class="context-item-value"> [R] </td> <td class="context-item-desc"></td> </tr> <tr class="top-aligned-row context-row"> <td class="context-item-name">pool</td> <td class="context-item-value"> [R] </td> <td class="context-item-desc"></td> </tr> </table> </div> </div> <!-- if method_list --> <div id="methods"> <h3 class="section-bar">Public Class methods</h3> <div id="method-M000184" class="method-detail"> <a name="M000184"></a> <div class="method-heading"> <a href="Memcache.src/M000184.html" target="Code" class="method-signature" onclick="popupCode('Memcache.src/M000184.html');return false;"> <span class="method-name">new</span><span class="method-args">(app, options={})</span> </a> </div> <div class="method-description"> </div> </div> <h3 class="section-bar">Public Instance methods</h3> <div id="method-M000188" class="method-detail"> <a name="M000188"></a> <div class="method-heading"> <a href="Memcache.src/M000188.html" target="Code" class="method-signature" onclick="popupCode('Memcache.src/M000188.html');return false;"> <span class="method-name">destroy_session</span><span class="method-args">(env, session_id, options)</span> </a> </div> <div class="method-description"> </div> </div> <div id="method-M000185" class="method-detail"> <a name="M000185"></a> <div class="method-heading"> <a href="Memcache.src/M000185.html" target="Code" class="method-signature" onclick="popupCode('Memcache.src/M000185.html');return false;"> <span class="method-name">generate_sid</span><span class="method-args">()</span> </a> </div> <div class="method-description"> </div> </div> <div id="method-M000186" class="method-detail"> <a name="M000186"></a> <div class="method-heading"> <a href="Memcache.src/M000186.html" target="Code" class="method-signature" onclick="popupCode('Memcache.src/M000186.html');return false;"> <span class="method-name">get_session</span><span class="method-args">(env, sid)</span> </a> </div> <div class="method-description"> </div> </div> <div id="method-M000187" class="method-detail"> <a name="M000187"></a> <div class="method-heading"> <a href="Memcache.src/M000187.html" target="Code" class="method-signature" onclick="popupCode('Memcache.src/M000187.html');return false;"> <span class="method-name">set_session</span><span class="method-args">(env, session_id, new_session, options)</span> </a> </div> <div class="method-description"> </div> </div> <div id="method-M000189" class="method-detail"> <a name="M000189"></a> <div class="method-heading"> <a href="Memcache.src/M000189.html" target="Code" class="method-signature" onclick="popupCode('Memcache.src/M000189.html');return false;"> <span class="method-name">with_lock</span><span class="method-args">(env) {|| ...}</span> </a> </div> <div class="method-description"> </div> </div> </div> </div> <div id="validator-badges"> <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> </div> </body> </html>
Save File
Cancel