ktor-server-sessions/io.ktor.server.sessions/SessionTrackerById

SessionTrackerById

class SessionTrackerById<S : Any> : SessionTracker<S> (source)

SessionTracker that transfers a Session ID generated by a sessionIdProvider in HTTP Headers/Cookies. It uses a storage and a serializer to store/load serialized/deserialized session content of a specific type.

Report a problem

Constructors

SessionTrackerById

constructor(type: KClass<S>, serializer: SessionSerializer<S>, storage: SessionStorage, sessionIdProvider: (ApplicationCall) -> String)

Properties

serializer

val serializer: SessionSerializer<S>

session serializer

sessionIdProvider

val ~~sessionIdProvider~~: () -> String

storage

val storage: SessionStorage

session storage to store session

type

val type: KClass<S>

is a session instance type

Functions

clear

open suspend override fun clear(call: ApplicationCall)

Clear session information

clearById

suspend fun clearById(sessionId: String)

Clears a session with the specified sessionId from the storage without needing access to the ApplicationCall.

load

open suspend override fun load(call: ApplicationCall, transport: String?): S?

Load session value from transport string for the specified call

provideSessionId

fun provideSessionId(call: ApplicationCall): String

store

open suspend override fun store(call: ApplicationCall, value: S): String

Store session value and return respective transport string for the specified call.

toString

open override fun toString(): String

validate

open override fun validate(value: S)

Validate session information