Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ElectronWebSocketConnectionProvider

Customized connection provider between the frontend and the backend in electron environment. This customized connection provider makes sure the websocket connection does not try to reconnect once the electron-browser window is refreshed. Otherwise, backend resources are not disposed.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Protected channelIdSeq

channelIdSeq: number = 0

Protected Readonly channels

channels: Map<number, WebSocketChannel> = ...

Protected httpFallbackDisconnected

httpFallbackDisconnected: boolean = true

Protected httpFallbackId

httpFallbackId: string = ...

Protected Readonly httpFallbackOptions

httpFallbackOptions: undefined | HttpFallbackOptions

Protected Readonly messageService

messageService: () => MessageService

Type declaration

Readonly onHttpFallbackDidActivate

onHttpFallbackDidActivate: Event<void> = ...

Protected Readonly onHttpFallbackDidActivateEmitter

onHttpFallbackDidActivateEmitter: Emitter<void> = ...

onIncomingMessageActivity

onIncomingMessageActivity: Event<void> = ...

Protected Readonly onIncomingMessageActivityEmitter

onIncomingMessageActivityEmitter: Emitter<void> = ...

Readonly onSocketDidClose

onSocketDidClose: Event<void> = ...

Protected Readonly onSocketDidCloseEmitter

onSocketDidCloseEmitter: Emitter<void> = ...

Readonly onSocketDidOpen

onSocketDidOpen: Event<void> = ...

Protected Readonly onSocketDidOpenEmitter

onSocketDidOpenEmitter: Emitter<void> = ...

Protected Readonly socket

socket: default

Protected stopping

stopping: boolean = false

Do not try to reconnect when the frontend application is stopping. The browser is navigating away from this page.

Protected useHttpFallback

useHttpFallback: boolean = false

Protected websocketErrorCounter

websocketErrorCounter: number = 0

Methods

Protected createChannel

Protected createHttpWebSocketUrl

  • createHttpWebSocketUrl(path: string): string

Protected createLogger

  • createLogger(): Logger

createProxy

Protected createWebSocket

  • createWebSocket(url: string): default

Protected createWebSocketUrl

  • createWebSocketUrl(path: string): string

doLongPolling

  • doLongPolling(url: string): Promise<void>

Protected fireSocketDidClose

  • fireSocketDidClose(): void

Protected fireSocketDidOpen

  • fireSocketDidOpen(): void

Protected handleIncomingRawMessage

  • handleIncomingRawMessage(data: string): void

handleSocketError

  • handleSocketError(event: unknown): void

listen

onStop

  • onStop(): void

openChannel

Protected tryReconnect

  • tryReconnect(): void

Static createProxy

  • createProxy<T>(container: Container, path: string, arg?: object): JsonRpcProxy<T>