ktor-server-sessions/io.ktor.server.sessions/header

header

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

Configures Sessions to pass a session identifier in a name HTTP header and store the serialized session's data in the server storage.


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

Configures Sessions to pass a session identifier in a name HTTP header and store the serialized session's data in the server storage. The block parameter allows you to configure additional settings, for example, sign and encrypt session data.


fun <S : Any> SessionsConfig.header(name: String, sessionType: KClass<S>)
Content copied to clipboard

Configures Sessions to pass the serialized session's data in a name HTTP header.


inline fun <S : Any> SessionsConfig.header(name: String)
Content copied to clipboard

Configures Sessions to pass the serialized session's data in a name HTTP header.

In the example below, session data will be passed to the client using the cart_session custom header.

install(Sessions) {
    header<CartSession>("cart_session")
}
Content copied to clipboard

On the client side, you need to append this header to each request to get session data.


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

Configures Sessions to pass the serialized session's data in a name HTTP header. The block parameter allows you to configure additional settings, for example, sign and encrypt session data.