ktor-server-sessions/io.ktor.server.sessions/HeaderSessionBuilder

HeaderSessionBuilder

open class HeaderSessionBuilder<S : Any>(source)

A configuration that allows you to configure header settings for Sessions.

Report a problem

Inheritors

HeaderIdSessionBuilder

Properties

sendOnlyIfModified

var sendOnlyIfModified: Boolean

When set to true, session data is not re-sent if unchanged from the incoming value. This avoids unnecessary session headers but prevents session expiration refresh. Session classes should properly implement equals() for this to work correctly. Default: false.

serializer

var serializer: SessionSerializer<S>

Specifies a serializer used to serialize session data.

transformers

val transformers: List<SessionTransportTransformer>

Gets transformers used to sign and encrypt session data.

type

val type: KClass<S>

session instance type

typeInfo

val typeInfo: KType

Functions

transform

fun transform(transformer: SessionTransportTransformer)

Registers a transformer used to sign and encrypt session data.