Class UnsecureWebSocketsProtocol

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

Hierarchy

WebSocketHandler
- UnsecureWebSocketsProtocol

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new UnsecureWebSocketsProtocol(source: EventEmitter): UnsecureWebSocketsProtocol

Overrides WebSocketHandler.constructor
- Defined in src/http/UnsecureWebSocketsProtocol.ts:124
Parameters
- source: EventEmitter
Returns UnsecureWebSocketsProtocol

Properties

Private Readonly listeners

listeners: Set<WebSocketListener> = ...

Private Readonly logger

logger: Logger = ...

Methods

canHandle

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

Inherited from WebSocketHandler.canHandle
- Defined in src/util/handlers/AsyncHandler.ts:13
Checks if the input can be handled by this class. If it cannot handle the input, rejects with an error explaining why.

Parameters
- input: { upgradeRequest: HttpRequest; webSocket: WebSocket }
  Input that could potentially be handled.
  - upgradeRequest: HttpRequest
  - webSocket: WebSocket
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>

Overrides WebSocketHandler.handle
- Defined in src/http/UnsecureWebSocketsProtocol.ts:129
Handles the given input. This may only be called if canHandle did not reject. When unconditionally calling both in sequence, consider handleSafe instead.

Parameters
- input: { upgradeRequest: HttpRequest; webSocket: WebSocket }
  - upgradeRequest: HttpRequest
  - webSocket: WebSocket
Returns Promise<void>
A promise resolving when handling is finished.

handleSafe

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

Inherited from WebSocketHandler.handleSafe
- Defined in src/util/handlers/AsyncHandler.ts:34
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.

Parameters
- input: { upgradeRequest: HttpRequest; webSocket: WebSocket }
  Input data that will be handled if it can be handled.
  - upgradeRequest: HttpRequest
  - webSocket: WebSocket
Returns Promise<void>
A promise resolving if the input can be handled, rejecting with an Error if not.

Private onResourceChanged

onResourceChanged(changed: ResourceIdentifier): void

- Defined in src/http/UnsecureWebSocketsProtocol.ts:141
Parameters
- changed: ResourceIdentifier
Returns void