Class ConnectionExtImpl

Implementation of connection system of the plugin API. It allows to communicate with main side to send and read messages.

Hierarchy

ConnectionExtImpl

Implements

ConnectionExt

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ConnectionExtImpl(rpc: RPCProtocol): ConnectionExtImpl

- Defined in packages/plugin-ext/src/plugin/connection-ext.ts:29
Parameters
- rpc: RPCProtocol
Returns ConnectionExtImpl

Properties

Private connections

connections: Map<string, PluginConnection> = ...

Private proxy

proxy: ConnectionMain

Methods

$createConnection

$createConnection(id: string): Promise<void>

Implementation of ConnectionExt.$createConnection
- Defined in packages/plugin-ext/src/plugin/connection-ext.ts:52
Instantiates a new connection by the given id.

Parameters
- id: string
  
  the connection id
Returns Promise<void>

$deleteConnection

$deleteConnection(id: string): Promise<void>

Implementation of ConnectionExt.$deleteConnection
- Defined in packages/plugin-ext/src/plugin/connection-ext.ts:60
Deletes a connection.

Parameters
- id: string
  
  the connection id
Returns Promise<void>

$sendMessage

$sendMessage(id: string, message: string): Promise<void>

Implementation of ConnectionExt.$sendMessage
- Defined in packages/plugin-ext/src/plugin/connection-ext.ts:40
Gets the connection between plugin by id and sends string message to it.

Parameters
- id: string
  
  connection's id
- message: string
  
  incoming message
Returns Promise<void>

Protected doCreateConnection

doCreateConnection(id: string): Promise<PluginConnection>

- Defined in packages/plugin-ext/src/plugin/connection-ext.ts:84
Parameters
- id: string
Returns Promise<PluginConnection>

doEnsureConnection

doEnsureConnection(id: string): Promise<PluginConnection>

- Defined in packages/plugin-ext/src/plugin/connection-ext.ts:78
Returns existed connection or creates a new one.

Parameters
- id: string
  
  the connection id
Returns Promise<PluginConnection>

ensureConnection

ensureConnection(id: string): Promise<PluginConnection>

- Defined in packages/plugin-ext/src/plugin/connection-ext.ts:68
Returns existed connection or creates a new one.

Parameters
- id: string
  
  the connection id
Returns Promise<PluginConnection>