class 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

Calls superclass method Rack::Session::Abstract::Persisted::new

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

Public Instance Methods

delete_session(req, session_id, options) click to toggle source

# File lib/rack/session/pool.rb, line 62
def delete_session(req, session_id, options)
  @mutex.synchronize do
    @pool.delete(session_id.public_id)
    @pool.delete(session_id.private_id)

    unless options[:drop]
      sid = generate_sid(use_mutex: false)
      @pool.store(sid.private_id, {})
      sid
    end
  end
end

find_session(req, sid) click to toggle source

# File lib/rack/session/pool.rb, line 44
def find_session(req, sid)
  @mutex.synchronize do
    unless sid and session = get_session_with_fallback(sid)
      sid, session = generate_sid(use_mutex: false), {}
      @pool.store sid.private_id, session
    end
    [sid, session]
  end
end

generate_sid(*args, use_mutex: true) click to toggle source

Calls superclass method Rack::Session::Abstract::PersistedSecure#generate_sid

# File lib/rack/session/pool.rb, line 37
def generate_sid(*args, use_mutex: true)
  loop do
    sid = super(*args)
    break sid unless use_mutex ? @mutex.synchronize { @pool.key? sid.private_id } : @pool.key?(sid.private_id)
  end
end

write_session(req, session_id, new_session, options) click to toggle source

# File lib/rack/session/pool.rb, line 54
def write_session(req, session_id, new_session, options)
  @mutex.synchronize do
    return false unless get_session_with_fallback(session_id)
    @pool.store session_id.private_id, new_session
    session_id
  end
end

Private Instance Methods

get_session_with_fallback(sid) click to toggle source

# File lib/rack/session/pool.rb, line 77
def get_session_with_fallback(sid)
  @pool[sid.private_id] || (@pool[sid.public_id] if @allow_fallback)
end