ktor-websockets/io.ktor.websocket/WebSocketWriter

WebSocketWriter

class WebSocketWriter(writeChannel: ByteWriteChannel, val coroutineContext: CoroutineContext, var masking: Boolean = false, val pool: ObjectPool<ByteBuffer> = KtorDefaultPool) : CoroutineScope

Class that processes written outgoing Websocket Frame, serializes them and writes the bits into the writeChannel.

Constructors

WebSocketWriter

constructor(writeChannel: ByteWriteChannel, coroutineContext: CoroutineContext, masking: Boolean = false, pool: ObjectPool<ByteBuffer> = KtorDefaultPool)

Properties

coroutineContext

open override val coroutineContext: CoroutineContext

var masking: Boolean

: whether it will mask serialized frames.

val outgoing: SendChannel<Frame>

Channel for sending Websocket's Frame that will be serialized and written to writeChannel.

val pool: ObjectPool<ByteBuffer>

: ByteBuffer pool to be used by this writer

Functions

suspend fun flush()

Ensures all enqueued messages has been written

suspend fun send(frame: Frame)

Send a frame and write it and all outstanding frames in the queue