Class SocketDriver

constructor

• new SocketDriver(options?: SocketDriverOptions): SocketDriver

  Parameters

  • options: SocketDriverOptions = {}

  Returns SocketDriver

ReadonlymaxPayloadLength

name

port

• get port(): number

  The port the server listens on once started (the one the OS picked for port: 0); before start, the configured port.

  Returns number

broadcast

• broadcast(event: string, payload: unknown): void

  Publish to all sockets subscribed to the global topic.

  Parameters

  • event: string
  • payload: unknown

  Returns void

broadcastTo

• broadcastTo(room: string, event: string, payload: unknown): void

  Publish to all sockets subscribed to a specific room.

  Parameters

  • room: string
  • event: string
  • payload: unknown

  Returns void

close

• close(connectionId: string, code?: number, reason?: string): boolean

  Closes the connection connectionId (as in socket:connected and a handler's ctx.socket.data); false when it is not open. For an app that authenticates in a message rather than at the handshake: a connection that never does stays open as long as its client answers pings, so close the ones that have not authenticated in time.

  Parameters

  • connectionId: string
  • code: number = 1000
  • reason: string = ''

  Returns boolean

init

• init(app: App): void

  Parameters

  • app: App

  Returns void

start

• start(): void

  Returns void

stop

• stop(): Promise<void>

  Closes every open connection (1001 "going away", so clients see a clean close and can reconnect elsewhere) and the listener. A plain server.stop() only stopped accepting: connected clients kept being served after app.stop(), by handlers whose DB and other drivers were already stopped.

  Returns Promise<void>