Docs4dev
Docs
rails / 6.0 / actiondispatch / session / cachestore.html

class ActionDispatch::Session::CacheStore

Parent:
ActionDispatch::Session::AbstractStore

A session store that uses an ActiveSupport::Cache::Store to store the sessions. This store is most useful if you don't store critical data in your sessions and you don't need them to live for extended periods of time.

Options

  • cache - The cache to use. If it is not specified, Rails.cache will be used.

  • expire_after - The length of time a session will be stored before automatically expiring. By default, the :expires_in option of the cache is used.

Public Class Methods

new(app, options = {}) Show source 
# File actionpack/lib/action_dispatch/middleware/session/cache_store.rb, line 16
def initialize(app, options = {})
  @cache = options[:cache] || Rails.cache
  options[:expire_after] ||= @cache.options[:expires_in]
  super
end
Calls superclass method ActionDispatch::Session::Compatibility.new

Public Instance Methods

delete_session(env, sid, options) Show source 
# File actionpack/lib/action_dispatch/middleware/session/cache_store.rb, line 42
def delete_session(env, sid, options)
  @cache.delete(cache_key(sid))
  generate_sid
end

Remove a session from the cache.

find_session(env, sid) Show source 
# File actionpack/lib/action_dispatch/middleware/session/cache_store.rb, line 23
def find_session(env, sid)
  unless sid && (session = @cache.read(cache_key(sid)))
    sid, session = generate_sid, {}
  end
  [sid, session]
end

Get a session from the cache.

write_session(env, sid, session, options) Show source 
# File actionpack/lib/action_dispatch/middleware/session/cache_store.rb, line 31
def write_session(env, sid, session, options)
  key = cache_key(sid)
  if session
    @cache.write(key, session, expires_in: options[:expire_after])
  else
    @cache.delete(key)
  end
  sid
end

Set a session in the cache.

© 2004–2019 David Heinemeier Hansson
Licensed under the MIT License.