Class WebsocketService

Default implementation for handling websockets. Uses socket.io under the hood.

Implements

WebsocketServiceInterface<SocketIOWebsocketConnection>

Index

Constructors

Methods

attachTo disconnect findConnectionById findConnectionByUserId getConnections joinChannel leaveChannel registerController send sendToAll sendToChannel

Constructors

constructor

new WebsocketService(
 logger: LoggerInterface,
 authService: AuthServiceInterface,
 parser: ParserInterface,
 validationService: ValidationServiceInterface,
 channelRepository: Repository<WebsocketChannel>,
 messageRepository: Repository<WebsocketMessage, CreateWebsocketMessageData>,
 options: WebsocketOptions,
): WebsocketService
Parameters
- logger: LoggerInterface
- authService: AuthServiceInterface
- parser: ParserInterface
- validationService: ValidationServiceInterface
- channelRepository: Repository<WebsocketChannel>
- messageRepository: Repository<WebsocketMessage, CreateWebsocketMessageData>
- options: WebsocketOptions
Returns WebsocketService
- Defined in src/websocket/services/websocket.service.ts:58

Methods

attachTo

attachTo(app: ZibriApplication): Promise<void>
Attaches the service to the application.
Parameters
- app: ZibriApplication
Returns Promise<void>
Implementation of WebsocketServiceInterface.attachTo
- Defined in src/websocket/services/websocket.service.ts:76

disconnect

disconnect(connection: SocketIOWebsocketConnection, close?: boolean): void
Disconnects the given connection.
Parameters
- connection: SocketIOWebsocketConnection
- close: boolean = true
Returns void
Implementation of WebsocketServiceInterface.disconnect
- Defined in src/websocket/services/websocket.service.ts:471

findConnectionById

findConnectionById(id: string): SocketIOWebsocketConnection
Finds the websocket connection with the given id.
Parameters
- id: string
Returns SocketIOWebsocketConnection
Implementation of WebsocketServiceInterface.findConnectionById
- Defined in src/websocket/services/websocket.service.ts:514

findConnectionByUserId

findConnectionByUserId(userId: string): SocketIOWebsocketConnection
Finds the websocket connection with the given user id.
Parameters
- userId: string
Returns SocketIOWebsocketConnection
Implementation of WebsocketServiceInterface.findConnectionByUserId
- Defined in src/websocket/services/websocket.service.ts:523

getConnections

getConnections(): SocketIOWebsocketConnection[]
Gets all currently active connections.

Returns SocketIOWebsocketConnection[]
Implementation of WebsocketServiceInterface.getConnections
- Defined in src/websocket/services/websocket.service.ts:509

joinChannel

joinChannel(
connection: SocketIOWebsocketConnection,
channelId: string,
): Promise<void>
Adds the given connection to the channel with the given id.
Parameters
- connection: SocketIOWebsocketConnection
- channelId: string
Returns Promise<void>
Implementation of WebsocketServiceInterface.joinChannel
- Defined in src/websocket/services/websocket.service.ts:476

leaveChannel

leaveChannel(
connection: SocketIOWebsocketConnection,
channelId: string,
): Promise<void>
Removes the given connection from the channel with the given id.
Parameters
- connection: SocketIOWebsocketConnection
- channelId: string
Returns Promise<void>
Implementation of WebsocketServiceInterface.leaveChannel
- Defined in src/websocket/services/websocket.service.ts:493

registerController

registerController(controllerClass: Newable<unknown>): Promise<void>
Registers a websocket controller that listens to events.
Parameters
- controllerClass: Newable<unknown>
Returns Promise<void>
Implementation of WebsocketServiceInterface.registerController
- Defined in src/websocket/services/websocket.service.ts:273

send

send(
 data: WebsocketSendData<SocketIOWebsocketConnection, B>,
): Promise,
>
Sends a message to a single connection.
Type Parameters
- B extends boolean = true
Parameters
- data: WebsocketSendData<SocketIOWebsocketConnection, B>
Returns Promise,
>
Implementation of WebsocketServiceInterface.send
- Defined in src/websocket/services/websocket.service.ts:299

sendToAll

sendToAll(
 data: WebsocketSendToAllData,
 expectResponse?: B,
): Promise[],
>
Sends a message to all connections.
Type Parameters
- B extends boolean
Parameters
- data: WebsocketSendToAllData
- expectResponse: B = ...
Returns Promise[],
>
Implementation of WebsocketServiceInterface.sendToAll
- Defined in src/websocket/services/websocket.service.ts:408

sendToChannel

sendToChannel(
 data: WebsocketSendToChannelData,
): Promise[],
>
Sends a message to a single channel.
Type Parameters
- B extends boolean
Parameters
- data: WebsocketSendToChannelData
Returns Promise[],
>
Implementation of WebsocketServiceInterface.sendToChannel
- Defined in src/websocket/services/websocket.service.ts:342

Class WebsocketService

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns WebsocketService

Methods

attachTo

Parameters

Returns Promise<void>

disconnect

Parameters

Returns void

findConnectionById

Parameters

Returns SocketIOWebsocketConnection

findConnectionByUserId

Parameters

Returns SocketIOWebsocketConnection

getConnections

Returns SocketIOWebsocketConnection[]

joinChannel

Parameters

Returns Promise<void>

leaveChannel

Parameters

Returns Promise<void>

registerController

Parameters

Returns Promise<void>

send

Type Parameters

Parameters

Returns Promise< B extends false ? void : WebsocketRequestWithConnection<SocketIOWebsocketConnection>,>

sendToAll

Type Parameters

Parameters

Returns Promise< B extends false ? void : WebsocketRequestWithConnection<SocketIOWebsocketConnection>[],>

sendToChannel

Type Parameters

Parameters

Returns Promise< B extends false ? void : WebsocketRequestWithConnection<SocketIOWebsocketConnection>[],>

Settings

On This Page

Returns Promise<
B extends false
? void
: WebsocketRequestWithConnection<SocketIOWebsocketConnection>,
>

Returns Promise<
B extends false
? void
: WebsocketRequestWithConnection<SocketIOWebsocketConnection>[],
>

Returns Promise<
B extends false
? void
: WebsocketRequestWithConnection<SocketIOWebsocketConnection>[],
>