ktor-websocket-serialization/io.ktor.websocket.serialization

Package-level declarations

Functions

Link copied to clipboard
inline suspend fun <T> WebSocketSession.receiveDeserializedBase(converter: WebsocketContentConverter, charset: Charset): Any?

Dequeues a frame and deserializes it to the type T using converter. May throw WebsocketDeserializeException if the received frame type is not Frame.Text or Frame.Binary. In this case, WebsocketDeserializeException.frame contains the received frame. May throw ClosedReceiveChannelException if a channel was closed

suspend fun WebSocketSession.receiveDeserializedBase(typeInfo: TypeInfo, converter: WebsocketContentConverter, charset: Charset): Any?

Dequeues a frame and deserializes it to the type T using converter. May throw WebsocketDeserializeException if the received frame type is not Frame.Text or Frame.Binary. In this case, WebsocketDeserializeException.frame contains the received frame. May throw ClosedReceiveChannelException if a channel was closed

Link copied to clipboard
inline suspend fun <T> WebSocketSession.sendSerializedBase(data: Any?, converter: WebsocketContentConverter, charset: Charset)
suspend fun WebSocketSession.sendSerializedBase(data: Any?, typeInfo: TypeInfo, converter: WebsocketContentConverter, charset: Charset)

Serializes data to a frame and enqueues this frame. May suspend if the outgoing queue is full. If the outgoing channel is already closed, throws an exception, so it is impossible to transfer any message. Frames sent after a Close frame are silently ignored. Note that a Close frame could be sent automatically in reply to a peer's Close frame unless it is a raw WebSocket session.