MessagingService | Theia TypeDoc

Hierarchy

MessagingService

Implemented by

MessagingContribution

Index

Methods

forward

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

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

listen

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

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

ws

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

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

wsChannel

wsChannel(path: string, callback: (params: PathParams, socket: WebSocketChannel) => void): void

- Defined in packages/core/src/node/messaging/messaging-service.ts:37
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: PathParams, socket: WebSocketChannel) => void
  - - (params: PathParams, socket: WebSocketChannel): void
    - Parameters
      - params: PathParams
      - socket: WebSocketChannel
      Returns void
Returns void

Hierarchy

Implemented by

Index

Methods

Methods

forward

Parameters

path: string

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

Parameters

params: PathParams

connection: IConnection

Returns void

Returns void

listen

Parameters

path: string

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

Parameters

params: PathParams

connection: MessageConnection

Returns void

Returns void

ws

Important

Parameters

path: string

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

Parameters

params: PathParams

socket: WebSocket

Returns void

Returns void

wsChannel

Parameters

path: string

callback: (params: PathParams, socket: WebSocketChannel) => void

Parameters

params: PathParams

socket: WebSocketChannel

Returns void

Returns void