Interface WebSocketAdapter<TServer, TClient, TOptions>

Type parameters

TServer = any
TClient = any
TOptions = any

Hierarchy

WebSocketAdapter

Index

Methods

Methods

bindClientConnect

bindClientConnect(server: TServer, callback: Function): any

- Defined in packages/common/interfaces/websockets/web-socket-adapter.interface.ts:14
Parameters
- server: TServer
- callback: Function
Returns any

Optional bindClientDisconnect

bindClientDisconnect(client: TClient, callback: Function): any

- Defined in packages/common/interfaces/websockets/web-socket-adapter.interface.ts:15
Parameters
- client: TClient
- callback: Function
Returns any

bindMessageHandlers

bindMessageHandlers(client: TClient, handlers: WsMessageHandler[], transform: (data: any) => Observable<any>): any

- Defined in packages/common/interfaces/websockets/web-socket-adapter.interface.ts:16
Parameters
- client: TClient
- handlers: WsMessageHandler[]
- transform: (data: any) => Observable<any>
  - - (data: any): Observable<any>
    - Parameters
      - data: any
      Returns Observable<any>
Returns any

close

close(server: TServer): any

- Defined in packages/common/interfaces/websockets/web-socket-adapter.interface.ts:21
Parameters
- server: TServer
Returns any

create

create(port: number, options?: TOptions): TServer

- Defined in packages/common/interfaces/websockets/web-socket-adapter.interface.ts:13
Parameters
- port: number
- Optional options: TOptions
Returns TServer

Generated using TypeDoc