MessagingContribution | Theia TypeDoc

Hierarchy

MessagingContribution
- ElectronMessagingContribution

Implements

Constructors

constructor

new MessagingContribution(): MessagingContribution

Returns MessagingContribution

Properties

Protected Readonly channelHandlers

channelHandlers: ConnectionHandlers<Channel> = ...

Protected checkAliveTimeout

checkAliveTimeout: number = 30000

Protected Readonly connectionModules

connectionModules: ContributionProvider<ContainerModule>

Protected Readonly container

container: Container

Protected Readonly contributions

contributions: ContributionProvider<MessagingService.Contribution>

Protected maxHttpBufferSize

maxHttpBufferSize: number = 1e8

Protected Readonly messagingListener

messagingListener: MessagingListener

Protected Readonly wsHandlers

wsHandlers: ConnectionHandlers<Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>> = ...

Protected Readonly wsRequestValidator

wsRequestValidator: WsRequestValidator

Methods

Protected allowConnect

allowConnect(request: IncomingMessage): Promise<boolean>

- Defined in packages/core/src/node/messaging/messaging-contribution.ts:101
Parameters
- request: IncomingMessage
Returns Promise<boolean>

Protected createSocketContainer

createSocketContainer(socket: Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>): Container

- Defined in packages/core/src/node/messaging/messaging-contribution.ts:137
Parameters
- socket: Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>
Returns Container

Protected getConnectionChannelHandlers

getConnectionChannelHandlers(socket: Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>): ConnectionHandlers<Channel>

- Defined in packages/core/src/node/messaging/messaging-contribution.ts:143
Parameters
- socket: Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>
Returns ConnectionHandlers<Channel>

Protected handleChannels

handleChannels(socket: Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>): void

- Defined in packages/core/src/node/messaging/messaging-contribution.ts:109
Parameters
- socket: Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>
Returns void

Protected handleConnection

handleConnection(socket: Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>): void

- Defined in packages/core/src/node/messaging/messaging-contribution.ts:94
Parameters
- socket: Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>
Returns void

Protected init

init(): void

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

onStart

onStart(server: Server<typeof IncomingMessage, typeof ServerResponse> | Server<typeof IncomingMessage, typeof ServerResponse>): void

Implementation of BackendApplicationContribution.onStart
- Defined in packages/core/src/node/messaging/messaging-contribution.ts:73
Parameters
- server: Server<typeof IncomingMessage, typeof ServerResponse> | Server<typeof IncomingMessage, typeof ServerResponse>
Returns void

Protected toIWebSocket

toIWebSocket(socket: Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>): IWebSocket

- Defined in packages/core/src/node/messaging/messaging-contribution.ts:121
Parameters
- socket: Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>
Returns IWebSocket

ws

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

Implementation of MessagingService.ws
- Defined in packages/core/src/node/messaging/messaging-contribution.ts:66
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
- spec: 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(spec: string, callback: ((params: MessagingService.PathParams, channel: Channel) => void)): void

Implementation of MessagingService.wsChannel
- Defined in packages/core/src/node/messaging/messaging-contribution.ts:62
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: MessagingService.PathParams, channel: Channel) => void)
  - - (params: MessagingService.PathParams, channel: Channel): void
    - Parameters
      - params: MessagingService.PathParams
      - channel: Channel
      Returns void
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns MessagingContribution

Properties

Protected Readonly channelHandlers

Protected checkAliveTimeout

Protected Readonly connectionModules

Protected Readonly container

Protected Readonly contributions

Protected maxHttpBufferSize

Protected Readonly messagingListener

Protected Readonly wsHandlers

Protected Readonly wsRequestValidator

Methods

Protected allowConnect

Parameters

request: IncomingMessage

Returns Promise<boolean>

Protected createSocketContainer

Parameters

socket: Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>

Returns Container

Protected getConnectionChannelHandlers

Parameters

socket: Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>

Returns ConnectionHandlers<Channel>

Protected handleChannels

Parameters

socket: Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>

Returns void

Protected handleConnection

Parameters

socket: Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>

Returns void

Protected init

Returns void

onStart

Parameters

server: Server<typeof IncomingMessage, typeof ServerResponse> | Server<typeof IncomingMessage, typeof ServerResponse>

Returns void

Protected toIWebSocket

Parameters

socket: Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>

Returns IWebSocket

ws

Important

Parameters

spec: string

callback: ((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

Parameters

spec: string

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

Parameters

params: MessagingService.PathParams

channel: Channel

Returns void

Returns void