Interface MessagingService

interface MessagingService {
    registerChannelHandler(
        path: string,
        handler: (params: MessagingService.PathParams, channel: Channel) => void,
    ): void;
    registerConnectionHandler(
        path: string,
        callback: (
            params: MessagingService.PathParams,
            mainChannel: Channel,
        ) => void,
    ): void;
}

Implemented by

DefaultMessagingService

Index

Methods

registerChannelHandler registerConnectionHandler

Methods

registerChannelHandler

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

registerConnectionHandler

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