Class WebSocketConnectionSource

A ConnectionSource creates a Channel. The channel is valid until it sends a close event.

Hierarchy (view full)

WebSocketConnectionSource
- ElectronLocalWebSocketConnectionSource
- ElectronWebSocketConnectionSource

Implements

ConnectionSource

Constructors

constructor

new WebSocketConnectionSource(): WebSocketConnectionSource
Returns WebSocketConnectionSource
- Defined in packages/core/src/browser/messaging/ws-connection-source.ts:65

Properties

`Private` _socket

_socket: Socket<DefaultEventsMap, DefaultEventsMap>

`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> = ...

`Private` `Readonly` writeBuffer

writeBuffer: SocketWriteBuffer = ...

`Static` `Readonly` NO_CONNECTION

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

Accessors

onConnectionDidOpen

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

onIncomingMessageActivity

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

onSocketDidClose

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

onSocketDidOpen

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

socket

get socket(): Socket<DefaultEventsMap, DefaultEventsMap>
Returns Socket<DefaultEventsMap, DefaultEventsMap>
- Defined in packages/core/src/browser/messaging/ws-connection-source.ts:39

Methods

connectNewChannel

connectNewChannel(): void
Returns void
- Defined in packages/core/src/browser/messaging/ws-connection-source.ts:136

`Protected` createChannel

createChannel(): AbstractChannel
Returns AbstractChannel
- Defined in packages/core/src/browser/messaging/ws-connection-source.ts:146

`Protected` createEndpoint

createEndpoint(path): Endpoint
Parameters
- path: string
Returns Endpoint
- Defined in packages/core/src/browser/messaging/ws-connection-source.ts:195

`Protected` createHttpWebSocketUrl

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

`Protected` createSocketIoPath

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

`Protected` createWebSocket

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

`Protected` createWebSocketUrl

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

`Protected` handleSocketConnected

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

`Protected` negogiateReconnect

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

`Protected` negotiateInitialConnect

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

openSocket

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