Class: Rack::Session::Pool

### Home Classes Methods

### In Files

- lib/rack/session/pool.rb

### Parent

Rack::Session::Abstract::ID

### Methods

- ::new
- #generate_sid
- #get_session
- #set_session

### Files

- KNOWN-ISSUES
- README
- SPEC

### Class/Module Index

Quicksearch

- Rack
- Rack::Auth
- Rack::Auth::AbstractHandler
- Rack::Auth::AbstractRequest
- Rack::Auth::Basic
- Rack::Auth::Basic::Request
- Rack::Auth::Digest
- Rack::Auth::Digest::MD5
- Rack::Auth::Digest::Nonce
- Rack::Auth::Digest::Params
- Rack::Auth::Digest::Request
- Rack::Builder
- Rack::Cascade
- Rack::Chunked
- Rack::CommonLogger
- Rack::ConditionalGet
- Rack::Config
- Rack::ContentLength
- Rack::ContentType
- Rack::Deflater
- Rack::Deflater::DeflateStream
- Rack::Deflater::GzipStream
- Rack::Directory
- Rack::ETag
- Rack::File
- Rack::ForwardRequest
- Rack::Handler
- Rack::Handler::CGI
- Rack::Handler::EventedMongrel
- Rack::Handler::FastCGI
- Rack::Handler::LSWS
- Rack::Handler::Mongrel
- Rack::Handler::SCGI
- Rack::Handler::SwiftipliedMongrel
- Rack::Handler::Thin
- Rack::Handler::WEBrick
- Rack::Head
- Rack::Lint
- Rack::Lobster
- Rack::Lock
- Rack::Logger
- Rack::MethodOverride
- Rack::Mime
- Rack::MockRequest
- Rack::MockRequest::FatalWarner
- Rack::MockRequest::FatalWarning
- Rack::MockResponse
- Rack::NullLogger
- Rack::Recursive
- Rack::Reloader
- Rack::Reloader::Stat
- Rack::Request
- Rack::Response
- Rack::Response::Helpers
- Rack::RewindableInput
- Rack::RewindableInput::Tempfile
- Rack::Runtime
- Rack::Sendfile
- Rack::Server
- Rack::Server::Options
- Rack::Session
- Rack::Session::Abstract
- Rack::Session::Abstract::ID
- Rack::Session::Cookie
- Rack::Session::Memcache
- Rack::Session::Pool
- Rack::ShowExceptions
- Rack::ShowStatus
- Rack::Static
- Rack::URLMap
- Rack::Utils
- Rack::Utils::Context
- Rack::Utils::HeaderHash
- Rack::Utils::Multipart
- Rack::Utils::Multipart::UploadedFile
- FCGI
- FCGI::Stream

No matching classes.

# Rack::Session::Pool

Rack::Session::Pool provides simple cookie based session management. Session 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.

The :drop option is available in rack.session.options if you wish to explicitly remove the session from the session cache.

Example:

    myapp = MyRackApp.new
    sessioned = Rack::Session::Pool.new(myapp,
      :domain => 'foo.com',
      :expire_after => 2592000
    )
    Rack::Handler::WEBrick.run sessioned

### Constants

DEFAULT_OPTIONS

### Attributes

mutex[R]
pool[R]

### Public Class Methods

new(app, options={}) click to toggle source

    # File lib/rack/session/pool.rb, line 31
    def initialize(app, options={})
      super
      @pool = Hash.new
      @mutex = Mutex.new
    end

### Public Instance Methods

generate_sid() click to toggle source

    # File lib/rack/session/pool.rb, line 37
    def generate_sid
      loop do
        sid = super
        break sid unless @pool.key? sid
      end
    end

get_session(env, sid) click to toggle source

    # File lib/rack/session/pool.rb, line 44
    def get_session(env, sid)
      session = @pool[sid] if sid
      @mutex.lock if env['rack.multithread']
      unless sid and session
        env['rack.errors'].puts("Session '#{sid.inspect}' not found, initializing...") if $VERBOSE and not sid.nil?
        session = {}
        sid = generate_sid
        @pool.store sid, session
      end
      session.instance_variable_set('@old', {}.merge(session))
      return [sid, session]
    ensure
      @mutex.unlock if env['rack.multithread']
    end

set_session(env, session_id, new_session, options) click to toggle source

    # File lib/rack/session/pool.rb, line 59
    def set_session(env, session_id, new_session, options)
      @mutex.lock if env['rack.multithread']
      session = @pool[session_id]
      if options[:renew] or options[:drop]
        @pool.delete session_id
        return false if options[:drop]
        session_id = generate_sid
        @pool.store session_id, 0
      end
      old_session = new_session.instance_variable_get('@old') || {}
      session = merge_sessions session_id, old_session, new_session, session
      @pool.store session_id, session
      return session_id
    rescue
      warn "#{new_session.inspect} has been lost."
      warn $!.inspect
    ensure
      @mutex.unlock if env['rack.multithread']
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.