AbstractConnectionProvider

Factor common logic according to ElectronIpcConnectionProvider and WebSocketConnectionProvider. This class handles channels in a somewhat generic way.

Type Parameters

AbstractOptions extends object

Hierarchy

AbstractConnectionProvider
- WebSocketConnectionProvider
- ElectronIpcConnectionProvider

Index

Constructors

constructor

Properties

Accessors

onIncomingMessageActivity

Methods

Constructors

constructor

new AbstractConnectionProvider<AbstractOptions>(): AbstractConnectionProvider<AbstractOptions>

Type Parameters
- AbstractOptions extends object
Returns AbstractConnectionProvider<AbstractOptions>

Properties

Protected Optional channelMultiplexer

channelMultiplexer?: ChannelMultiplexer

Protected Readonly onIncomingMessageActivityEmitter

onIncomingMessageActivityEmitter: Emitter<void> = ...

Protected reconnectChannelOpeners

reconnectChannelOpeners: (() => Promise<void>)[] = []

Accessors

onIncomingMessageActivity

get onIncomingMessageActivity(): Event<void>

- Defined in packages/core/src/common/messaging/abstract-connection-provider.ts:48
Returns Event<void>

Methods

Protected Abstract createMainChannel

createMainChannel(): Channel

- Defined in packages/core/src/common/messaging/abstract-connection-provider.ts:113
Create the main connection that is used for multiplexing all service channels.

Returns Channel

createProxy

createProxy<T>(path: string, factory: JsonRpcProxyFactory<T>): JsonRpcProxy<T>
createProxy<T>(path: string, target?: object): JsonRpcProxy<T>

- Defined in packages/core/src/common/messaging/abstract-connection-provider.ts:56
Create a proxy object to remote interface of T type over a web socket connection for the given path and proxy factory.

Type Parameters
- T extends object
Parameters
- path: string
- factory: JsonRpcProxyFactory<T>
Returns JsonRpcProxy<T>
- Defined in packages/core/src/common/messaging/abstract-connection-provider.ts:64
Create a proxy object to remote interface of T type over a web socket connection for the given path.

An optional target can be provided to handle notifications and requests from a remote side.

Type Parameters
- T extends object
Parameters
- path: string
- Optional target: object
Returns JsonRpcProxy<T>

Protected initializeMultiplexer

initializeMultiplexer(): void

- Defined in packages/core/src/common/messaging/abstract-connection-provider.ts:80
Returns void

listen

listen(handler: ConnectionHandler, options?: AbstractOptions): void

- Defined in packages/core/src/common/messaging/abstract-connection-provider.ts:89
Install a connection handler for the given path.

Parameters
- handler: ConnectionHandler
- Optional options: AbstractOptions
Returns void

openChannel

openChannel(path: string, handler: ((channel: Channel) => void), options?: AbstractOptions): Promise<void>

- Defined in packages/core/src/common/messaging/abstract-connection-provider.ts:95
Parameters
- path: string
- handler: ((channel: Channel) => void)
  - - (channel: Channel): void
    - Parameters
      - channel: Channel
      Returns void
- Optional options: AbstractOptions
Returns Promise<void>

Static createProxy

createProxy<T>(container: Container, path: string, factory: JsonRpcProxyFactory<T>): JsonRpcProxy<T>

- Defined in packages/core/src/common/messaging/abstract-connection-provider.ts:35
Create a proxy object to remote interface of T type over an electron ipc connection for the given path and proxy factory.

An optional target can be provided to handle notifications and requests from a remote side.

Type Parameters
- T extends object
Parameters
- container: Container
- path: string
- factory: JsonRpcProxyFactory<T>
Returns JsonRpcProxy<T>

Type Parameters

AbstractOptions extends object

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

AbstractOptions extends object

Returns AbstractConnectionProvider<AbstractOptions>

Properties

Protected Optional channelMultiplexer

Protected Readonly onIncomingMessageActivityEmitter

Protected reconnectChannelOpeners

Accessors

onIncomingMessageActivity

Returns Event<void>

Methods

Protected Abstract createMainChannel

Returns Channel

createProxy

Type Parameters

T extends object

Parameters

path: string

factory: JsonRpcProxyFactory<T>

Returns JsonRpcProxy<T>

Type Parameters

T extends object

Parameters

path: string

Optional target: object

Returns JsonRpcProxy<T>

Protected initializeMultiplexer

Returns void

listen

Parameters

handler: ConnectionHandler

Optional options: AbstractOptions

Returns void

openChannel

Parameters

path: string

handler: ((channel: Channel) => void)

Parameters

channel: Channel

Returns void

Optional options: AbstractOptions

Returns Promise<void>

Static createProxy

Type Parameters

T extends object

Parameters

container: Container

path: string

factory: JsonRpcProxyFactory<T>

Returns JsonRpcProxy<T>