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

Close

expect class Close(data: ByteArray) : Frame

Represents a low-level level close frame. It could be sent to indicate WebSocket session end. Usually there is no need to send/handle it unless you have a RAW WebSocket session.

actual class Close(val data: ByteArray) : Frame

Represents a low-level level close frame. It could be sent to indicate web socket session end. Usually there is no need to send/handle it unless you have a RAW web socket session.

actual class Close(val data: ByteArray) : Frame

Represents a low-level level close frame. It could be sent to indicate web socket session end. Usually there is no need to send/handle it unless you have a RAW web socket session.

actual class Close(val data: ByteArray) : Frame

Represents a low-level level close frame. It could be sent to indicate web socket session end. Usually there is no need to send/handle it unless you have a RAW web socket session.

Constructors

fun Close(buffer: ByteBuffer)

expect fun Close(reason: CloseReason)

actual fun Close(reason: CloseReason)

actual fun Close(reason: CloseReason)

actual fun Close(reason: CloseReason)

expect fun Close(packet: ByteReadPacket)

actual fun Close(packet: ByteReadPacket)

actual fun Close(packet: ByteReadPacket)

actual fun Close(packet: ByteReadPacket)

expect fun Close()

actual fun Close()

actual fun Close()

actual fun Close()

expect fun Close(data: ByteArray)

actual fun Close(data: ByteArray)

actual fun Close(data: ByteArray)

actual fun Close(data: ByteArray)

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.Close.readReason(): CloseReason?

Reads the close reason from the close frame or null if no close reason is provided.