Interface IWebSocketServerConnection

a connection to a WebSocket server (not to be confused with client-side connection!)

interface IWebSocketServerConnection {
    close: () => void;
    headers: Headers;
    localAddress: null | TcpEndpoint;
    read: (into: Uint8Array) => Promise<number>;
    remoteAddress: null | TcpEndpoint;
    url: string;
    write: (bytes: Uint8Array) => Promise<void>;
}

Hierarchy (View Summary)

Properties

close headers localAddress read remoteAddress url write

Properties

close

close: () => void

Close the underlying source.

Readonlyheaders

headers: Headers

headers from the handshake request

ReadonlylocalAddress

localAddress: null | TcpEndpoint

local address of the connection (if available)

read

read: (into: Uint8Array) => Promise<number>

Read data from the underlying source into the provided Uint8Array, up to the length of the array, and return the number of bytes read.

If there are no bytes available currently, the implementation is supposed to wait until at least one byte is available, and only then resolve the promise. Resolving the promise with a zero-length Uint8Array is marking the end of the source.

Type declaration

    • (into: Uint8Array): Promise<number>

    • Parameters

      • into: Uint8Array

      Returns Promise<number>

      Uint8Array containing the bytes that were read.

ReadonlyremoteAddress

remoteAddress: null | TcpEndpoint

remote address of the connection (if available)

Readonlyurl

url: string

URL of the handshake request

write

write: (bytes: Uint8Array) => Promise<void>

Write bytes to the underlying stream, resolving once the write is complete

Settings

Member Visibility

On This Page

Properties