Class WebSocketHandlerAbstract

A WebSocketHandler handles the communication with multiple WebSockets

Hierarchy

Constructors

Methods

Constructors

Methods

  • Checks if the input can be handled by this class. If it cannot handle the input, rejects with an error explaining why.

    Returns

    A promise resolving if the input can be handled, rejecting with an Error if not.

    Parameters

    • input: { upgradeRequest: HttpRequest; webSocket: WebSocket }

      Input that could potentially be handled.

    Returns Promise<void>

  • Handles the given input. This may only be called if canHandle did not reject. When unconditionally calling both in sequence, consider handleSafe instead.

    Returns

    A promise resolving when handling is finished.

    Parameters

    • input: { upgradeRequest: HttpRequest; webSocket: WebSocket }

      Input that needs to be handled.

    Returns Promise<void>

  • Helper function that first runs canHandle followed by handle. Throws the error of canHandle if the data cannot be handled, or returns the result of handle otherwise.

    Returns

    A promise resolving if the input can be handled, rejecting with an Error if not.

    Parameters

    • input: { upgradeRequest: HttpRequest; webSocket: WebSocket }

      Input data that will be handled if it can be handled.

    Returns Promise<void>