RawWebSocket

class RawWebSocket(input: ByteReadChannel, output: ByteWriteChannel, maxFrameSize: Long, masking: Boolean, coroutineContext: CoroutineContext, pool: ObjectPool<ByteBuffer>) : WebSocketSession

Represents a RAW web socket session

Constructors

Link copied to clipboard
fun RawWebSocket(input: ByteReadChannel, output: ByteWriteChannel, maxFrameSize: Long = Int.MAX_VALUE.toLong(), masking: Boolean = false, coroutineContext: CoroutineContext, pool: ObjectPool<ByteBuffer> = KtorDefaultPool)

Functions

Link copied to clipboard
open suspend override fun flush()

Flush all outstanding messages and suspend until all earlier sent messages will be written. Could be called at any time even after close. May return immediately if the connection is already terminated. However it may also fail with an exception (or cancellation) at any point due to session failure. Please note that flush doesn't guarantee that frames were actually delivered.

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

Enqueue frame, may suspend if outgoing queue is full. May throw an exception if outgoing channel is already closed so it is impossible to transfer any message. Frames that were sent after close frame could be silently ignored. Please note that close frame could be sent automatically in reply to a peer close frame unless it is raw websocket session.

Link copied to clipboard
open override fun terminate()

Initiate connection termination immediately. Termination may complete asynchronously.

Properties

Link copied to clipboard
open override val coroutineContext: CoroutineContext
Link copied to clipboard
open override val extensions: List<WebSocketExtension<*>>

Negotiated WebSocket extensions.

Link copied to clipboard
open override val incoming: ReceiveChannel<Frame>

Incoming frames channel

Link copied to clipboard
open override var masking: Boolean

Enable or disable masking output messages by a random xor mask. Please note that changing this flag on the fly could be applied to the messages already sent (enqueued earlier) as the sending pipeline works asynchronously

Link copied to clipboard
open override var maxFrameSize: Long

Specifies frame size limit. Connection will be closed if violated

Link copied to clipboard
open override val outgoing: SendChannel<Frame>

Outgoing frames channel. It could have limited capacity so sending too much frames may lead to suspension at corresponding send invocations. It also may suspend if a peer doesn't read frames for some reason.

Extensions

Link copied to clipboard
suspend fun RawWebSocket.start(handler: suspend WebSocketSession.() -> Unit)