Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ElectronMessagingContribution

Override the browser MessagingContribution class to refuse connections that do not include a specific token.

deprecated

since 1.8.0

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

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

Protected Readonly httpWebsocketAdapters

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

Protected Readonly messagingListener

messagingListener: MessagingListener

Protected Readonly tokenValidator

tokenValidator: ElectronTokenValidator

Protected webSocketServer

webSocketServer: undefined | Server

Protected Readonly wsHandlers

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

Protected Readonly wsRequestValidator

wsRequestValidator: WsRequestValidator

Methods

configure

  • configure(app: Application): void

Protected createChannel

Protected createSocketContainer

  • createSocketContainer(socket: WebSocket): Container

forward

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

Protected getConnectionChannelHandlers

Protected handleChannels

  • handleChannels(socket: WebSocket): void

Protected handleConnection

Protected handleHttpUpgrade

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

Protected init

  • init(): void

listen

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

onStart

  • onStart(server: Server | Server): void

ws

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

wsChannel