Class WebSocketTransport

Represents a stream through a web socket. Use the static connectTo method to get a stream to a web socket server.

Hierarchy

  • BaseMessageTransport
    • WebSocketTransport

Constructors

constructor

Properties

errorEmitter id onError socket state

Methods

_dispatchReceivedMessage _onConnectionClosed _sendImpl close dispose log send setListener toString connectTo fromWebSocket

Constructors

Private constructor

Properties

Private Readonly errorEmitter

errorEmitter: any

Protected Readonly id

id: number

Readonly onError

onError: EventEmitter<{
    error: unknown;
}>

Type declaration

  • error: unknown

Private Readonly socket

socket: any

Readonly state

state: ValueWithChangeEvent<ConnectionState>

Methods

Protected _dispatchReceivedMessage

  • _dispatchReceivedMessage(message): void

  • Call this in derived classes to signal a new message.

    Parameters

    • message: Message

    Returns void

Protected _onConnectionClosed

  • _onConnectionClosed(): void

  • Call this in derived classes to signal that the connection closed.

    Returns void

_sendImpl

  • _sendImpl(message): Promise<void>

  • Parameters

    • message: Message

    Returns Promise<void>

close

  • close(): void

  • Closes the underlying socket.

    Returns void

dispose

  • dispose(): void

  • Same as close.

    Returns void

log

  • log(logger?): IMessageTransport

  • Parameters

    • Optional logger: IMessageLogger

    Returns IMessageTransport

send

  • send(message): Promise<void>

  • Writes a message to the stream.

    Parameters

    • message: Message

    Returns Promise<void>

setListener

  • setListener(listener): void

  • Sets a callback for incoming messages.

    Parameters

    • listener: undefined | MessageListener

    Returns void

toString

  • toString(): string

  • Returns string

Static connectTo

Static fromWebSocket

Settings

Member Visibility

Theme

On This Page

constructorerrorEmitteridonErrorsocketstate_dispatchReceivedMessage_onConnectionClosed_sendImplclosedisposelogsendsetListenertoStringconnectTofromWebSocket