Interface WebSocketHandler

interface WebSocketHandler {
    type:
        | "timeout"
        | "close-connection"
        | "reset-connection"
        | "ws-passthrough"
        | "ws-echo"
        | "ws-listen"
        | "ws-reject";
    dispose(): void;
    explain(): string;
    handle(request: OngoingRequest & IncomingMessage, socket: Socket, head: Buffer): Promise<void>;
}

Hierarchy (view full)

WebSocketHandlerDefinition
- WebSocketHandler

Index

Properties

Methods

dispose explain handle

Properties

type

type:
    | "timeout"
    | "close-connection"
    | "reset-connection"
    | "ws-passthrough"
    | "ws-echo"
    | "ws-listen"
    | "ws-reject"

Methods

dispose

dispose(): void
Returns void
Inherited from WebSocketHandlerDefinition.dispose
- Defined in serialization/serialization.ts:96

explain

explain(): string
Returns string
Inherited from WebSocketHandlerDefinition.explain
- Defined in types.ts:422

handle

handle(request, socket, head): Promise<void>
Parameters
- request: OngoingRequest & IncomingMessage
- socket: Socket
- head: Buffer
Returns Promise<void>
- Defined in rules/websockets/websocket-handlers.ts:57