Class WebSocketsController

Hierarchy

WebSocketsController

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WebSocketsController(socketServerProvider: SocketServerProvider, config: ApplicationConfig, contextCreator: WsContextCreator): WebSocketsController

- Defined in packages/websockets/web-sockets-controller.ts:23
Parameters
- socketServerProvider: SocketServerProvider
- config: ApplicationConfig
- contextCreator: WsContextCreator
Returns WebSocketsController

Properties

Private Readonly config

config: ApplicationConfig

Private Readonly contextCreator

contextCreator: WsContextCreator

Private Readonly metadataExplorer

metadataExplorer: GatewayMetadataExplorer = new GatewayMetadataExplorer(new MetadataScanner(),)

Private Readonly socketServerProvider

socketServerProvider: SocketServerProvider

Methods

Private assignServerToProperties

assignServerToProperties<T>(instance: NestGateway, server: object): void

- Defined in packages/websockets/web-sockets-controller.ts:165
Type parameters
- T = any
Parameters
- instance: NestGateway
- server: object
Returns void

getConnectionHandler

getConnectionHandler(context: WebSocketsController, instance: NestGateway, subscribersMap: MessageMappingProperties[], disconnect: Subject<any>, connection: Subject<any>): (Anonymous function)

- Defined in packages/websockets/web-sockets-controller.ts:94
Parameters
- context: WebSocketsController
- instance: NestGateway
- subscribersMap: MessageMappingProperties[]
- disconnect: Subject<any>
- connection: Subject<any>
Returns (Anonymous function)

mergeGatewayAndServer

mergeGatewayAndServer(instance: NestGateway, metatype: Type<unknown> | Function, moduleKey: string): void

- Defined in packages/websockets/web-sockets-controller.ts:31
Parameters
- instance: NestGateway
- metatype: Type<unknown> | Function
- moduleKey: string
Returns void

pickResult

pickResult(defferedResult: Promise<any>): Promise<Observable<any>>

- Defined in packages/websockets/web-sockets-controller.ts:152
Parameters
- defferedResult: Promise<any>
Returns Promise<Observable<any>>

subscribeConnectionEvent

subscribeConnectionEvent(instance: NestGateway, event: Subject<any>): void

- Defined in packages/websockets/web-sockets-controller.ts:119
Parameters
- instance: NestGateway
- event: Subject<any>
Returns void

subscribeDisconnectEvent

subscribeDisconnectEvent(instance: NestGateway, event: Subject<any>): void

- Defined in packages/websockets/web-sockets-controller.ts:129
Parameters
- instance: NestGateway
- event: Subject<any>
Returns void

subscribeEvents

subscribeEvents(instance: NestGateway, subscribersMap: MessageMappingProperties[], observableServer: SocketEventsHost): void

- Defined in packages/websockets/web-sockets-controller.ts:72
Parameters
- instance: NestGateway
- subscribersMap: MessageMappingProperties[]
- observableServer: SocketEventsHost
Returns void

subscribeInitEvent

subscribeInitEvent(instance: NestGateway, event: Subject<any>): void

- Defined in packages/websockets/web-sockets-controller.ts:113
Parameters
- instance: NestGateway
- event: Subject<any>
Returns void

subscribeMessages

subscribeMessages<T>(subscribersMap: MessageMappingProperties[], client: T, instance: NestGateway): void

- Defined in packages/websockets/web-sockets-controller.ts:137
Type parameters
- T = any
Parameters
- subscribersMap: MessageMappingProperties[]
- client: T
- instance: NestGateway
Returns void

subscribeToServerEvents

subscribeToServerEvents<T>(instance: NestGateway, options: T, port: number, moduleKey: string): void

- Defined in packages/websockets/web-sockets-controller.ts:45
Type parameters
- T: GatewayMetadata
Parameters
- instance: NestGateway
- options: T
- port: number
- moduleKey: string
Returns void

Generated using TypeDoc