Interface WebSocketInterface

Interface that describes the Subset of WebSocket features used by the WebTlsClient. For Documentation see

interface WebSocketInterface {
    binaryType: BinaryType;
    readyState: Number;
    close(code?: number, reason?: string): void;
    send(data: string | ArrayBufferView | ArrayBufferLike): void;
    onclose: null | ((this: WebSocketInterface, ev: CloseEvent) => unknown);
    onerror: null | ((this: WebSocketInterface, ev: Event) => unknown);
    onmessage: null | ((this: WebSocketInterface, ev: MessageEvent) => unknown);
    onopen: null | ((this: WebSocketInterface, ev: Event) => unknown);
}

Implemented by

TunneledWebSocket

Index

Properties

binaryType readyState onclose onerror onmessage onopen

Methods

Properties

binaryType

binaryType: BinaryType

readyState

readyState: Number

onclose

onclose: null | ((this: WebSocketInterface, ev: CloseEvent) => unknown)

onerror

onerror: null | ((this: WebSocketInterface, ev: Event) => unknown)

onmessage

onmessage: null | ((this: WebSocketInterface, ev: MessageEvent) => unknown)

onopen

onopen: null | ((this: WebSocketInterface, ev: Event) => unknown)

Methods

close

close(code?: number, reason?: string): void
Parameters
- Optionalcode: number
- Optionalreason: string
Returns void

send

send(data: string | ArrayBufferView | ArrayBufferLike): void
Parameters
- data: string | ArrayBufferView | ArrayBufferLike
Returns void