Class MessagingContribution

Hierarchy

MessagingContribution
- ElectronMessagingContribution

Implements

Index

Constructors

constructor

new MessagingContribution(): MessagingContribution

Returns MessagingContribution

Properties

Protected Readonly channelHandlers

channelHandlers: ConnectionHandlers<WebSocketChannel> = ...

Protected checkAliveTimeout

checkAliveTimeout: number = 30000

Protected Readonly connectionModules

connectionModules: ContributionProvider<ContainerModule>

Protected Readonly container

container: Container

Protected Readonly contributions

contributions: ContributionProvider<Contribution>

Protected Readonly httpWebsocketAdapterFactory

httpWebsocketAdapterFactory: () => HttpWebsocketAdapter

Type declaration

- (): HttpWebsocketAdapter
- Returns HttpWebsocketAdapter

Protected Readonly httpWebsocketAdapters

httpWebsocketAdapters: Map<string, HttpWebsocketAdapter> = ...

Protected Readonly messagingListener

messagingListener: MessagingListener

Protected webSocketServer

webSocketServer: undefined | Server

Protected Readonly wsHandlers

wsHandlers: ConnectionHandlers<HttpWebsocketAdapter | WebSocket> = ...

Protected Readonly wsRequestValidator

wsRequestValidator: WsRequestValidator

Methods

configure

configure(app: Application): void

Implementation of BackendApplicationContribution.configure
- Defined in packages/core/src/node/messaging/messaging-contribution.ts:136
Parameters
- app: Application
Returns void

Protected createChannel

createChannel(id: number, socket: WebSocket): WebSocketChannel

- Defined in packages/core/src/node/messaging/messaging-contribution.ts:262
Parameters
- id: number
- socket: WebSocket
Returns WebSocketChannel

Protected createSocketContainer

createSocketContainer(socket: WebSocket): Container

- Defined in packages/core/src/node/messaging/messaging-contribution.ts:241
Parameters
- socket: WebSocket
Returns Container

forward

forward(spec: string, callback: (params: PathParams, connection: IConnection) => void): void

Implementation of MessagingService.forward
- Defined in packages/core/src/node/messaging/messaging-contribution.ts:83
Accept a raw JSON-RPC connection on the given path. A path supports the route syntax: https://github.com/rcs/route-parser#what-can-i-use-in-my-routes.

Parameters
- spec: string
- callback: (params: PathParams, connection: IConnection) => void
  - - (params: PathParams, connection: IConnection): void
    - Parameters
      - params: PathParams
      - connection: IConnection
      Returns void
Returns void

Protected getConnectionChannelHandlers

getConnectionChannelHandlers(socket: WebSocket): ConnectionHandlers<WebSocketChannel>

- Defined in packages/core/src/node/messaging/messaging-contribution.ts:247
Parameters
- socket: WebSocket
Returns ConnectionHandlers<WebSocketChannel>

Protected handleChannels

handleChannels(socket: WebSocket): void

- Defined in packages/core/src/node/messaging/messaging-contribution.ts:195
Parameters
- socket: WebSocket
Returns void

Protected handleConnection

handleConnection(socket: HttpWebsocketAdapter | WebSocket, request: IncomingMessage): void

- Defined in packages/core/src/node/messaging/messaging-contribution.ts:188
Parameters
- socket: HttpWebsocketAdapter | WebSocket
- request: IncomingMessage
Returns void

Protected handleHttpUpgrade

handleHttpUpgrade(request: IncomingMessage, socket: Socket, head: Buffer): void

- Defined in packages/core/src/node/messaging/messaging-contribution.ts:169
Route HTTP upgrade requests to the WebSocket server.

Parameters
- request: IncomingMessage
- socket: Socket
- head: Buffer
Returns void

Protected init

init(): void

- Defined in packages/core/src/node/messaging/messaging-contribution.ts:69
Returns void

listen

listen(spec: string, callback: (params: PathParams, connection: MessageConnection) => void): void

Implementation of MessagingService.listen
- Defined in packages/core/src/node/messaging/messaging-contribution.ts:76
Accept a JSON-RPC connection on the given path. A path supports the route syntax: https://github.com/rcs/route-parser#what-can-i-use-in-my-routes.

Parameters
- spec: string
- callback: (params: PathParams, connection: MessageConnection) => void
  - - (params: PathParams, connection: MessageConnection): void
    - Parameters
      - params: PathParams
      - connection: MessageConnection
      Returns void
Returns void

onStart

onStart(server: Server | Server): void

Implementation of BackendApplicationContribution.onStart
- Defined in packages/core/src/node/messaging/messaging-contribution.ts:99
Parameters
- server: Server | Server
Returns void

ws

ws(spec: string, callback: (params: PathParams, socket: WebSocket) => void): void

Implementation of MessagingService.ws
- Defined in packages/core/src/node/messaging/messaging-contribution.ts:94
Accept a web socket connection on the given path. A path supports the route syntax: https://github.com/rcs/route-parser#what-can-i-use-in-my-routes.

Important

Prefer JSON-RPC connections or web socket channels over web sockets. Clients can handle only limited amount of web sockets and excessive amount can cause performance degradation. All JSON-RPC connections and web socket channels share the single web socket connection.

Parameters
- spec: string
- callback: (params: PathParams, socket: WebSocket) => void
  - - (params: PathParams, socket: WebSocket): void
    - Parameters
      - params: PathParams
      - socket: WebSocket
      Returns void
Returns void

wsChannel

wsChannel(spec: string, callback: (params: PathParams, channel: WebSocketChannel) => void): void

Implementation of MessagingService.wsChannel
- Defined in packages/core/src/node/messaging/messaging-contribution.ts:90
Accept a web socket channel on the given path. A path supports the route syntax: https://github.com/rcs/route-parser#what-can-i-use-in-my-routes.

Parameters
- spec: string
- callback: (params: PathParams, channel: WebSocketChannel) => void
  - - (params: PathParams, channel: WebSocketChannel): void
    - Parameters
      - params: PathParams
      - channel: WebSocketChannel
      Returns void
Returns void