Close

expect class Close(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(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(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

Link copied to clipboard
fun Close(buffer: ByteBuffer)
Link copied to clipboard
expect fun Close(reason: CloseReason)
actual fun Close(reason: CloseReason)
actual fun Close(reason: CloseReason)
Link copied to clipboard
expect fun Close(packet: ByteReadPacket)
actual fun Close(packet: ByteReadPacket)
actual fun Close(packet: ByteReadPacket)
Link copied to clipboard
expect fun Close()
actual fun Close()
actual fun Close()
Link copied to clipboard
expect fun Close(data: ByteArray)
actual fun Close(data: ByteArray)
actual fun Close(data: ByteArray)

Functions

Link copied to clipboard
expect fun copy(): Frame

Creates a frame copy

actual fun copy(): Frame

Creates a frame copy.

actual fun copy(): Frame

Creates a frame copy.

Link copied to clipboard
open override fun toString(): String
open override fun toString(): String

Properties

Link copied to clipboard
val buffer: ByteBuffer

Frame content

Link copied to clipboard
expect val data: ByteArray
actual val data: ByteArray
actual val data: ByteArray
Link copied to clipboard
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

Link copied to clipboard
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

Link copied to clipboard
expect val frameType: FrameType

enum value

actual val frameType: FrameType

enum value

actual val frameType: FrameType

enum value

Link copied to clipboard
expect val rsv1: Boolean

First extension bit.

actual val rsv1: Boolean
actual open val rsv1: Boolean
Link copied to clipboard
expect val rsv2: Boolean

Second extension bit.

actual val rsv2: Boolean
actual open val rsv2: Boolean
Link copied to clipboard
expect val rsv3: Boolean

Third extension bit.

actual val rsv3: Boolean
actual open val rsv3: Boolean

Extensions

Link copied to clipboard
fun Frame.Close.readReason(): CloseReason?

Read close reason from close frame or null if no close reason provided

Link copied to clipboard
@JvmName(name = "readReason")
fun Frame.Close.readReason0(): CloseReason?