Class ElectronWebSocketConnectionSource

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 (View Summary)

WebSocketConnectionSource
- ElectronWebSocketConnectionSource

Implements

FrontendApplicationContribution

Constructors

constructor

new ElectronWebSocketConnectionSource(): ElectronWebSocketConnectionSource
Returns ElectronWebSocketConnectionSource
Overrides WebSocketConnectionSource.constructor
- Defined in packages/core/src/electron-browser/messaging/electron-ws-connection-source.ts:28

Properties

`Protected`currentChannel

currentChannel: AbstractChannel

`Protected` `Readonly`frontendIdProvider

frontendIdProvider: FrontendIdProvider

`Protected` `Readonly`onConnectionDidOpenEmitter

onConnectionDidOpenEmitter: Emitter<Channel> = ...

`Protected` `Readonly`onIncomingMessageActivityEmitter

onIncomingMessageActivityEmitter: Emitter<void> = ...

`Protected` `Readonly`onSocketDidCloseEmitter

onSocketDidCloseEmitter: Emitter<void> = ...

`Protected` `Readonly`onSocketDidOpenEmitter

onSocketDidOpenEmitter: Emitter<void> = ...

`Static` `Readonly`NO_CONNECTION

NO_CONNECTION: "<none>" = '<none>'

Accessors

onConnectionDidOpen

get onConnectionDidOpen(): Event<Channel>
Returns Event<Channel>
Inherited from WebSocketConnectionSource.onConnectionDidOpen
- Defined in packages/core/src/browser/messaging/ws-connection-source.ts:46

onIncomingMessageActivity

get onIncomingMessageActivity(): Event<void>
Returns Event<void>
Inherited from WebSocketConnectionSource.onIncomingMessageActivity
- Defined in packages/core/src/browser/messaging/ws-connection-source.ts:61

onSocketDidClose

get onSocketDidClose(): Event<void>
Returns Event<void>
Inherited from WebSocketConnectionSource.onSocketDidClose
- Defined in packages/core/src/browser/messaging/ws-connection-source.ts:56

onSocketDidOpen

get onSocketDidOpen(): Event<void>
Returns Event<void>
Inherited from WebSocketConnectionSource.onSocketDidOpen
- Defined in packages/core/src/browser/messaging/ws-connection-source.ts:51

socket

get socket(): Socket
Returns Socket
Inherited from WebSocketConnectionSource.socket
- Defined in packages/core/src/browser/messaging/ws-connection-source.ts:39

Methods

`Protected`createHttpWebSocketUrl

createHttpWebSocketUrl(path: string): string
Parameters
- path: string
Returns string
Inherited from WebSocketConnectionSource.createHttpWebSocketUrl
- Defined in packages/core/src/browser/messaging/ws-connection-source.ts:191

`Protected`createSocketIoPath

createSocketIoPath(url: string): undefined | string
Path for Socket.io to make its requests to.
Parameters
- url: string
Returns undefined | string
Inherited from WebSocketConnectionSource.createSocketIoPath
- Defined in packages/core/src/browser/messaging/ws-connection-source.ts:220

`Protected`createWebSocket

createWebSocket(url: string): Socket
Creates a web socket for the given url
Parameters
- url: string
Returns Socket
Inherited from WebSocketConnectionSource.createWebSocket
- Defined in packages/core/src/browser/messaging/ws-connection-source.ts:202

`Protected`createWebSocketUrl

createWebSocketUrl(path: string): string
Parameters
- path: string
  The handler to reach in the backend.
Returns string
Inherited from WebSocketConnectionSource.createWebSocketUrl
- Defined in packages/core/src/browser/messaging/ws-connection-source.ts:185

`Protected`handleSocketConnected

handleSocketConnected(): void
Returns void
Inherited from WebSocketConnectionSource.handleSocketConnected
- Defined in packages/core/src/browser/messaging/ws-connection-source.ts:128

`Protected`negogiateReconnect

negogiateReconnect(): void
Returns void
Inherited from WebSocketConnectionSource.negogiateReconnect
- Defined in packages/core/src/browser/messaging/ws-connection-source.ts:90

`Protected`negotiateInitialConnect

negotiateInitialConnect(): void
Returns void
Inherited from WebSocketConnectionSource.negotiateInitialConnect
- Defined in packages/core/src/browser/messaging/ws-connection-source.ts:115

onStop

onStop(): void
Called when an application is stopped or unloaded.

Note that this is implemented using window.beforeunload which doesn't allow any asynchronous code anymore. I.e. this is the last tick.

Returns void
Implementation of FrontendApplicationContribution.onStop
- Defined in packages/core/src/electron-browser/messaging/electron-ws-connection-source.ts:32

openSocket

openSocket(): void
Returns void
Inherited from WebSocketConnectionSource.openSocket
- Defined in packages/core/src/browser/messaging/ws-connection-source.ts:69

Class ElectronWebSocketConnectionSource

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns ElectronWebSocketConnectionSource

Properties

ProtectedcurrentChannel

Protected ReadonlyfrontendIdProvider

Protected ReadonlyonConnectionDidOpenEmitter

Protected ReadonlyonIncomingMessageActivityEmitter

Protected ReadonlyonSocketDidCloseEmitter

Protected ReadonlyonSocketDidOpenEmitter

Static ReadonlyNO_CONNECTION

Accessors

onConnectionDidOpen

Returns Event<Channel>

onIncomingMessageActivity

Returns Event<void>

onSocketDidClose

Returns Event<void>

onSocketDidOpen

Returns Event<void>

socket

Returns Socket

Methods

connectNewChannel

Returns void

ProtectedcreateChannel

Returns AbstractChannel

ProtectedcreateEndpoint

Parameters

Returns Endpoint

ProtectedcreateHttpWebSocketUrl

Parameters

Returns string

ProtectedcreateSocketIoPath

Parameters

Returns undefined | string

ProtectedcreateWebSocket

Parameters

Returns Socket

ProtectedcreateWebSocketUrl

Parameters

Returns string

ProtectedhandleSocketConnected

Returns void

ProtectednegogiateReconnect

Returns void

ProtectednegotiateInitialConnect

Returns void

onStop

Returns void

openSocket

Returns void

Settings

On This Page

`Protected`currentChannel

`Protected` `Readonly`frontendIdProvider

`Protected` `Readonly`onConnectionDidOpenEmitter

`Protected` `Readonly`onIncomingMessageActivityEmitter

`Protected` `Readonly`onSocketDidCloseEmitter

`Protected` `Readonly`onSocketDidOpenEmitter

`Static` `Readonly`NO_CONNECTION

`Protected`createChannel

`Protected`createEndpoint

`Protected`createHttpWebSocketUrl

`Protected`createSocketIoPath

`Protected`createWebSocket

`Protected`createWebSocketUrl

`Protected`handleSocketConnected

`Protected`negogiateReconnect

`Protected`negotiateInitialConnect