Interface MessagingService

Hierarchy

MessagingService

Implemented by

MessagingContribution

Index

Methods

Methods

ws

ws(path: string, callback: ((params: MessagingService.PathParams, socket: Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>) => void)): void

- Defined in packages/core/src/node/messaging/messaging-service.ts:34
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 using web socket channels over establishing new web socket connection. Clients can handle only limited amount of web sockets and excessive amount can cause performance degradation. All web socket channels share a single web socket connection.

Parameters
- path: string
- callback: ((params: MessagingService.PathParams, socket: Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>) => void)
  - - (params: MessagingService.PathParams, socket: Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>): void
    - Parameters
      - params: MessagingService.PathParams
      - socket: Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>
      Returns void
Returns void

wsChannel

wsChannel(path: string, callback: ((params: MessagingService.PathParams, channel: Channel) => void)): void

- Defined in packages/core/src/node/messaging/messaging-service.ts:25
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
- path: string
- callback: ((params: MessagingService.PathParams, channel: Channel) => void)
  - - (params: MessagingService.PathParams, channel: Channel): void
    - Parameters
      - params: MessagingService.PathParams
      - channel: Channel
      Returns void
Returns void