Class WebSocketServer<User, Auth>

Type parameters

User: null | MachinatUser
Auth

Hierarchy

Emitter<ServerEvents<User, Auth>>
- WebSocketServer

Constructors

constructor

new WebSocketServer<User, Auth>(__namedParameters: ServerOptions<User, Auth>): WebSocketServer<User, Auth>

Overrides Emitter<ServerEvents<User, Auth>>.constructor
- Defined in packages/websocket/src/server.ts:107
Type parameters
- User: null | MachinatUser
- Auth
Parameters
- __namedParameters: ServerOptions<User, Auth>
Returns WebSocketServer<User, Auth>

Properties

id

id: string

marshaler

marshaler: Marshaler

Methods

addListener

addListener<E>(event: E, listener: ServerEvents<User, Auth>[E]): WebSocketServer<User, Auth>

Inherited from Emitter.addListener
- Defined in node_modules/typed-emitter/index.d.ts:24
Type parameters
- E: keyof ServerEvents<User, Auth>
Parameters
- event: E
- listener: ServerEvents<User, Auth>[E]
Returns WebSocketServer<User, Auth>

disconnect

disconnect(conn: ConnIdentifier, reason?: string): Promise<boolean>

- Defined in packages/websocket/src/server.ts:272
Parameters
- conn: ConnIdentifier
- Optional reason: string
Returns Promise<boolean>

dispatch

dispatch(job: WebSocketJob): Promise<ConnIdentifier[]>

- Defined in packages/websocket/src/server.ts:227
Parameters
- job: WebSocketJob
Returns Promise<ConnIdentifier[]>

emit

emit<E>(event: E, ...args: Arguments<ServerEvents<User, Auth>[E]>): boolean

Inherited from Emitter.emit
- Defined in node_modules/typed-emitter/index.d.ts:34
Type parameters
- E: keyof ServerEvents<User, Auth>
Parameters
- event: E
- Rest ...args: Arguments<ServerEvents<User, Auth>[E]>
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from Emitter.eventNames
- Defined in node_modules/typed-emitter/index.d.ts:35
Returns (string | symbol)[]

getMaxListeners

getMaxListeners(): number

Inherited from Emitter.getMaxListeners
- Defined in node_modules/typed-emitter/index.d.ts:40
Returns number

handleUpgrade

handleUpgrade(req: IncomingMessage, ns: Socket, head: Buffer): Promise<void>

- Defined in packages/websocket/src/server.ts:148
Parameters
- req: IncomingMessage
- ns: Socket
- head: Buffer
Returns Promise<void>

listenerCount

listenerCount<E>(event: E): number

Inherited from Emitter.listenerCount
- Defined in node_modules/typed-emitter/index.d.ts:38
Type parameters
- E: keyof ServerEvents<User, Auth>
Parameters
- event: E
Returns number

listeners

listeners<E>(event: E): Function[]

Inherited from Emitter.listeners
- Defined in node_modules/typed-emitter/index.d.ts:37
Type parameters
- E: keyof ServerEvents<User, Auth>
Parameters
- event: E
Returns Function[]

off

off<E>(event: E, listener: ServerEvents<User, Auth>[E]): WebSocketServer<User, Auth>

Inherited from Emitter.off
- Defined in node_modules/typed-emitter/index.d.ts:30
Type parameters
- E: keyof ServerEvents<User, Auth>
Parameters
- event: E
- listener: ServerEvents<User, Auth>[E]
Returns WebSocketServer<User, Auth>

on

on<E>(event: E, listener: ServerEvents<User, Auth>[E]): WebSocketServer<User, Auth>

Inherited from Emitter.on
- Defined in node_modules/typed-emitter/index.d.ts:25
Type parameters
- E: keyof ServerEvents<User, Auth>
Parameters
- event: E
- listener: ServerEvents<User, Auth>[E]
Returns WebSocketServer<User, Auth>

once

once<E>(event: E, listener: ServerEvents<User, Auth>[E]): WebSocketServer<User, Auth>

Inherited from Emitter.once
- Defined in node_modules/typed-emitter/index.d.ts:26
Type parameters
- E: keyof ServerEvents<User, Auth>
Parameters
- event: E
- listener: ServerEvents<User, Auth>[E]
Returns WebSocketServer<User, Auth>

prependListener

prependListener<E>(event: E, listener: ServerEvents<User, Auth>[E]): WebSocketServer<User, Auth>

Inherited from Emitter.prependListener
- Defined in node_modules/typed-emitter/index.d.ts:27
Type parameters
- E: keyof ServerEvents<User, Auth>
Parameters
- event: E
- listener: ServerEvents<User, Auth>[E]
Returns WebSocketServer<User, Auth>

prependOnceListener

prependOnceListener<E>(event: E, listener: ServerEvents<User, Auth>[E]): WebSocketServer<User, Auth>

Inherited from Emitter.prependOnceListener
- Defined in node_modules/typed-emitter/index.d.ts:28
Type parameters
- E: keyof ServerEvents<User, Auth>
Parameters
- event: E
- listener: ServerEvents<User, Auth>[E]
Returns WebSocketServer<User, Auth>

rawListeners

rawListeners<E>(event: E): Function[]

Inherited from Emitter.rawListeners
- Defined in node_modules/typed-emitter/index.d.ts:36
Type parameters
- E: keyof ServerEvents<User, Auth>
Parameters
- event: E
Returns Function[]

removeAllListeners

removeAllListeners<E>(event?: E): WebSocketServer<User, Auth>

Inherited from Emitter.removeAllListeners
- Defined in node_modules/typed-emitter/index.d.ts:31
Type parameters
- E: keyof ServerEvents<User, Auth>
Parameters
- Optional event: E
Returns WebSocketServer<User, Auth>

removeListener

removeListener<E>(event: E, listener: ServerEvents<User, Auth>[E]): WebSocketServer<User, Auth>

Inherited from Emitter.removeListener
- Defined in node_modules/typed-emitter/index.d.ts:32
Type parameters
- E: keyof ServerEvents<User, Auth>
Parameters
- event: E
- listener: ServerEvents<User, Auth>[E]
Returns WebSocketServer<User, Auth>

setMaxListeners

setMaxListeners(maxListeners: number): WebSocketServer<User, Auth>

Inherited from Emitter.setMaxListeners
- Defined in node_modules/typed-emitter/index.d.ts:41
Parameters
- maxListeners: number
Returns WebSocketServer<User, Auth>

start

start(): Promise<void>

- Defined in packages/websocket/src/server.ts:140
Returns Promise<void>

stop

stop(): Promise<void>

- Defined in packages/websocket/src/server.ts:144
Returns Promise<void>

subscribeTopic

subscribeTopic(conn: ConnIdentifier, topic: string): Promise<boolean>

- Defined in packages/websocket/src/server.ts:179
Parameters
- conn: ConnIdentifier
- topic: string
Returns Promise<boolean>

unsubscribeTopic

unsubscribeTopic(conn: ConnIdentifier, topic: string): Promise<boolean>

- Defined in packages/websocket/src/server.ts:201
Parameters
- conn: ConnIdentifier
- topic: string
Returns Promise<boolean>

Generated using TypeDoc