Class ClientNodes

Manages the set of known remote nodes.

Remote nodes are either peers (commissioned into a fabric we share) or commissionable.

Hierarchy (view full)

EndpointContainer<ClientNode>
- ClientNodes

Index

Constructors

constructor

new ClientNodes(owner): ClientNodes
Parameters
- owner: ServerNode<RootEndpoint>
Returns ClientNodes
Overrides EndpointContainer.constructor
- Defined in packages/node/src/node/client/ClientNodes.ts:29

Accessors

[value]

get [value](): Diagnostic
Returns Diagnostic
Inherited from EndpointContainer.[value]
- Defined in packages/node/src/endpoint/properties/EndpointContainer.ts:119

added

get added(): Observable<[T], void>
Returns Observable<[T], void>
Inherited from EndpointContainer.added
- Defined in packages/node/src/endpoint/properties/EndpointContainer.ts:59

deleted

get deleted(): Observable<[T], void>
Returns Observable<[T], void>
Inherited from EndpointContainer.deleted
- Defined in packages/node/src/endpoint/properties/EndpointContainer.ts:63

owner

get owner(): ServerNode<RootEndpoint>
Returns ServerNode<RootEndpoint>
Overrides EndpointContainer.owner
- Defined in packages/node/src/node/client/ClientNodes.ts:113

size

get size(): number
Returns number
Inherited from EndpointContainer.size
- Defined in packages/node/src/endpoint/properties/EndpointContainer.ts:67

Methods

[iterator]

[iterator](): SetIterator<ClientNode>
Returns SetIterator<ClientNode>
Inherited from EndpointContainer.[iterator]
- Defined in packages/node/src/endpoint/properties/EndpointContainer.ts:83

add

add(node): void
Parameters
- node: ClientNode
Returns void
Overrides EndpointContainer.add
- Defined in packages/node/src/node/client/ClientNodes.ts:117

assertIdAvailable

assertIdAvailable(id, endpoint): void
Confirm availability of an ID amongst the endpoint's children.
Parameters
- id: string
- endpoint: Endpoint<Empty>
Returns void
Inherited from EndpointContainer.assertIdAvailable
- Defined in packages/node/src/endpoint/properties/EndpointContainer.ts:108

clear

clear(): void
Returns void
Inherited from EndpointContainer.clear
- Defined in packages/node/src/endpoint/properties/EndpointContainer.ts:51

close

close(): Promise<void>
Destroy all parts. Invoked automatically by the owner on destroy.

Returns Promise<void>
Overrides EndpointContainer.close
- Defined in packages/node/src/node/client/ClientNodes.ts:123

commission

commission(passcode, discriminator?): Promise<ClientNode>
Find a specific commissionable node and commission.
Parameters
- passcode: number
- Optionaldiscriminator: number
Returns Promise<ClientNode>
- Defined in packages/node/src/node/client/ClientNodes.ts:79
commission(options): Promise<ClientNode>
Find a specific commissionable node and commission.
Parameters
- options: Options
Returns Promise<ClientNode>
- Defined in packages/node/src/node/client/ClientNodes.ts:84

delete

delete(endpoint): boolean
Parameters
- endpoint: ClientNode
Returns boolean
Inherited from EndpointContainer.delete
- Defined in packages/node/src/endpoint/properties/EndpointContainer.ts:47

discover

discover(options?): ContinuousDiscovery
Employ discovery to find a set of commissionable nodes.

If you do not provide a timeout value, will search until canceled and you need to add a listener to Discovery#discovered or added to receive discovered nodes.
Parameters
- Optionaloptions: Options
Returns ContinuousDiscovery
- Defined in packages/node/src/node/client/ClientNodes.ts:72

filter

filter(predicate): ClientNode[]
Parameters
- predicate: ((part: ClientNode) => boolean)
  - - (part): boolean
    - Parameters
      part: ClientNode
      Returns boolean
Returns ClientNode[]
Inherited from EndpointContainer.filter
- Defined in packages/node/src/endpoint/properties/EndpointContainer.ts:75

find

find(predicate): undefined | ClientNode
Parameters
- predicate: ((part: ClientNode) => boolean)
  - - (part): boolean
    - Parameters
      part: ClientNode
      Returns boolean
Returns undefined | ClientNode
Inherited from EndpointContainer.find
- Defined in packages/node/src/endpoint/properties/EndpointContainer.ts:79

get

get(id): undefined | ClientNode
Parameters
- id: string | PeerAddress
Returns undefined | ClientNode
Overrides EndpointContainer.get
- Defined in packages/node/src/node/client/ClientNodes.ts:98

has

has(endpoint): boolean
Parameters
- endpoint: ClientNode
Returns boolean
Inherited from EndpointContainer.has
- Defined in packages/node/src/endpoint/properties/EndpointContainer.ts:55

initialize

initialize(): void
Load nodes. Invoked automatically by owner.

Returns void
- Defined in packages/node/src/node/client/ClientNodes.ts:45

locate

locate(options?): InstanceDiscovery
Find a specific commissionable node.
Parameters
- Optionaloptions: Options
Returns InstanceDiscovery
- Defined in packages/node/src/node/client/ClientNodes.ts:62

map

map<T2>(fn): T2[]
Type Parameters
- T2
Parameters
- fn: ((part: ClientNode) => T2)
  - - (part): T2
    - Parameters
      part: ClientNode
      Returns T2
Returns T2[]
Inherited from EndpointContainer.map
- Defined in packages/node/src/endpoint/properties/EndpointContainer.ts:71

reset

reset(): Promise<void>
Soft-reset all parts. Invoked automatically by the owner on reset.

Returns Promise<void>
Inherited from EndpointContainer.reset
- Defined in packages/node/src/endpoint/properties/EndpointContainer.ts:90

Class ClientNodes

Hierarchy (view full)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns ClientNodes

Accessors

[value]

Returns Diagnostic

added

Returns Observable<[T], void>

deleted

Returns Observable<[T], void>

owner

Returns ServerNode<RootEndpoint>

size

Returns number

Methods

[iterator]

Returns SetIterator<ClientNode>

add

Parameters

Returns void

assertIdAvailable

Parameters

Returns void

clear

Returns void

close

Returns Promise<void>

commission

Parameters

Returns Promise<ClientNode>

Parameters

Returns Promise<ClientNode>

delete

Parameters

Returns boolean

discover

Parameters

Returns ContinuousDiscovery

filter

Parameters

Parameters

Returns boolean

Returns ClientNode[]

find

Parameters

Parameters

Returns boolean

Returns undefined | ClientNode

get

Parameters

Returns undefined | ClientNode

has

Parameters

Returns boolean

initialize

Returns void

locate

Parameters

Returns InstanceDiscovery

map

Type Parameters

Parameters

Parameters

Returns T2

Returns T2[]

reset

Returns Promise<void>

Settings

On This Page