Class: Rack::Session::Pool

Inherits:
Abstract::ID show all
Defined in:
lib/rack/session/pool.rb

Overview

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

Constant Summary collapse

DEFAULT_OPTIONS = 
Abstract::ID::DEFAULT_OPTIONS.merge :drop => false

Instance Attribute Summary collapse

Attributes inherited from Abstract::ID

#default_options, #key

Instance Method Summary collapse

Methods inherited from Abstract::ID

#call, #context

Constructor Details

#initialize(app, options = {}) ⇒ Pool

Returns a new instance of Pool.



31
32
33
34
35
 
# File 'lib/rack/session/pool.rb', line 31

def initialize(app, options={})
  super
  @pool = Hash.new
  @mutex = Mutex.new
end

Instance Attribute Details

#mutex ⇒ Object (readonly)

Returns the value of attribute mutex.



28
29
30
 
# File 'lib/rack/session/pool.rb', line 28

def mutex
  @mutex
end

#pool ⇒ Object (readonly)

Returns the value of attribute pool.



28
29
30
 
# File 'lib/rack/session/pool.rb', line 28

def pool
  @pool
end

Instance Method Details

#destroy_session(env, session_id, options) ⇒ Object 



61
62
63
64
65
66
 
# 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 ⇒ Object 



37
38
39
40
41
42
 
# 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) ⇒ Object 



44
45
46
47
48
49
50
51
52
 
# File 'lib/rack/session/pool.rb', line 44

def get_session(env, sid)
  with_lock(env) 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) ⇒ Object 



54
55
56
57
58
59
 
# File 'lib/rack/session/pool.rb', line 54

def set_session(env, session_id, new_session, options)
  with_lock(env) do
    @pool.store session_id, new_session
    session_id
  end
end

#with_lock(env) ⇒ Object 



68
69
70
71
72
73
 
# File 'lib/rack/session/pool.rb', line 68

def with_lock(env)
  @mutex.lock if env['rack.multithread']
  yield
ensure
  @mutex.unlock if @mutex.locked?
end