Interface WebSocketHandler

Hierarchy

WebSocketHandlerDefinition
- WebSocketHandler

Index

Properties

type

Methods

Properties

type

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

Methods

dispose

dispose(): void

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

explain

explain(): string

Inherited from WebSocketHandlerDefinition.explain
- Defined in src/types.ts:422
Returns string

handle

handle(request: OngoingRequest & IncomingMessage, socket: Socket, head: Buffer): Promise<void>

- Defined in src/rules/websockets/websocket-handlers.ts:58
Parameters
- request: OngoingRequest & IncomingMessage
- socket: Socket
- head: Buffer
Returns Promise<void>

Generated using TypeDoc