ktor-websockets/io.ktor.websocket/CloseReason

CloseReason

data class CloseReason(val code: Short, val message: String)(source)

A WebSocket close reason.

Report a problem

Throws

IllegalArgumentException

if message is longer than 123 bytes when UTF-8-encoded

Constructors

constructor(code: Short, message: String)

constructor(code: CloseReason.Codes, message: String)

Types

enum Codes : Enum<CloseReason.Codes>

Standard close reason codes

Properties

val code: Short

val knownReason: CloseReason.Codes?

An enum value for this code or null if the code is not listed in Codes

val message: String

Functions

open override fun toString(): String