io.ktor.sessions / Sessions / Configuration

Configuration

class Configuration

Sessions configuration builder

Constructors

<init>
Configuration()

Sessions configuration builder

Properties

providers
val providers: List<SessionProvider<*>>

List of session providers to be registered

Functions

register
fun register(provider: SessionProvider<*>): Unit

Register a session provider

Extension Functions

cookie
fun <S : Any> Configuration.cookie(
    name: String,
    sessionType: KClass<S>,
    storage: SessionStorage
): Unit
fun <S : Any> Configuration.cookie(
    name: String,
    storage: SessionStorage
): Unit
fun <S : Any> Configuration.cookie(
    name: String,
    sessionType: KClass<S>,
    storage: SessionStorage,
    block: CookieIdSessionBuilder<S>.() -> Unit
): Unit

Configure sessions to get it from cookie using session storage

fun <S : Any> Configuration.cookie(
    name: String,
    storage: SessionStorage,
    block: CookieIdSessionBuilder<S>.() -> Unit
): Unit

Configures a session using a cookie with the specified name using it as a session id. The actual content of the session is stored at server side using the specified storage. The cookie configuration can be set inside block using the cookie property exposed by CookieIdSessionBuilder.

fun <S : Any> Configuration.cookie(
    name: String,
    sessionType: KClass<S>
): Unit
fun <S : Any> Configuration.cookie(name: String): Unit

Configure sessions to serialize to/from HTTP cookie

fun <S : Any> Configuration.cookie(
    name: String,
    block: CookieSessionBuilder<S>.() -> Unit
): Unit

Configures a session using a cookie with the specified name using it as for the actual session content optionally transformed by specified transforms in block. The cookie configuration can be set inside block using the cookie property exposed by CookieIdSessionBuilder.

fun <S : Any> Configuration.cookie(
    name: String,
    sessionType: KClass<S>,
    block: CookieSessionBuilder<S>.() -> Unit
): Unit

Configure sessions to serialize to/from HTTP cookie configuring it by block

header
fun <S : Any> Configuration.header(
    name: String,
    sessionType: KClass<S>,
    storage: SessionStorage
): Unit
fun <S : Any> Configuration.header(
    name: String,
    storage: SessionStorage
): Unit

Configure sessions to get it from HTTP header using session storage

fun <S : Any> Configuration.header(
    name: String,
    storage: SessionStorage,
    block: HeaderIdSessionBuilder<S>.() -> Unit
): Unit
fun <S : Any> Configuration.header(
    name: String,
    sessionType: KClass<S>,
    storage: SessionStorage,
    block: HeaderIdSessionBuilder<S>.() -> Unit
): Unit

Configures a session using a header with the specified name using it as a session id. The actual content of the session is stored at server side using the specified storage.

fun <S : Any> Configuration.header(
    name: String,
    sessionType: KClass<S>
): Unit
fun <S : Any> Configuration.header(name: String): Unit

Configure sessions to serialize to/from HTTP header

fun <S : Any> Configuration.header(
    name: String,
    block: HeaderSessionBuilder<S>.() -> Unit
): Unit

Configures a session using a header with the specified name using it for the actual session content optionally transformed by specified transforms in block.

fun <S : Any> Configuration.header(
    name: String,
    sessionType: KClass<S>,
    block: HeaderSessionBuilder<S>.() -> Unit
): Unit

Configures a session using a header with the specified name using it for the actual session content and apply block function to configure serializataion and optional transformations