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)

Constructors

constructor

Accessors

[value] added deleted owner size

Methods

[iterator] add assertIdAvailable clear close commission delete discover filter find get has initialize locate map reset

Constructors

constructor

Accessors

[value]

  • get [value](): Diagnostic

  • Returns Diagnostic

added

  • get added(): Observable<[T], void>

  • Returns Observable<[T], void>

deleted

  • get deleted(): Observable<[T], void>

  • Returns Observable<[T], void>

owner

size

  • get size(): number

  • Returns number

Methods

[iterator]

  • [iterator](): SetIterator<ClientNode>

  • Returns SetIterator<ClientNode>

add

  • add(node): void

  • Parameters

    • node: ClientNode

    Returns void

assertIdAvailable

  • assertIdAvailable(id, endpoint): void

  • Confirm availability of an ID amongst the endpoint's children.

    Parameters

    Returns void

clear

  • clear(): void

  • Returns void

close

  • close(): Promise<void>

  • Destroy all parts. Invoked automatically by the owner on destroy.

    Returns Promise<void>

commission

  • commission(passcode, discriminator?): Promise<ClientNode>

  • Find a specific commissionable node and commission.

    Parameters

    • passcode: number
    • Optionaldiscriminator: number

    Returns Promise<ClientNode>

  • commission(options): Promise<ClientNode>

  • Find a specific commissionable node and commission.

    Parameters

    Returns Promise<ClientNode>

delete

  • delete(endpoint): boolean

  • Parameters

    • endpoint: ClientNode

    Returns boolean

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

    Returns ContinuousDiscovery

filter

  • filter(predicate): ClientNode[]

  • Parameters

    • predicate: ((part: ClientNode) => boolean)
        • (part): boolean

        • Parameters

          • part: ClientNode

          Returns boolean

    Returns ClientNode[]

find

  • find(predicate): undefined | ClientNode

  • Parameters

    • predicate: ((part: ClientNode) => boolean)
        • (part): boolean

        • Parameters

          • part: ClientNode

          Returns boolean

    Returns undefined | ClientNode

get

  • get(id): undefined | ClientNode

  • Parameters

    Returns undefined | ClientNode

has

  • has(endpoint): boolean

  • Parameters

    • endpoint: ClientNode

    Returns boolean

initialize

  • initialize(): void

  • Load nodes. Invoked automatically by owner.

    Returns void

locate

map

  • map<T2>(fn): T2[]

  • Type Parameters

    • T2

    Parameters

    • fn: ((part: ClientNode) => T2)
        • (part): T2

        • Parameters

          • part: ClientNode

          Returns T2

    Returns T2[]

reset

  • reset(): Promise<void>

  • Soft-reset all parts. Invoked automatically by the owner on reset.

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods