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

Text

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

Represents an application level text 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). Please note that a boundary between fragments could be in the middle of multi-byte (unicode) character so don't apply String constructor to every fragment but use decoder loop instead of concatenate fragments first. Note that usually there is no need to handle fragments unless you have a RAW web socket session.

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

Represents an application level text 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). Please note that a boundary between fragments could be in the middle of multi-byte (unicode) character so don't apply String constructor to every fragment but use decoder loop instead of concatenate fragments first. Note that usually there is no need to handle fragments unless you have a RAW web socket session.

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

Represents an application level text 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). Please note that a boundary between fragments could be in the middle of multi-byte (unicode) character so don't apply String constructor to every fragment but use decoder loop instead of concatenate fragments first. Note that usually there is no need to handle fragments unless you have a RAW web socket session.

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

Represents an application level text 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). Please note that a boundary between fragments could be in the middle of multi-byte (unicode) character so don't apply String constructor to every fragment but use decoder loop instead of concatenate fragments first. Note that usually there is no need to handle fragments unless you have a RAW web socket session.

Constructors

fun Text(fin: Boolean, buffer: ByteBuffer)

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

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

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

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

expect fun Text(text: String)

actual fun Text(text: String)

actual fun Text(text: String)

actual fun Text(text: String)

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

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

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

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

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

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

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

actual fun Text(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.

fun Frame.Text.readText(): String

Reads text content from the text frame. Shouldn't be used for fragmented frames: such frames need to be reassembled first.