Class NodeWebSocketServer

a listener for connections

Hierarchy

NodeWebSocketServerBase<NodeWebSocketConnection>
- NodeWebSocketServer

Implements

IListener<TcpEndpoint, IWebSocketServerConnection>

Index

Constructors

Properties

Accessors

Methods

accept close handleUpgrade makeConnection

Constructors

constructor

new NodeWebSocketServer(server: WebSocketServer): NodeWebSocketServer
Parameters
- server: WebSocketServer
  Underlying server
Returns NodeWebSocketServer
Inherited from NodeWebSocketServerBase<NodeWebSocketConnection>.constructor
- Defined in node/src/net/websocket.ts:161

Properties

`Readonly`server

server: WebSocketServer

Underlying server

Accessors

address

get address(): null | TcpEndpoint
address of the listener (if available)

Returns null | TcpEndpoint
Implementation of IListener.address
Inherited from NodeWebSocketServerBase.address
- Defined in node/src/net/websocket.ts:184

Methods

accept

accept(): Promise<NodeWebSocketConnection>
Returns Promise<NodeWebSocketConnection>
Implementation of IListener.accept
Inherited from NodeWebSocketServerBase.accept
- Defined in node/src/net/websocket.ts:206

close

close(): void
Returns void
Implementation of IListener.close
Inherited from NodeWebSocketServerBase.close
- Defined in node/src/net/websocket.ts:202

handleUpgrade

handleUpgrade(req: IncomingMessage, socket: Duplex, head: Buffer): void
Parameters
- req: IncomingMessage
- socket: Duplex
- head: Buffer
Returns void
Inherited from NodeWebSocketServerBase.handleUpgrade
- Defined in node/src/net/websocket.ts:219

makeConnection

makeConnection(
socket: WebSocket,
request: IncomingMessage,
): NodeWebSocketConnection
Parameters
- socket: WebSocket
- request: IncomingMessage
Returns NodeWebSocketConnection
Overrides NodeWebSocketServerBase.makeConnection
- Defined in node/src/net/websocket.ts:236