Class: Rack::Session::Memcache

### Home Classes Methods

### In Files

- lib/rack/session/memcache.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::JSON
- 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
- Rack::Utils::OkJson
- Rack::Utils::OkJson::Error
- Rack::Utils::OkJson::Utf8Error
- FCGI
- FCGI::Stream
- Object

No matching classes.

# Rack::Session::Memcache

Rack::Session::Memcache provides simple cookie based session management. Session data is stored in memcached. The corresponding session key is maintained in the cookie. You may treat Session::Memcache as you would Session::Pool with the following caveats.

- Setting :expire_after to 0 would note to the Memcache server to hang onto the session data until it would drop it according to it's own specifications. However, the cookie sent to the client would expire immediately.

Note that memcache does drop data before it may be listed to expire. For a full description of behaviour, please see memcache's documentation.

### Constants

DEFAULT_OPTIONS

### Attributes

mutex[R]
pool[R]

### Public Class Methods

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

    # File lib/rack/session/memcache.rb, line 29
    def initialize(app, options={})
      super

      @mutex = Mutex.new
      mserv = @default_options[:memcache_server]
      mopts = @default_options.reject{|k,v| !MemCache::DEFAULT_OPTIONS.include? k }

      @pool = options[:cache] || MemCache.new(mserv, mopts)
      unless @pool.active? and @pool.servers.any?{|c| c.alive? }
        raise 'No memcache servers'
      end
    end

### Public Instance Methods

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

    # File lib/rack/session/memcache.rb, line 71
    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/memcache.rb, line 42
    def generate_sid
      loop do
        sid = super
        break sid unless @pool.get(sid, true)
      end
    end

get_session(env, sid) click to toggle source

    # File lib/rack/session/memcache.rb, line 49
    def get_session(env, sid)
      with_lock(env, [nil, {}]) do
        unless sid and session = @pool.get(sid)
          sid, session = generate_sid, {}
          unless /^STORED/ =~ @pool.add(sid, session)
            raise "Session collision on '#{sid.inspect}'"
          end
        end
        [sid, session]
      end
    end

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

    # File lib/rack/session/memcache.rb, line 61
    def set_session(env, session_id, new_session, options)
      expiry = options[:expire_after]
      expiry = expiry.nil? ? 0 : expiry + 1

      with_lock(env, false) do
        @pool.set session_id, new_session, expiry
        session_id
      end
    end

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

    # File lib/rack/session/memcache.rb, line 78
    def with_lock(env, default=nil)
      @mutex.lock if env['rack.multithread']
      yield
    rescue MemCache::MemCacheError, Errno::ECONNREFUSED
      if $VERBOSE
        warn "#{self} is unable to find memcached server."
        warn $!.inspect
      end
      default
    ensure
      @mutex.unlock if @mutex.locked?
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.