ktor-server-core/io.ktor.sessions/Sessions/Configuration

Configuration

class Configuration
Content copied to clipboard

Sessions configuration builder

Constructors

Link copied to clipboard
fun Configuration()
Content copied to clipboard

Functions

Link copied to clipboard
fun register(provider: SessionProvider<*>)
Content copied to clipboard

Register a session provider

Properties

Link copied to clipboard
val providers: List<SessionProvider<*>>
Content copied to clipboard

List of session providers to be registered

Extensions

Link copied to clipboard
fun <S : Any> Sessions.Configuration.cookie(name: String, sessionType: KClass<S>, storage: SessionStorage)
Content copied to clipboard
inline fun <S : Any> Sessions.Configuration.cookie(name: String, storage: SessionStorage)
Content copied to clipboard
inline fun <S : Any> Sessions.Configuration.cookie(name: String, sessionType: KClass<S>, storage: SessionStorage, block: CookieIdSessionBuilder<S>.() -> Unit)
Content copied to clipboard

Configure sessions to get it from cookie using session storage

inline fun <S : Any> Sessions.Configuration.cookie(name: String, storage: SessionStorage, block: CookieIdSessionBuilder<S>.() -> Unit)
Content copied to clipboard

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> Sessions.Configuration.cookie(name: String, sessionType: KClass<S>)
Content copied to clipboard
inline fun <S : Any> Sessions.Configuration.cookie(name: String)
Content copied to clipboard

Configure sessions to serialize to/from HTTP cookie

inline fun <S : Any> Sessions.Configuration.cookie(name: String, block: CookieSessionBuilder<S>.() -> Unit)
Content copied to clipboard

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.

inline fun <S : Any> Sessions.Configuration.cookie(name: String, sessionType: KClass<S>, block: CookieSessionBuilder<S>.() -> Unit)
Content copied to clipboard

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

Link copied to clipboard
fun <S : Any> Sessions.Configuration.header(name: String, sessionType: KClass<S>, storage: SessionStorage)
Content copied to clipboard
inline fun <S : Any> Sessions.Configuration.header(name: String, storage: SessionStorage)
Content copied to clipboard

Configure sessions to get it from HTTP header using session storage

inline fun <S : Any> Sessions.Configuration.header(name: String, storage: SessionStorage, block: HeaderIdSessionBuilder<S>.() -> Unit)
Content copied to clipboard
inline fun <S : Any> Sessions.Configuration.header(name: String, sessionType: KClass<S>, storage: SessionStorage, block: HeaderIdSessionBuilder<S>.() -> Unit)
Content copied to clipboard

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> Sessions.Configuration.header(name: String, sessionType: KClass<S>)
Content copied to clipboard
inline fun <S : Any> Sessions.Configuration.header(name: String)
Content copied to clipboard

Configure sessions to serialize to/from HTTP header

inline fun <S : Any> Sessions.Configuration.header(name: String, block: HeaderSessionBuilder<S>.() -> Unit)
Content copied to clipboard

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

inline fun <S : Any> Sessions.Configuration.header(name: String, sessionType: KClass<S>, block: HeaderSessionBuilder<S>.() -> Unit)
Content copied to clipboard

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