Class WebSocketConnection

The WebSocket connection is the main class that holds a connection between the client and the server

Constructors

constructor

Properties

_closingPromise _onError _onMessage _open _pendingRequests _ws _wsOpen

Methods

_createWebSocket _ensureOpen _safeCloseWebSocket close write

Constructors

constructor

  • new WebSocketConnection(url, onMessage, onError): WebSocketConnection

  • This constructor should not be called directly

    Parameters

    • url: URL

      the URL of the remote MillenniumDB server

    • onMessage: ((iobuffer) => void)

      the callback that will handle the received data

        • (iobuffer): void

        • Parameters

          Returns void

    • onError: ((error) => void)
        • (error): void

        • Parameters

          • error: string

          Returns void

    Returns WebSocketConnection

Properties

Private _closingPromise

_closingPromise: null | Promise<void>

Private Readonly _onError

_onError: ((error) => void)

Type declaration

    • (error): void

    • Parameters

      • error: string

      Returns void

Private Readonly _onMessage

_onMessage: ((iobuffer) => void)

Type declaration

    • (iobuffer): void

    • Parameters

      Returns void

Private _open

_open: boolean

Private Readonly _pendingRequests

_pendingRequests: IOBuffer[]

Private Readonly _ws

_ws: WebSocketType

Private _wsOpen

_wsOpen: boolean

Methods

Private _createWebSocket

Private _ensureOpen

Private _safeCloseWebSocket

close

  • close(): Promise<void>

  • Close the connection

    Returns Promise<void>

    Promise that will be resolved when the connection is closed

write

  • write(iobuffer): void

  • Write a request. If the connection is not established yet, it will be enqueued

    Parameters

    • iobuffer: IOBuffer

      a buffer containing the request

    Returns void

Settings

Member Visibility

Theme

On This Page

constructor_closingPromise_onError_onMessage_open_pendingRequests_ws_wsOpen_createWebSocket_ensureOpen_safeCloseWebSocketclosewrite