Class: ActionDispatch::Session::CacheStore
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
AbstractSecureStore ,
Rack::Session::Abstract::PersistedSecure
|
|
Instance Chain:
self,
AbstractSecureStore ,
SessionObject ,
StaleSessionCheck ,
Compatibility ,
Rack::Session::Abstract::PersistedSecure
|
|
Inherits: |
ActionDispatch::Session::AbstractSecureStore
|
Defined in: | actionpack/lib/action_dispatch/middleware/session/cache_store.rb |
Overview
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.
Class Method Summary
- .new(app, options = {}) ⇒ CacheStore constructor
Instance Method Summary
-
#delete_session(env, sid, options)
Remove a session from the cache.
-
#find_session(env, sid)
Get a session from the cache.
-
#write_session(env, sid, session, options)
Set a session in the cache.
-
#cache_key(id)
private
Turn the session id into a cache key.
- #get_session_with_fallback(sid) private
AbstractSecureStore
- Inherited
SessionObject
- Included
StaleSessionCheck
- Included
Compatibility
- Included
Constructor Details
.new(app, options = {}) ⇒ CacheStore
Instance Method Details
#cache_key(id) (private)
Turn the session id into a cache key.
# File 'actionpack/lib/action_dispatch/middleware/session/cache_store.rb', line 57
def cache_key(id) "_session_id:#{id}" end
#delete_session(env, sid, options)
Remove a session from the cache.
#find_session(env, sid)
Get a session from the cache.
# File 'actionpack/lib/action_dispatch/middleware/session/cache_store.rb', line 30
def find_session(env, sid) unless sid && (session = get_session_with_fallback(sid)) sid, session = generate_sid, {} end [sid, session] end
#get_session_with_fallback(sid) (private)
[ GitHub ]#write_session(env, sid, session, options)
Set a session in the cache.
# File 'actionpack/lib/action_dispatch/middleware/session/cache_store.rb', line 38
def write_session(env, sid, session, ) key = cache_key(sid.private_id) if session @cache.write(key, session, expires_in: [:expire_after]) else @cache.delete(key) end sid end