ktor-websockets/io.ktor.websocket/WebSocketWriter

WebSocketWriter

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

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

Report a problem

Constructors

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

Properties

Link copied to clipboard
open override val coroutineContext: CoroutineContext
Link copied to clipboard
var masking: Boolean

: whether it will mask serialized frames.

Link copied to clipboard
val outgoing: SendChannel<Frame>

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

Link copied to clipboard
val pool: ObjectPool<ByteBuffer>

: ByteBuffer pool to be used by this writer

Functions

Link copied to clipboard
suspend fun flush()

Ensures all enqueued messages has been written

Link copied to clipboard
suspend fun send(frame: Frame)

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