ktor-server-sse/io.ktor.server.sse/Heartbeat

Heartbeat

class Heartbeat(source)

Represents a heartbeat configuration for a ServerSSESession.

Report a problem

Constructors

constructor()

Properties

var event: ServerSentEvent

the ServerSentEvent to be sent as the heartbeat, default is a ServerSentEvent with the comment "heartbeat". Ignored when eventProvider is set.

var eventProvider: suspend () -> ServerSentEvent?

when set, invoked on each tick to produce the ServerSentEvent (e.g. for a per-tick timestamp); takes precedence over event.

var period: Duration

the duration between heartbeat events, default is 30 seconds.