ConnectionsManager

@hyperledger/identus-sdk v8.1.3

---

@hyperledger/identus-sdk / overview / ConnectionsManager

Class: ConnectionsManager

Defined in: packages/lib/sdk/src/edge-agent/connections/ConnectionsManager.ts:13

ConnectionsManager is responsible for handling Connections and Mediators

Mediators are a Connection where we periodically fetch messages from

ConnectionsManager

Constructors

Constructor

new ConnectionsManager(): ConnectionsManager

Returns

ConnectionsManager

Accessors

mediator

Get Signature

get mediator(): Nil | MediatorConnection

Defined in: packages/lib/sdk/src/edge-agent/connections/ConnectionsManager.ts:18

Returns

Nil | MediatorConnection

Methods

add()

add(connection: Connection): void

Defined in: packages/lib/sdk/src/edge-agent/connections/ConnectionsManager.ts:48

add a Connection

Parameters

Parameter	Type	Description
connection	Connection	-

Returns

void

---

addMediator()

addMediator(mediator: Connection): void

Defined in: packages/lib/sdk/src/edge-agent/connections/ConnectionsManager.ts:56

add a Connection and mark it as a Mediator

Parameters

Parameter	Type	Description
mediator	Connection	-

Returns

void

---

find()

find(uri: string): Connection | undefined

Defined in: packages/lib/sdk/src/edge-agent/connections/ConnectionsManager.ts:85

Search for a Connection by it's unique identifier

Parameters

Parameter	Type	Description
uri	string	-

Returns

Connection | undefined

---

remove()

remove(connection: string | Connection): Promise<void>

Defined in: packages/lib/sdk/src/edge-agent/connections/ConnectionsManager.ts:69

Remove a Connection this but just means the connection will be removed from the current storage

Parameters

Parameter	Type	Description
connection	string | Connection	-

Returns

Promise<void>

---

stop()

stop(): Promise<void>

Defined in: packages/lib/sdk/src/edge-agent/connections/ConnectionsManager.ts:35

close all active connections

Returns

Promise<void>