Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UnsecureWebSocketsProtocol

Provides live update functionality following the Solid WebSockets API Spec solid-0.1

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private Readonly listeners

listeners: Set<WebSocketListener> = ...

Private Readonly logger

logger: Logger = ...

Methods

canHandle

  • canHandle(input: { upgradeRequest: HttpRequest; webSocket: WebSocket }): Promise<void>

  • Checks if the input data can be handled by this class. Throws an error if it can't handle the data.

    Parameters

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

      Input data that could potentially be handled.

    Returns Promise<void>

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

handle

  • handle(input: { upgradeRequest: HttpRequest; webSocket: WebSocket }): Promise<void>

handleSafe

  • handleSafe(input: { upgradeRequest: HttpRequest; webSocket: WebSocket }): Promise<void>

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

    Parameters

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

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

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not. Return value depends on the given type.

Private onResourceChanged