Class: Rack::Session::Pool

### Home Classes Methods

### In Files

- lib/rack/session/pool.rb

### Parent

Rack::Session::Abstract::ID

### Methods

- ::new
- #destroy_session
- #generate_sid
- #get_session
- #set_session
- #with_lock

### Files

- KNOWN-ISSUES

### 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::BodyProxy
- Rack::Builder
- Rack::Cascade
- Rack::Chunked
- Rack::Chunked::Body
- 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::Multipart
- Rack::Multipart::Generator
- Rack::Multipart::MultipartLimitError
- Rack::Multipart::Parser
- Rack::Multipart::UploadedFile
- 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::Abstract::SessionHash
- Rack::Session::Cookie
- Rack::Session::Cookie::Base64
- Rack::Session::Cookie::Base64::Marshal
- Rack::Session::Cookie::Identity
- Rack::Session::Cookie::Reverse
- Rack::Session::Memcache
- Rack::Session::Pool
- Rack::ShowExceptions
- Rack::ShowStatus
- Rack::Static
- Rack::URLMap
- Rack::Utils
- Rack::Utils::Context
- Rack::Utils::HeaderHash
- Rack::Utils::KeySpaceConstrainedParams
- Rack::Utils::Multipart
- FCGI
- FCGI::Stream
- Object

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

destroy_session(env, session_id, options) click to toggle source

    # File lib/rack/session/pool.rb, line 61
    def destroy_session(env, session_id, options)
      with_lock(env) do
        @pool.delete(session_id)
        generate_sid unless options[:drop]
      end
    end

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)
      with_lock(env, [nil, {}]) do
        unless sid and session = @pool[sid]
          sid, session = generate_sid, {}
          @pool.store sid, session
        end
        [sid, session]
      end
    end

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

    # File lib/rack/session/pool.rb, line 54
    def set_session(env, session_id, new_session, options)
      with_lock(env, false) do
        @pool.store session_id, new_session
        session_id
      end
    end

with_lock(env, default=nil) click to toggle source

    # File lib/rack/session/pool.rb, line 68
    def with_lock(env, default=nil)
      @mutex.lock if env['rack.multithread']
      yield
    rescue
      default
    ensure
      @mutex.unlock if @mutex.locked?
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.