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

Package-level declarations

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

Types

@Serializable

data class ClientWebSocketEvent<T>(val id: Identifier, val reference: EventReference, val initiated: UnixTime, val data: T) : AbstractEvent

WebSocketEventsConfiguration

class WebSocketEventsConfiguration

Properties

EventReceiverLog

val EventReceiverLog: KmLog

EventReceivingScope

val EventReceivingScope: CoroutineScope

WebSocketEvents

val WebSocketEvents: ClientPlugin<WebSocketEventsConfiguration>

Functions

receiveWebSocketEvent

inline suspend fun <T> DefaultClientWebSocketSession.receiveWebSocketEvent(): ClientWebSocketEvent<T>

Dequeues a frame containing ClientWebSocketEvent and tries to deserialize it.

receiveWebSocketEvents

inline suspend fun <T> DefaultClientWebSocketSession.receiveWebSocketEvents(crossinline receiver: suspend (ClientWebSocketEvent<T>) -> Unit): Job

Dequeues frames containing ClientWebSocketEvent and tries to deserialize it. Will retry if something went wrong while receiving a frame.

webSocketEvents

suspend fun HttpClient.webSocketEvents(reference: EventReference, path: String = Routes.DEFAULT_EVENTS_ROUTE, block: suspend DefaultClientWebSocketSession.() -> Unit)

Opens a block with DefaultClientWebSocketSession associated with the given event reference and optional path.

withRetries

suspend fun <R> withRetries(continuous: Boolean = false, onError: suspend (Throwable) -> Unit = {}, block: suspend () -> R)