kobweb-common/com.varabyte.kobweb.project.conf/Server/Streaming

Streaming

@Serializable

class Streaming(val pingPeriod: Duration = Duration.ZERO, val timeout: Duration = 15.seconds)(source)

Configuration for Streaming APIs.

Streaming APIs work through the WebSockets API, so configuring this section looks like configuring WebSockets. Therefore, you can refer to WebSockets documentation for more details.

See also: https://ktor.io/docs/websocket.html See also: https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API

Parameters

pingPeriod

The duration between pings or 0 to disable pings.

timeout

The write/ping timeout after that a connection will be closed.

Constructors

Streaming

constructor(pingPeriod: Duration = Duration.ZERO, timeout: Duration = 15.seconds)

Properties

pingPeriod

val pingPeriod: Duration

timeout

val timeout: Duration