Web.ServerSession.Backend.Acid.Internal

Internal module exposing the guts of the package. Use at your own risk. No API stability guarantees apply.

Documentation

type SessionIdToSession sess = HashMap (SessionId sess) (Session sess)

Map from session IDs to sessions. The most important map, allowing us efficient access to a session given its ID.

type AuthIdToSessionId sess = HashMap AuthId (Set (SessionId sess))

Map from auth IDs to session IDs. Allow us to invalidate all sessions of given user without having to iterate through the whole SessionIdToSession map.

data ServerSessionAcidState sess

The current sessions.

Besides the obvious map from session IDs to sessions, we also maintain a map of auth IDs to session IDs. This allow us to quickly invalidate all sessions of a given user.

Constructors

ServerSessionAcidState

Fields

• sessionIdToSession :: !(SessionIdToSession sess)
• authIdToSessionId :: !(AuthIdToSessionId sess)

Instances

(Typeable sess, SafeCopy (Decomposed sess)) => SafeCopy (ServerSessionAcidState sess)

We can't deriveSafeCopy 0 'base ''ServerSessionAcidState due to the required context.

Defined in Web.ServerSession.Backend.Acid.Internal

Methods

version :: Version (ServerSessionAcidState sess)

kind :: Kind (ServerSessionAcidState sess)

getCopy :: Contained (Get (ServerSessionAcidState sess))

putCopy :: ServerSessionAcidState sess -> Contained Put

internalConsistency :: Consistency (ServerSessionAcidState sess)

objectProfile :: Profile (ServerSessionAcidState sess)

errorTypeName :: Proxy (ServerSessionAcidState sess) -> String

AcidContext sess => IsAcidic (ServerSessionAcidState sess)

Defined in Web.ServerSession.Backend.Acid.Internal

Methods

acidEvents :: [Event (ServerSessionAcidState sess)]

emptyState :: ServerSessionAcidState sess

Empty ServerSessionAcidState used to bootstrap the AcidState.

removeSessionFromAuthId :: SessionId sess -> Maybe AuthId -> AuthIdToSessionId sess -> AuthIdToSessionId sess

Remove the given SessionId from the set of the given AuthId on the map. Does not do anything if no AuthId is provided.

insertSessionForAuthId :: SessionId sess -> Maybe AuthId -> AuthIdToSessionId sess -> AuthIdToSessionId sess

Insert the given session ID as being part of the given auth ID. Conceptually the opposite of removeSessionFromAuthId. Does not do anything if no AuthId is provided.

getSession :: Storage (AcidStorage sess) => SessionId sess -> Query (ServerSessionAcidState sess) (Maybe (Session sess))

Get the session for the given session ID.

deleteSession :: Storage (AcidStorage sess) => SessionId sess -> Update (ServerSessionAcidState sess) ()

Delete the session with given session ID.

deleteAllSessionsOfAuthId :: Storage (AcidStorage sess) => AuthId -> Update (ServerSessionAcidState sess) ()

Delete all sessions of the given auth ID.

insertSession :: Storage (AcidStorage sess) => Session sess -> Update (ServerSessionAcidState sess) ()

Insert a new session.

replaceSession :: Storage (AcidStorage sess) => Session sess -> Update (ServerSessionAcidState sess) ()

Replace the contents of a session.

data GetSession sess

Instances

Typeable sess => SafeCopy (GetSession sess)

Defined in Web.ServerSession.Backend.Acid.Internal

Methods

version :: Version (GetSession sess)

kind :: Kind (GetSession sess)

getCopy :: Contained (Get (GetSession sess))

putCopy :: GetSession sess -> Contained Put

internalConsistency :: Consistency (GetSession sess)

objectProfile :: Profile (GetSession sess)

errorTypeName :: Proxy (GetSession sess) -> String

AcidContext sess => QueryEvent (GetSession sess)

Defined in Web.ServerSession.Backend.Acid.Internal

AcidContext sess => Method (GetSession sess)

Defined in Web.ServerSession.Backend.Acid.Internal

Associated Types

type MethodResult (GetSession sess)

type MethodState (GetSession sess)

Methods

methodTag :: GetSession sess -> Tag

type MethodState (GetSession sess)

Defined in Web.ServerSession.Backend.Acid.Internal

type MethodState (GetSession sess) = ServerSessionAcidState sess

type MethodResult (GetSession sess)

Defined in Web.ServerSession.Backend.Acid.Internal

type MethodResult (GetSession sess) = Maybe (Session sess)

