Class PeerSet

Manages operational connections to peers on shared fabric.

Implements

Index

Constructors

Accessors

added construction deleted peers size

Methods

[iterator] close connect delete disconnect filter find get has initializeInteractionClient map [create]

Constructors

constructor

new PeerSet(context): PeerSet
Parameters
- context: PeerSetContext
Returns PeerSet
- Defined in packages/protocol/dist/esm/peer/PeerSet.d.ts:55

Accessors

added

get added(): Observable<[OperationalPeer], void>
Returns Observable<[OperationalPeer], void>
Implementation of ObservableSet.added
- Defined in packages/protocol/dist/esm/peer/PeerSet.d.ts:56

construction

get construction(): Construction<PeerSet>
Returns Construction<PeerSet>
- Defined in packages/protocol/dist/esm/peer/PeerSet.d.ts:64

deleted

get deleted(): Observable<[OperationalPeer], void>
Returns Observable<[OperationalPeer], void>
Implementation of ObservableSet.deleted
- Defined in packages/protocol/dist/esm/peer/PeerSet.d.ts:57

peers

get peers(): BasicSet<OperationalPeer, OperationalPeer>
Returns BasicSet<OperationalPeer, OperationalPeer>
- Defined in packages/protocol/dist/esm/peer/PeerSet.d.ts:66

size

get size(): number
Returns number
Implementation of ImmutableSet.size
- Defined in packages/protocol/dist/esm/peer/PeerSet.d.ts:59

Methods

[iterator]

[iterator](): SetIterator<OperationalPeer>
Returns SetIterator<OperationalPeer>
Implementation of ImmutableSet.[iterator]
- Defined in packages/protocol/dist/esm/peer/PeerSet.d.ts:63

close

close(): Promise<void>
Returns Promise<void>
- Defined in packages/protocol/dist/esm/peer/PeerSet.d.ts:84

connect

connect(address, discoveryOptions, allowUnknownPeer?): Promise<InteractionClient>
Connect to a node on a fabric.
Parameters
- address: PeerAddress
- discoveryOptions: DiscoveryOptions
- OptionalallowUnknownPeer: boolean
Returns Promise<InteractionClient>
- Defined in packages/protocol/dist/esm/peer/PeerSet.d.ts:70

delete

delete(peer): Promise<void>
Forget a known peer.
Parameters
- peer: PeerAddress | OperationalPeer
Returns Promise<void>
- Defined in packages/protocol/dist/esm/peer/PeerSet.d.ts:83

disconnect

disconnect(peer): Promise<void>
Terminate any active peer connection.
Parameters
- peer: PeerAddress | OperationalPeer
Returns Promise<void>
- Defined in packages/protocol/dist/esm/peer/PeerSet.d.ts:79

filter

filter(predicate): OperationalPeer[]
Parameters
- predicate: ((item: OperationalPeer) => undefined | boolean)
  - - (item): undefined | boolean
    - Parameters
      item: OperationalPeer
      Returns undefined | boolean
Returns OperationalPeer[]
Implementation of ImmutableSet.filter
- Defined in packages/protocol/dist/esm/peer/PeerSet.d.ts:61

find

find(predicate): undefined | OperationalPeer
Parameters
- predicate: ((item: OperationalPeer) => undefined | boolean)
  - - (item): undefined | boolean
    - Parameters
      item: OperationalPeer
      Returns undefined | boolean
Returns undefined | OperationalPeer
Implementation of ImmutableSet.find
- Defined in packages/protocol/dist/esm/peer/PeerSet.d.ts:60

get

get(peer): undefined | OperationalPeer
Retrieve a peer by address.
Parameters
- peer: PeerAddress | OperationalPeer
Returns undefined | OperationalPeer
- Defined in packages/protocol/dist/esm/peer/PeerSet.d.ts:75

has

has(item): boolean
Parameters
- item: PeerAddress | OperationalPeer
Returns boolean
Implementation of ImmutableSet.has
- Defined in packages/protocol/dist/esm/peer/PeerSet.d.ts:58

initializeInteractionClient

initializeInteractionClient(address, discoveryOptions?): Promise<InteractionClient>
Parameters
- address: PeerAddress
- OptionaldiscoveryOptions: DiscoveryOptions
Returns Promise<InteractionClient>
- Defined in packages/protocol/dist/esm/peer/PeerSet.d.ts:71

map

map<T>(mapper): T[]
Type Parameters
- T
Parameters
- mapper: ((item: OperationalPeer) => T)
  - - (item): T
    - Parameters
      item: OperationalPeer
      Returns T
Returns T[]
- Defined in packages/protocol/dist/esm/peer/PeerSet.d.ts:62

`Static`[create]

[create](env): PeerSet
Parameters
- env: Environment
Returns PeerSet
- Defined in packages/protocol/dist/esm/peer/PeerSet.d.ts:65