ConnectionMainImpl | Theia TypeDoc

Implementation of connection system of the plugin API. Creates holds the connections to the plugins. Allows to send a message to the plugin by getting already created connection via id.

Hierarchy

ConnectionMainImpl

Implements

ConnectionMain
Disposable

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ConnectionMainImpl(rpc: RPCProtocol): ConnectionMainImpl

- Defined in packages/plugin-ext/src/main/browser/connection-main.ts:32
Parameters
- rpc: RPCProtocol
Returns ConnectionMainImpl

Properties

Private Readonly connections

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

Private Readonly proxy

proxy: ConnectionExt

Private Readonly toDispose

toDispose: DisposableCollection = ...

Methods

$createConnection

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

Implementation of ConnectionMain.$createConnection
- Defined in packages/plugin-ext/src/main/browser/connection-main.ts:59
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 ConnectionMain.$deleteConnection
- Defined in packages/plugin-ext/src/main/browser/connection-main.ts:67
Deletes a connection.

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

$sendMessage

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

Implementation of ConnectionMain.$sendMessage
- Defined in packages/plugin-ext/src/main/browser/connection-main.ts:47
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>

dispose

dispose(): void

Implementation of Disposable.dispose
- Defined in packages/plugin-ext/src/main/browser/connection-main.ts:37
Returns void

Protected doCreateConnection

doCreateConnection(id: string): Promise<PluginConnection>

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

doEnsureConnection

doEnsureConnection(id: string): Promise<PluginConnection>

- Defined in packages/plugin-ext/src/main/browser/connection-main.ts:85
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/main/browser/connection-main.ts:75
Returns existed connection or creates a new one.

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

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

rpc: RPCProtocol

Returns ConnectionMainImpl

Properties

Private Readonly connections

Private Readonly proxy

Private Readonly toDispose

Methods

$createConnection

Parameters

id: string

Returns Promise<void>

$deleteConnection

Parameters

id: string

Returns Promise<void>

$sendMessage

Parameters

id: string

message: string

Returns Promise<void>

dispose

Returns void

Protected doCreateConnection

Parameters

id: string

Returns Promise<PluginConnection>

doEnsureConnection

Parameters

id: string

Returns Promise<PluginConnection>

ensureConnection

Parameters

id: string

Returns Promise<PluginConnection>