D7net
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
opt
/
alt
/
ruby18
/
lib64
/
ruby
/
gems
/
1.8
/
doc
/
rack-1.6.1
/
rdoc
/
classes
/
Rack
/
Session
/
Abstract
/
Filename :
ID.html
back
Copy
<?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::Abstract::ID</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::Abstract::ID</td> </tr> <tr class="top-aligned-row"> <td><strong>In:</strong></td> <td> <a href="../../../../files/lib/rack/session/abstract/id_rb.html"> lib/rack/session/abstract/id.rb </a> <br /> </td> </tr> <tr class="top-aligned-row"> <td><strong>Parent:</strong></td> <td> Object </td> </tr> </table> </div> <!-- banner header --> <div id="bodyContent"> <div id="contextContent"> <div id="description"> <p> <a href="ID.html">ID</a> sets up a basic framework for implementing an id based sessioning service. Cookies sent to the client for maintaining sessions will only contain an id reference. Only get_session and set_session are required to be overwritten. </p> <p> All parameters are optional. </p> <ul> <li>:key determines the name of the cookie, by default it is ‘rack.session‘ </li> <li>:path, :domain, :expire_after, :secure, and :httponly set the related cookie options as by Rack::Response#add_cookie </li> <li>:skip will not a set a cookie in the response nor update the session state </li> <li>:defer will not set a cookie in the response but still update the session state if it is used with a backend </li> <li>:renew (implementation dependent) will prompt the generation of a <a href="ID.html#M000164">new</a> session id, and migration of data to be referenced at the <a href="ID.html#M000164">new</a> id. If :defer is set, it will be overridden and the cookie will be set. </li> <li>:sidbits sets the number of bits in length that a generated session id will be. </li> </ul> <p> These options can be set on a per request basis, at the location of <a href="http://'rack.session.options'">env</a>. Additionally the id of the session can be found within the options hash at the key :id. It is highly not recommended to change its value. </p> <p> Is <a href="../../../Context.html">Rack::Utils::Context</a> compatible. </p> <p> Not included by default; you must require ‘rack/session/abstract/id’ to use. </p> </div> </div> <div id="method-list"> <h3 class="section-bar">Methods</h3> <div class="name-list"> <a href="#M000165">call</a> <a href="#M000166">context</a> <a href="#M000164">new</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">{ :key => 'rack.session', :path => '/', :domain => nil, :expire_after => nil, :secure => false, :httponly => true, :defer => false, :renew => false, :sidbits => 128, :cookie_only => true, :secure_random => (::SecureRandom rescue 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">default_options</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">key</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-M000164" class="method-detail"> <a name="M000164"></a> <div class="method-heading"> <a href="ID.src/M000164.html" target="Code" class="method-signature" onclick="popupCode('ID.src/M000164.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-M000165" class="method-detail"> <a name="M000165"></a> <div class="method-heading"> <a href="ID.src/M000165.html" target="Code" class="method-signature" onclick="popupCode('ID.src/M000165.html');return false;"> <span class="method-name">call</span><span class="method-args">(env)</span> </a> </div> <div class="method-description"> </div> </div> <div id="method-M000166" class="method-detail"> <a name="M000166"></a> <div class="method-heading"> <a href="ID.src/M000166.html" target="Code" class="method-signature" onclick="popupCode('ID.src/M000166.html');return false;"> <span class="method-name">context</span><span class="method-args">(env, app=@app)</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>