ktor-websockets/io.ktor.websocket/Frame/Binary

Binary

expect class Binary(fin: Boolean, data: ByteArray, rsv1: Boolean = false, rsv2: Boolean = false, rsv3: Boolean = false) : Frame

Represents an application level binary frame. In a RAW WebSocket session a big text frame could be fragmented (separated into several text frames, so they have fin = false except the last one). Note that usually there is no need to handle fragments unless you have a RAW web socket session.

actual class Binary(val fin: Boolean, val data: ByteArray, val rsv1: Boolean, val rsv2: Boolean, val rsv3: Boolean) : Frame

Represents an application level binary frame. In a RAW web socket session a big text frame could be fragmented (separated into several text frames so they have fin = false except the last one). Note that usually there is no need to handle fragments unless you have a RAW web socket session.

actual class Binary(val fin: Boolean, val data: ByteArray, val rsv1: Boolean, val rsv2: Boolean, val rsv3: Boolean) : Frame

Represents an application level binary frame. In a RAW web socket session a big text frame could be fragmented (separated into several text frames so they have fin = false except the last one). Note that usually there is no need to handle fragments unless you have a RAW web socket session.

actual class Binary(val fin: Boolean, val data: ByteArray, val rsv1: Boolean, val rsv2: Boolean, val rsv3: Boolean) : Frame

Represents an application level binary frame. In a RAW web socket session a big text frame could be fragmented (separated into several text frames so they have fin = false except the last one). Note that usually there is no need to handle fragments unless you have a RAW web socket session.

Constructors

fun Binary(fin: Boolean, buffer: ByteBuffer)

expect fun Binary(fin: Boolean, data: ByteArray)

actual fun Binary(fin: Boolean, data: ByteArray)

actual fun Binary(fin: Boolean, data: ByteArray)

actual fun Binary(fin: Boolean, data: ByteArray)

expect fun Binary(fin: Boolean, packet: ByteReadPacket)

actual fun Binary(fin: Boolean, packet: ByteReadPacket)

actual fun Binary(fin: Boolean, packet: ByteReadPacket)

actual fun Binary(fin: Boolean, packet: ByteReadPacket)

expect fun Binary(fin: Boolean, data: ByteArray, rsv1: Boolean = false, rsv2: Boolean = false, rsv3: Boolean = false)

actual fun Binary(fin: Boolean, data: ByteArray, rsv1: Boolean, rsv2: Boolean, rsv3: Boolean)

actual fun Binary(fin: Boolean, data: ByteArray, rsv1: Boolean, rsv2: Boolean, rsv3: Boolean)

actual fun Binary(fin: Boolean, data: ByteArray, rsv1: Boolean, rsv2: Boolean, rsv3: Boolean)

Functions

expect fun copy(): Frame

Creates a frame copy.

actual fun copy(): Frame

Creates a frame copy.

actual fun copy(): Frame

Creates a frame copy.

actual fun copy(): Frame

Creates a frame copy.

open override fun toString(): String

open override fun toString(): String

open override fun toString(): String

Properties

val buffer: ByteBuffer

Frame content

expect val data: ByteArray

actual val data: ByteArray

actual val data: ByteArray

actual val data: ByteArray

disposableHandle

expect val disposableHandle: DisposableHandle

could be invoked when the frame is processed

actual val disposableHandle: DisposableHandle

could be invoked when the frame is processed

actual val disposableHandle: DisposableHandle

could be invoked when the frame is processed

actual val disposableHandle: DisposableHandle

could be invoked when the frame is processed

expect val fin: Boolean

is it final fragment, should be always true for control frames and if no fragmentation is used

actual val fin: Boolean

is it final fragment, should be always true for control frames and if no fragmentation is used

actual val fin: Boolean

is it final fragment, should be always true for control frames and if no fragmentation is used

actual val fin: Boolean

is it final fragment, should be always true for control frames and if no fragmentation is used

expect val frameType: FrameType

enum value

actual val frameType: FrameType

enum value

actual val frameType: FrameType

enum value

actual val frameType: FrameType

enum value

expect val rsv1: Boolean

First extension bit.

actual val rsv1: Boolean

actual val rsv1: Boolean

actual val rsv1: Boolean

expect val rsv2: Boolean

Second extension bit.

actual val rsv2: Boolean

actual val rsv2: Boolean

actual val rsv2: Boolean

expect val rsv3: Boolean

Third extension bit.

actual val rsv3: Boolean

actual val rsv3: Boolean

actual val rsv3: Boolean

Extensions

fun Frame.readBytes(): ByteArray

Reads binary content from the frame. For fragmented frames only returns this fragment.