ID 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.
All parameters are optional.
:key determines the name of the cookie, by default it is ‘rack.session’
:path, :domain, :expire_after, :secure, and :httponly set the related cookie options as by Rack::Response#add_cookie
:defer will not set a cookie in the response.
:renew (implementation dependent) will prompt the generation of a new session id, and migration of data to be referenced at the new id. If :defer is set, it will be overridden and the cookie will be set.
:sidbits sets the number of bits in length that a generated session id will be.
These options can be set on a per request basis, at the location of env. 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.
Is Rack::Utils::Context compatible.
Not included by default; you must require ‘rack/session/abstract/id’ to use.
# File lib/rack/session/abstract/id.rb, line 181 def initialize(app, options={}) @app = app @default_options = self.class::DEFAULT_OPTIONS.merge(options) @key = options[:key] || "rack.session" @cookie_only = @default_options.delete(:cookie_only) initialize_sid end
Generated with the Darkfish Rdoc Generator 2.