data DeleteSession sess

Instances

Typeable sess => SafeCopy (DeleteSession sess)

Defined in Web.ServerSession.Backend.Acid.Internal

Methods

version :: Version (DeleteSession sess)

kind :: Kind (DeleteSession sess)

getCopy :: Contained (Get (DeleteSession sess))

putCopy :: DeleteSession sess -> Contained Put

internalConsistency :: Consistency (DeleteSession sess)

objectProfile :: Profile (DeleteSession sess)

errorTypeName :: Proxy (DeleteSession sess) -> String

AcidContext sess => UpdateEvent (DeleteSession sess)

Defined in Web.ServerSession.Backend.Acid.Internal

AcidContext sess => Method (DeleteSession sess)

Defined in Web.ServerSession.Backend.Acid.Internal

Associated Types

type MethodResult (DeleteSession sess)

type MethodState (DeleteSession sess)

Methods

methodTag :: DeleteSession sess -> Tag

type MethodState (DeleteSession sess)

Defined in Web.ServerSession.Backend.Acid.Internal

type MethodState (DeleteSession sess) = ServerSessionAcidState sess

type MethodResult (DeleteSession sess)

Defined in Web.ServerSession.Backend.Acid.Internal

type MethodResult (DeleteSession sess) = ()

data DeleteAllSessionsOfAuthId sess

Instances

Typeable sess => SafeCopy (DeleteAllSessionsOfAuthId sess)

Defined in Web.ServerSession.Backend.Acid.Internal

Methods

version :: Version (DeleteAllSessionsOfAuthId sess)

kind :: Kind (DeleteAllSessionsOfAuthId sess)

getCopy :: Contained (Get (DeleteAllSessionsOfAuthId sess))

putCopy :: DeleteAllSessionsOfAuthId sess -> Contained Put

internalConsistency :: Consistency (DeleteAllSessionsOfAuthId sess)

objectProfile :: Profile (DeleteAllSessionsOfAuthId sess)

errorTypeName :: Proxy (DeleteAllSessionsOfAuthId sess) -> String

AcidContext sess => UpdateEvent (DeleteAllSessionsOfAuthId sess)

Defined in Web.ServerSession.Backend.Acid.Internal

AcidContext sess => Method (DeleteAllSessionsOfAuthId sess)

Defined in Web.ServerSession.Backend.Acid.Internal

Associated Types

type MethodResult (DeleteAllSessionsOfAuthId sess)

type MethodState (DeleteAllSessionsOfAuthId sess)

Methods

methodTag :: DeleteAllSessionsOfAuthId sess -> Tag

type MethodState (DeleteAllSessionsOfAuthId sess)

Defined in Web.ServerSession.Backend.Acid.Internal

type MethodState (DeleteAllSessionsOfAuthId sess) = ServerSessionAcidState sess

type MethodResult (DeleteAllSessionsOfAuthId sess)

Defined in Web.ServerSession.Backend.Acid.Internal

type MethodResult (DeleteAllSessionsOfAuthId sess) = ()

data InsertSession sess

Instances

(Typeable sess, SafeCopy (Decomposed sess)) => SafeCopy (InsertSession sess)

Defined in Web.ServerSession.Backend.Acid.Internal

Methods

version :: Version (InsertSession sess)

kind :: Kind (InsertSession sess)

getCopy :: Contained (Get (InsertSession sess))

putCopy :: InsertSession sess -> Contained Put

internalConsistency :: Consistency (InsertSession sess)

objectProfile :: Profile (InsertSession sess)

errorTypeName :: Proxy (InsertSession sess) -> String

AcidContext sess => UpdateEvent (InsertSession sess)

Defined in Web.ServerSession.Backend.Acid.Internal

AcidContext sess => Method (InsertSession sess)

Defined in Web.ServerSession.Backend.Acid.Internal

Associated Types

type MethodResult (InsertSession sess)

type MethodState (InsertSession sess)

Methods

methodTag :: InsertSession sess -> Tag

type MethodState (InsertSession sess)

Defined in Web.ServerSession.Backend.Acid.Internal

type MethodState (InsertSession sess) = ServerSessionAcidState sess

type MethodResult (InsertSession sess)

Defined in Web.ServerSession.Backend.Acid.Internal

type MethodResult (InsertSession sess) = ()

data ReplaceSession sess

Instances

(Typeable sess, SafeCopy (Decomposed sess)) => SafeCopy (ReplaceSession sess)

