ktor-ws-events-commons/dev.d1s.ktor.events.commons

Package-level declarations

A module with common code of Ktor WS Events project - Event delivery extensions for Ktor (Server/Client) over WebSocket protocol.

Types

Client parameters passed to the server. The parameters are only scoped to the connection. When firing an event, server can handle them.

Event group is used to combine events of the same type. For example: "book_updated" or "book_created".

Event principal is used to combine events related to the same object. It could be any identifier of the object.

@Serializable

data class EventReference(val group: EventGroup, val principal: EventPrincipal = null, val parameters: ClientParameters = mapOf())

Event reference acts as a type for all events.

typealias UnixTime = Long

fun ref(group: EventGroup, principal: EventPrincipal = null, clientParameters: ClientParameters = mapOf()): EventReference

A shortcut.