yesod-session-persist-0.0.0.2: SQL session backend for Yesod
Safe HaskellSafe-Inferred
LanguageGHC2021

Yesod.Session.KeyRotation

Synopsis

Documentation

assignSessionKeyRotation Source #

Arguments

:: (MonadHandler m, HasSessionEmbeddings (HandlerSite m)) 
=> Maybe KeyRotation

Just to rotate, or Nothing to cancel any previous request for rotation and restore the default behavior

-> m () 

Indicate whether the current session key should be rotated

The key rotation does not occur immediately; this action only places a value into the session map.

Later calls to assignSessionKeyRotation on the same handler will override earlier calls.

At the end of the request handler, if the value is Just, the session key will be rotated.

The session variable set by this function is then discarded and is not persisted across requests.