Defined in Web.ServerSession.Backend.Acid.Internal

Methods

version :: Version (ReplaceSession sess)

kind :: Kind (ReplaceSession sess)

getCopy :: Contained (Get (ReplaceSession sess))

putCopy :: ReplaceSession sess -> Contained Put

internalConsistency :: Consistency (ReplaceSession sess)

objectProfile :: Profile (ReplaceSession sess)

errorTypeName :: Proxy (ReplaceSession sess) -> String

AcidContext sess => UpdateEvent (ReplaceSession sess)

Defined in Web.ServerSession.Backend.Acid.Internal

AcidContext sess => Method (ReplaceSession sess)

Defined in Web.ServerSession.Backend.Acid.Internal

Associated Types

type MethodResult (ReplaceSession sess)

type MethodState (ReplaceSession sess)

Methods

methodTag :: ReplaceSession sess -> Tag

type MethodState (ReplaceSession sess)

Defined in Web.ServerSession.Backend.Acid.Internal

type MethodState (ReplaceSession sess) = ServerSessionAcidState sess

type MethodResult (ReplaceSession sess)

Defined in Web.ServerSession.Backend.Acid.Internal

type MethodResult (ReplaceSession sess) = ()

newtype AcidStorage sess

Session storage backend using acid-state.

Constructors

AcidStorage

Fields

• acidState :: AcidState (ServerSessionAcidState sess)

  Open AcidState of server sessions.

Instances

(IsSessionData sess, SafeCopy sess, SafeCopy (Decomposed sess)) => Storage (AcidStorage sess)

We do not provide any ACID guarantees for different actions running inside the same TransactionM AcidStorage.

Defined in Web.ServerSession.Backend.Acid.Internal

Associated Types

type SessionData (AcidStorage sess)

type TransactionM (AcidStorage sess) :: Type -> Type

Methods

runTransactionM :: AcidStorage sess -> TransactionM (AcidStorage sess) a -> IO a

getSession :: AcidStorage sess -> SessionId (SessionData (AcidStorage sess)) -> TransactionM (AcidStorage sess) (Maybe (Session (SessionData (AcidStorage sess))))

deleteSession :: AcidStorage sess -> SessionId (SessionData (AcidStorage sess)) -> TransactionM (AcidStorage sess) ()

deleteAllSessionsOfAuthId :: AcidStorage sess -> AuthId -> TransactionM (AcidStorage sess) ()

insertSession :: AcidStorage sess -> Session (SessionData (AcidStorage sess)) -> TransactionM (AcidStorage sess) ()

replaceSession :: AcidStorage sess -> Session (SessionData (AcidStorage sess)) -> TransactionM (AcidStorage sess) ()

type TransactionM (AcidStorage sess)

Defined in Web.ServerSession.Backend.Acid.Internal

type TransactionM (AcidStorage sess) = IO

type SessionData (AcidStorage sess)

Defined in Web.ServerSession.Backend.Acid.Internal

type SessionData (AcidStorage sess) = sess

Orphan instances

SafeCopy SessionMap

We can't deriveSafeCopy 0 'base ''SS.SessionMap because safeCopy doesn't contain instances for HashMap as of now.

Methods

version :: Version SessionMap

kind :: Kind SessionMap

getCopy :: Contained (Get SessionMap)

putCopy :: SessionMap -> Contained Put

internalConsistency :: Consistency SessionMap

objectProfile :: Profile SessionMap

errorTypeName :: Proxy SessionMap -> String

Typeable sess => SafeCopy (SessionId sess)

We can't deriveSafeCopy 0 'base ''SS.SessionId as otherwise we'd require an unneeded SafeCopy sess.

Methods

version :: Version (SessionId sess)

kind :: Kind (SessionId sess)

getCopy :: Contained (Get (SessionId sess))

putCopy :: SessionId sess -> Contained Put

internalConsistency :: Consistency (SessionId sess)

objectProfile :: Profile (SessionId sess)

errorTypeName :: Proxy (SessionId sess) -> String

(Typeable sess, SafeCopy (Decomposed sess)) => SafeCopy (Session sess)

We can't deriveSafeCopy 0 'base ''SS.Session due to the required context.

Methods

version :: Version (Session sess)

kind :: Kind (Session sess)

getCopy :: Contained (Get (Session sess))

putCopy :: Session sess -> Contained Put

internalConsistency :: Consistency (Session sess)

objectProfile :: Profile (Session sess)

errorTypeName :: Proxy (Session sess) -> String