io.ktor.http.cio.websocket / Frame / Close

Close

class Close : 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

<init>

Close(reason: CloseReason)

Close(packet: ByteReadPacket)

Close()

Close(buffer: ByteBuffer)

Close(data: ByteArray)

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.

Inherited Properties

buffer	`val buffer: ByteBuffer` Frame content
data	`val data: ByteArray` a frame content or fragment content
disposableHandle	`val disposableHandle: DisposableHandle` could be invoked when the frame is processed
fin	`val fin: Boolean` is it final fragment, should be always `true` for control frames and if no fragmentation is used
frameType	`val frameType: FrameType` enum value

Inherited Functions

copy	`fun copy(): Frame` Creates a frame copy
toString	`open fun toString(): String`

Extension Functions

readReason

fun Close.readReason(): CloseReason?

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