ktor-server-sessions/io.ktor.server.sessions/CurrentSession

CurrentSession

interface CurrentSession(source)

A container for all session instances.

Report a problem

Functions

Link copied to clipboard
abstract fun clear(name: String)

Clears a session instance for name.

open suspend fun clear(name: String, sessionId: String)

Clears a session with the specified sessionId for the session name.

Link copied to clipboard
inline fun <T : Any> CurrentSession.clear()
fun <T : Any> CurrentSession.clear(klass: KClass<T>)

Clears a session instance with the type T.

inline suspend fun <T : Any> CurrentSession.clear(sessionId: String)

Clears a session with the specified sessionId for the session type T. This method allows clearing sessions by ID without needing the session instance.

suspend fun <T : Any> CurrentSession.clear(klass: KClass<T>, sessionId: String)

Clears a session with the specified sessionId for the session type klass. This method allows clearing sessions by ID without needing the session instance.

Link copied to clipboard
abstract fun findName(type: KClass<*>): String

Finds a session name for the specified type or fails if it's not found.

Link copied to clipboard
abstract fun get(name: String): Any?

Gets a session instance for name

Link copied to clipboard
inline fun <T : Any> CurrentSession.get(): T?
fun <T : Any> CurrentSession.get(klass: KClass<T>): T?

Gets a session instance with the type T.

Link copied to clipboard
inline fun <T : Any> CurrentSession.getOrSet(name: String = findName(T::class), generator: () -> T): T

Gets or generates a new session instance using generator with the type T (or name if specified)

Link copied to clipboard
abstract fun set(name: String, value: Any?)

Sets a new session instance with name.

Link copied to clipboard
inline fun <T : Any> CurrentSession.set(value: T?)
fun <T : Any> CurrentSession.set(value: T?, klass: KClass<T>)

Sets a session instance with the type T.

Generated by Dokka
© 2026 JetBrains s.r.o and contributors. Apache License 2.0