1#@!#!123s

: / opt / alt / ruby18 / lib64 / ruby / gems / 1.8 / doc / rack-1.6.1 / ri / Rack / Session / Abstract / ID /
Filename : cdesc-ID.yaml
back
--- !ruby/object:RI::ClassDescription 
attributes: 
- !ruby/object:RI::Attribute 
  comment: 
  name: default_options
  rw: R
- !ruby/object:RI::Attribute 
  comment: 
  name: key
  rw: R
class_methods: 
- !ruby/object:RI::MethodSummary 
  name: new
comment: 
- !ruby/struct:SM::Flow::P 
  body: "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."
- !ruby/struct:SM::Flow::P 
  body: All parameters are optional.
- !ruby/object:SM::Flow::LIST 
  contents: 
  - !ruby/struct:SM::Flow::LI 
    label: "*"
    body: ":key determines the name of the cookie, by default it is 'rack.session'"
  - !ruby/struct:SM::Flow::LI 
    label: "*"
    body: ":path, :domain, :expire_after, :secure, and :httponly set the related cookie options as by Rack::Response#add_cookie"
  - !ruby/struct:SM::Flow::LI 
    label: "*"
    body: ":skip will not a set a cookie in the response nor update the session state"
  - !ruby/struct:SM::Flow::LI 
    label: "*"
    body: ":defer will not set a cookie in the response but still update the session state if it is used with a backend"
  - !ruby/struct:SM::Flow::LI 
    label: "*"
    body: ":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."
  - !ruby/struct:SM::Flow::LI 
    label: "*"
    body: ":sidbits sets the number of bits in length that a generated session id will be."
  type: :BULLET
- !ruby/struct:SM::Flow::P 
  body: These options can be set on a per request basis, at the location of env['rack.session.options']. 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.
- !ruby/struct:SM::Flow::P 
  body: Is Rack::Utils::Context compatible.
- !ruby/struct:SM::Flow::P 
  body: Not included by default; you must require 'rack/session/abstract/id' to use.
constants: 
- !ruby/object:RI::Constant 
  comment: 
  name: DEFAULT_OPTIONS
  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)"
full_name: Rack::Session::Abstract::ID
includes: []

instance_methods: 
- !ruby/object:RI::MethodSummary 
  name: call
- !ruby/object:RI::MethodSummary 
  name: context
name: ID
superclass: Object