KOKINIO - MANAGER
Edit File: Pool.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::Pool</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::Pool</td> </tr> <tr class="top-aligned-row"> <td><strong>In:</strong></td> <td> <a href="../../../files/lib/rack/session/pool_rb.html"> lib/rack/session/pool.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="Pool.html">Rack::Session::Pool</a> provides simple cookie based session management. <a href="../Session.html">Session</a> data is stored in a hash held by @pool. In the context of a multithreaded environment, sessions being committed to the pool is done in a merging manner. </p> <p> The :drop option is available in rack.session.options if you wish to explicitly remove the session from the session cache. </p> <p> Example: </p> <pre> myapp = MyRackApp.new sessioned = Rack::Session::Pool.new(myapp, :domain => 'foo.com', :expire_after => 2592000 ) Rack::Handler::WEBrick.run sessioned </pre> </div> </div> <div id="method-list"> <h3 class="section-bar">Methods</h3> <div class="name-list"> <a href="#M000171">destroy_session</a> <a href="#M000168">generate_sid</a> <a href="#M000169">get_session</a> <a href="#M000167">new</a> <a href="#M000170">set_session</a> <a href="#M000172">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 :drop => false</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-M000167" class="method-detail"> <a name="M000167"></a> <div class="method-heading"> <a href="Pool.src/M000167.html" target="Code" class="method-signature" onclick="popupCode('Pool.src/M000167.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-M000171" class="method-detail"> <a name="M000171"></a> <div class="method-heading"> <a href="Pool.src/M000171.html" target="Code" class="method-signature" onclick="popupCode('Pool.src/M000171.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-M000168" class="method-detail"> <a name="M000168"></a> <div class="method-heading"> <a href="Pool.src/M000168.html" target="Code" class="method-signature" onclick="popupCode('Pool.src/M000168.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-M000169" class="method-detail"> <a name="M000169"></a> <div class="method-heading"> <a href="Pool.src/M000169.html" target="Code" class="method-signature" onclick="popupCode('Pool.src/M000169.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-M000170" class="method-detail"> <a name="M000170"></a> <div class="method-heading"> <a href="Pool.src/M000170.html" target="Code" class="method-signature" onclick="popupCode('Pool.src/M000170.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-M000172" class="method-detail"> <a name="M000172"></a> <div class="method-heading"> <a href="Pool.src/M000172.html" target="Code" class="method-signature" onclick="popupCode('Pool.src/M000172.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>