OwlCyberSecurity - MANAGER
Edit File: ID.html
<!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>class Rack::Session::Abstract::ID - rack-2.2.10 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="Persisted.html">Rack::Session::Abstract::Persisted</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-inherited">::inherited</a> <li ><a href="#method-i-delete_session">#delete_session</a> <li ><a href="#method-i-find_session">#find_session</a> <li ><a href="#method-i-write_session">#write_session</a> </ul> </div> </div> </nav> <main role="main" aria-labelledby="class-Rack::Session::Abstract::ID"> <h1 id="class-Rack::Session::Abstract::ID" class="class"> class Rack::Session::Abstract::ID </h1> <section class="description"> </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-inherited" class="method-detail "> <div class="method-heading"> <span class="method-name">inherited</span><span class="method-args">(klass)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-calls-super"> Calls superclass method </div> <div class="method-source-code" id="inherited-source"> <pre><span class="ruby-comment"># File lib/rack/session/abstract/id.rb, line 488</span> <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">inherited</span>(<span class="ruby-identifier">klass</span>) <span class="ruby-identifier">k</span> = <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">ancestors</span>.<span class="ruby-identifier">find</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">kl</span><span class="ruby-operator">|</span> <span class="ruby-identifier">kl</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:superclass</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">kl</span>.<span class="ruby-identifier">superclass</span> <span class="ruby-operator">==</span> <span class="ruby-constant">ID</span> } <span class="ruby-keyword">unless</span> <span class="ruby-identifier">k</span>.<span class="ruby-identifier">instance_variable_defined?</span>(<span class="ruby-value">:"@_rack_warned"</span>) <span class="ruby-identifier">warn</span> <span class="ruby-node">"#{klass} is inheriting from #{ID}. Inheriting from #{ID} is deprecated, please inherit from #{Persisted} instead"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">$VERBOSE</span> <span class="ruby-identifier">k</span>.<span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-value">:"@_rack_warned"</span>, <span class="ruby-keyword">true</span>) <span class="ruby-keyword">end</span> <span class="ruby-keyword">super</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, sid, options)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <p>All thread safety and session destroy procedures should occur here. Should return a new session id or nil if <a href=":drop">options</a></p> <div class="method-source-code" id="delete_session-source"> <pre><span class="ruby-comment"># File lib/rack/session/abstract/id.rb, line 517</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">sid</span>, <span class="ruby-identifier">options</span>) <span class="ruby-identifier">destroy_session</span> <span class="ruby-identifier">req</span>.<span class="ruby-identifier">env</span>, <span class="ruby-identifier">sid</span>, <span class="ruby-identifier">options</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"> <p>All thread safety and session retrieval procedures should occur here. Should return [session_id, session]. If nil is provided as the session id, generation of a new valid id should occur within.</p> <div class="method-source-code" id="find_session-source"> <pre><span class="ruby-comment"># File lib/rack/session/abstract/id.rb, line 502</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">get_session</span> <span class="ruby-identifier">req</span>.<span class="ruby-identifier">env</span>, <span class="ruby-identifier">sid</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, sid, session, options)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <p>All thread safety and session storage procedures should occur here. Must return the session id if the session was saved successfully, or false if the session could not be saved.</p> <div class="method-source-code" id="write_session-source"> <pre><span class="ruby-comment"># File lib/rack/session/abstract/id.rb, line 510</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">sid</span>, <span class="ruby-identifier">session</span>, <span class="ruby-identifier">options</span>) <span class="ruby-identifier">set_session</span> <span class="ruby-identifier">req</span>.<span class="ruby-identifier">env</span>, <span class="ruby-identifier">sid</span>, <span class="ruby-identifier">session</span>, <span class="ruby-identifier">options</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>