Returns the number of bytes of application data (UTF-8 text and binary data) that have been queued using send() but not yet been transmitted to the network.

CLOSED

val CLOSED: WebSocket.ReadyState

closeEvent

val closeEvent: EventInstance<CloseEvent, WebSocket, WebSocket>

MDN Reference

CLOSING

val CLOSING: WebSocket.ReadyState

CONNECTING

val CONNECTING: WebSocket.ReadyState

errorEvent

val errorEvent: EventInstance<Event, WebSocket, WebSocket>

MDN Reference

extensions

val extensions: String

Returns the extensions selected by the server, if any.

messageEvent

val messageEvent: EventInstance<MessageEvent<Any?>, WebSocket, WebSocket>

MDN Reference

onclose

var onclose: EventHandler<CloseEvent, WebSocket, WebSocket>?

MDN Reference

onerror

var onerror: EventHandler<Event, WebSocket, WebSocket>?

MDN Reference

onmessage

var onmessage: EventHandler<MessageEvent<*>, WebSocket, WebSocket>?

MDN Reference

onopen

var onopen: EventHandler<Event, WebSocket, WebSocket>?

MDN Reference

OPEN

val OPEN: WebSocket.ReadyState

openEvent

val openEvent: EventInstance<Event, WebSocket, WebSocket>

MDN Reference

protocol

val protocol: String

Returns the subprotocol selected by the server, if any. It can be used in conjunction with the array form of the constructor's second argument to perform subprotocol negotiation.

readyState

val readyState: WebSocket.ReadyState

Returns the state of the WebSocket object's connection. It can have the values described below.

url

val url: String

Returns the URL that was used to establish the WebSocket connection.

Functions

fun close(code: Short = definedExternally, reason: String = definedExternally)

Closes the WebSocket connection, optionally using code as the the WebSocket connection close code and reason as the the WebSocket connection close reason.

dispatchEvent

fun dispatchEvent(event: Event): Boolean

send

fun send(data: ArrayBufferLike)

fun send(data: ArrayBufferView<*>)

fun send(data: Blob)

fun send(data: String)

Transmits data using the WebSocket connection. data can be a string, a Blob, an ArrayBuffer, or an ArrayBufferView.