ktor-server-sessions/io.ktor.server.sessions/SessionTransportCookie

SessionTransportCookie

class SessionTransportCookie(name: String, configuration: CookieConfiguration, transformers: List<SessionTransportTransformer>) : SessionTransport

A session transport that adds the Set-Cookie header and reads the Cookie header for the specified cookie name, and a specific cookie configuration after applying/un-applying the specified transforms defined by transformers.

Constructors

fun SessionTransportCookie(name: String, configuration: CookieConfiguration, transformers: List<SessionTransportTransformer>)

Functions

clear

open override fun clear(call: ApplicationCall)

Clears a session information from a specific call.

receive

open override fun receive(call: ApplicationCall): String?

Gets a session information from a call and returns a String if success or null if failed.

send

open override fun send(call: ApplicationCall, value: String)

Sets a session information represented by value to a call.

toString

open override fun toString(): String

Properties

configuration

val configuration: CookieConfiguration

is a cookie configuration

name

val name: String

is a cookie name

transformers

val transformers: List<SessionTransportTransformer>

is a list of session transformers