ok
Direktori : /opt/cpanel/ea-ruby27/root/usr/share/gems/doc/rack-2.2.8/rdoc/Rack/Session/ |
Current File : //opt/cpanel/ea-ruby27/root/usr/share/gems/doc/rack-2.2.8/rdoc/Rack/Session/Pool.html |
<!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>class Rack::Session::Pool - rack-2.2.8 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="class"> <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"> <div id="parent-class-section" class="nav-section"> <h3>Parent</h3> <p class="link"><a href="Abstract/PersistedSecure.html">Rack::Session::Abstract::PersistedSecure</a> </div> <!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> <li class="calls-super" ><a href="#method-c-new">::new</a> <li ><a href="#method-i-delete_session">#delete_session</a> <li ><a href="#method-i-find_session">#find_session</a> <li class="calls-super" ><a href="#method-i-generate_sid">#generate_sid</a> <li ><a href="#method-i-get_session_with_fallback">#get_session_with_fallback</a> <li ><a href="#method-i-with_lock">#with_lock</a> <li ><a href="#method-i-write_session">#write_session</a> </ul> </div> </div> </nav> <main role="main" aria-labelledby="class-Rack::Session::Pool"> <h1 id="class-Rack::Session::Pool" class="class"> class Rack::Session::Pool </h1> <section class="description"> <p><a href="Pool.html"><code>Rack::Session::Pool</code></a> provides simple cookie based session management. <a href="../Session.html"><code>Session</code></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 class="ruby"><span class="ruby-identifier">myapp</span> = <span class="ruby-constant">MyRackApp</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">sessioned</span> = <span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">Session</span><span class="ruby-operator">::</span><span class="ruby-constant">Pool</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">myapp</span>, <span class="ruby-value">:domain</span> <span class="ruby-operator">=></span> <span class="ruby-string">'foo.com'</span>, <span class="ruby-value">:expire_after</span> <span class="ruby-operator">=></span> <span class="ruby-value">2592000</span> ) <span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">Handler</span><span class="ruby-operator">::</span><span class="ruby-constant">WEBrick</span>.<span class="ruby-identifier">run</span> <span class="ruby-identifier">sessioned</span> </pre> </section> <section id="5Buntitled-5D" class="documentation-section"> <section class="constants-list"> <header> <h3>Constants</h3> </header> <dl> <dt id="DEFAULT_OPTIONS">DEFAULT_OPTIONS <dd> </dl> </section> <section class="attribute-method-details" class="method-section"> <header> <h3>Attributes</h3> </header> <div id="attribute-i-mutex" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">mutex</span><span class="attribute-access-type">[R]</span> </div> <div class="method-description"> </div> </div> <div id="attribute-i-pool" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">pool</span><span class="attribute-access-type">[R]</span> </div> <div class="method-description"> </div> </div> </section> <section id="public-class-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Class Methods</h3> </header> <div id="method-c-new" class="method-detail "> <div class="method-heading"> <span class="method-name">new</span><span class="method-args">(app, options = {})</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-calls-super"> Calls superclass method <a href="Abstract/Persisted.html#method-c-new"><code>Rack::Session::Abstract::Persisted::new</code></a> </div> <div class="method-source-code" id="new-source"> <pre><span class="ruby-comment"># File lib/rack/session/pool.rb, line 33</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">app</span>, <span class="ruby-identifier">options</span> = {}) <span class="ruby-keyword">super</span> <span class="ruby-ivar">@pool</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span> <span class="ruby-ivar">@mutex</span> = <span class="ruby-constant">Mutex</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">end</span></pre> </div> </div> </div> </section> <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> <div id="method-i-delete_session" class="method-detail "> <div class="method-heading"> <span class="method-name">delete_session</span><span class="method-args">(req, session_id, options)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="delete_session-source"> <pre><span class="ruby-comment"># File lib/rack/session/pool.rb, line 63</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">delete_session</span>(<span class="ruby-identifier">req</span>, <span class="ruby-identifier">session_id</span>, <span class="ruby-identifier">options</span>) <span class="ruby-identifier">with_lock</span>(<span class="ruby-identifier">req</span>) <span class="ruby-keyword">do</span> <span class="ruby-ivar">@pool</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">session_id</span>.<span class="ruby-identifier">public_id</span>) <span class="ruby-ivar">@pool</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">session_id</span>.<span class="ruby-identifier">private_id</span>) <span class="ruby-identifier">generate_sid</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:drop</span>] <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span></pre> </div> </div> </div> <div id="method-i-find_session" class="method-detail "> <div class="method-heading"> <span class="method-name">find_session</span><span class="method-args">(req, sid)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="find_session-source"> <pre><span class="ruby-comment"># File lib/rack/session/pool.rb, line 46</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">find_session</span>(<span class="ruby-identifier">req</span>, <span class="ruby-identifier">sid</span>) <span class="ruby-identifier">with_lock</span>(<span class="ruby-identifier">req</span>) <span class="ruby-keyword">do</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">sid</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">session</span> = <span class="ruby-identifier">get_session_with_fallback</span>(<span class="ruby-identifier">sid</span>) <span class="ruby-identifier">sid</span>, <span class="ruby-identifier">session</span> = <span class="ruby-identifier">generate_sid</span>, {} <span class="ruby-ivar">@pool</span>.<span class="ruby-identifier">store</span> <span class="ruby-identifier">sid</span>.<span class="ruby-identifier">private_id</span>, <span class="ruby-identifier">session</span> <span class="ruby-keyword">end</span> [<span class="ruby-identifier">sid</span>, <span class="ruby-identifier">session</span>] <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span></pre> </div> </div> </div> <div id="method-i-generate_sid" class="method-detail "> <div class="method-heading"> <span class="method-name">generate_sid</span><span class="method-args">()</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-calls-super"> Calls superclass method <a href="Abstract/PersistedSecure.html#method-i-generate_sid"><code>Rack::Session::Abstract::PersistedSecure#generate_sid</code></a> </div> <div class="method-source-code" id="generate_sid-source"> <pre><span class="ruby-comment"># File lib/rack/session/pool.rb, line 39</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">generate_sid</span> <span class="ruby-identifier">loop</span> <span class="ruby-keyword">do</span> <span class="ruby-identifier">sid</span> = <span class="ruby-keyword">super</span> <span class="ruby-keyword">break</span> <span class="ruby-identifier">sid</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@pool</span>.<span class="ruby-identifier">key?</span> <span class="ruby-identifier">sid</span>.<span class="ruby-identifier">private_id</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span></pre> </div> </div> </div> <div id="method-i-with_lock" class="method-detail "> <div class="method-heading"> <span class="method-name">with_lock</span><span class="method-args">(req) { || ... }</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="with_lock-source"> <pre><span class="ruby-comment"># File lib/rack/session/pool.rb, line 71</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">with_lock</span>(<span class="ruby-identifier">req</span>) <span class="ruby-ivar">@mutex</span>.<span class="ruby-identifier">lock</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">req</span>.<span class="ruby-identifier">multithread?</span> <span class="ruby-keyword">yield</span> <span class="ruby-keyword">ensure</span> <span class="ruby-ivar">@mutex</span>.<span class="ruby-identifier">unlock</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@mutex</span>.<span class="ruby-identifier">locked?</span> <span class="ruby-keyword">end</span></pre> </div> </div> </div> <div id="method-i-write_session" class="method-detail "> <div class="method-heading"> <span class="method-name">write_session</span><span class="method-args">(req, session_id, new_session, options)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="write_session-source"> <pre><span class="ruby-comment"># File lib/rack/session/pool.rb, line 56</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write_session</span>(<span class="ruby-identifier">req</span>, <span class="ruby-identifier">session_id</span>, <span class="ruby-identifier">new_session</span>, <span class="ruby-identifier">options</span>) <span class="ruby-identifier">with_lock</span>(<span class="ruby-identifier">req</span>) <span class="ruby-keyword">do</span> <span class="ruby-ivar">@pool</span>.<span class="ruby-identifier">store</span> <span class="ruby-identifier">session_id</span>.<span class="ruby-identifier">private_id</span>, <span class="ruby-identifier">new_session</span> <span class="ruby-identifier">session_id</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span></pre> </div> </div> </div> </section> <section id="private-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Private Instance Methods</h3> </header> <div id="method-i-get_session_with_fallback" class="method-detail "> <div class="method-heading"> <span class="method-name">get_session_with_fallback</span><span class="method-args">(sid)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="get_session_with_fallback-source"> <pre><span class="ruby-comment"># File lib/rack/session/pool.rb, line 80</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_session_with_fallback</span>(<span class="ruby-identifier">sid</span>) <span class="ruby-ivar">@pool</span>[<span class="ruby-identifier">sid</span>.<span class="ruby-identifier">private_id</span>] <span class="ruby-operator">||</span> <span class="ruby-ivar">@pool</span>[<span class="ruby-identifier">sid</span>.<span class="ruby-identifier">public_id</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.2.1.1. <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>. </footer>