Class ThreadNetworkDiagnosticsServer

This is the default server implementation of ThreadNetworkDiagnosticsBehavior.

Hierarchy (view full)

ThreadNetworkDiagnosticsBehavior
- ThreadNetworkDiagnosticsServer

Constructors

constructor

new ThreadNetworkDiagnosticsServer(agent, backing): ThreadNetworkDiagnosticsServer
Parameters
- agent: Agent
- backing: BehaviorBacking
Returns ThreadNetworkDiagnosticsServer
Inherited from ThreadNetworkDiagnosticsBehavior.constructor
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:119

Properties

[reference]

[reference]: Datasource<StateType>

agent

agent: Agent

cluster

cluster: never

The implemented cluster.

`Readonly`events

events: EventEmitter & Omit<ClusterEvents<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior>, never> & {
    activeNetworkFaultsList$Changing: ClusterEvents.AttributeObservable<Attribute<ThreadNetworkDiagnostics.NetworkFault[], any>>;
    channel$Changing: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
    channelPage0Mask$Changing: ClusterEvents.AttributeObservable<Attribute<null | Uint8Array, any>>;
    dataVersion$Changing: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
    extendedPanId$Changing: ClusterEvents.AttributeObservable<Attribute<null | number | bigint, any>>;
    leaderRouterId$Changing: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
    meshLocalPrefix$Changing: ClusterEvents.AttributeObservable<Attribute<null | Uint8Array, any>>;
    neighborTable$Changing: ClusterEvents.AttributeObservable<Attribute<TypeFromFields<{
        age: FieldType<number>;
        averageRssi: FieldType<null | number>;
        extAddress: FieldType<number | bigint>;
        frameErrorRate: FieldType<number>;
        fullNetworkData: FieldType<boolean>;
        fullThreadDevice: FieldType<boolean>;
        isChild: FieldType<boolean>;
        lastRssi: FieldType<null | number>;
        linkFrameCounter: FieldType<number>;
        lqi: FieldType<number>;
        messageErrorRate: FieldType<number>;
        mleFrameCounter: FieldType<number>;
        rloc16: FieldType<number>;
        rxOnWhenIdle: FieldType<boolean>;
    }>[], any>>;
    networkName$Changing: ClusterEvents.AttributeObservable<Attribute<null | string, any>>;
    operationalDatasetComponents$Changing: ClusterEvents.AttributeObservable<Attribute<null | TypeFromFields<{
        activeTimestampPresent: FieldType<boolean>;
        channelMaskPresent: FieldType<boolean>;
        channelPresent: FieldType<boolean>;
        delayPresent: FieldType<boolean>;
        extendedPanIdPresent: FieldType<boolean>;
        masterKeyPresent: FieldType<boolean>;
        meshLocalPrefixPresent: FieldType<boolean>;
        networkNamePresent: FieldType<boolean>;
        panIdPresent: FieldType<boolean>;
        pendingTimestampPresent: FieldType<boolean>;
        pskcPresent: FieldType<boolean>;
        securityPolicyPresent: FieldType<boolean>;
    }>, any>>;
    panId$Changing: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
    partitionId$Changing: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
    routeTable$Changing: ClusterEvents.AttributeObservable<Attribute<TypeFromFields<{
        age: FieldType<number>;
        allocated: FieldType<boolean>;
        extAddress: FieldType<number | bigint>;
        linkEstablished: FieldType<boolean>;
        lqiIn: FieldType<number>;
        lqiOut: FieldType<number>;
        nextHop: FieldType<number>;
        pathCost: FieldType<number>;
        rloc16: FieldType<number>;
        routerId: FieldType<number>;
    }>[], any>>;
    routingRole$Changing: ClusterEvents.AttributeObservable<Attribute<null | ThreadNetworkDiagnostics.RoutingRole, any>>;
    securityPolicy$Changing: ClusterEvents.AttributeObservable<Attribute<null | TypeFromFields<{
        flags: FieldType<number>;
        rotationTime: FieldType<number>;
    }>, any>>;
    stableDataVersion$Changing: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
    weighting$Changing: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
} & {
    activeTimestamp$Changing: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<null | number | bigint, any>>;
    delay$Changing: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<null | number, any>>;
    pendingTimestamp$Changing: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<null | number | bigint, any>>;
} & {
    activeNetworkFaultsList$Changed: ClusterEvents.AttributeObservable<Attribute<ThreadNetworkDiagnostics.NetworkFault[], any>>;
    channel$Changed: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
    channelPage0Mask$Changed: ClusterEvents.AttributeObservable<Attribute<null | Uint8Array, any>>;
    dataVersion$Changed: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
    extendedPanId$Changed: ClusterEvents.AttributeObservable<Attribute<null | number | bigint, any>>;
    leaderRouterId$Changed: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
    meshLocalPrefix$Changed: ClusterEvents.AttributeObservable<Attribute<null | Uint8Array, any>>;
    neighborTable$Changed: ClusterEvents.AttributeObservable<Attribute<TypeFromFields<{
        age: FieldType<number>;
        averageRssi: FieldType<null | number>;
        extAddress: FieldType<number | bigint>;
        frameErrorRate: FieldType<number>;
        fullNetworkData: FieldType<boolean>;
        fullThreadDevice: FieldType<boolean>;
        isChild: FieldType<boolean>;
        lastRssi: FieldType<null | number>;
        linkFrameCounter: FieldType<number>;
        lqi: FieldType<number>;
        messageErrorRate: FieldType<number>;
        mleFrameCounter: FieldType<number>;
        rloc16: FieldType<number>;
        rxOnWhenIdle: FieldType<boolean>;
    }>[], any>>;
    networkName$Changed: ClusterEvents.AttributeObservable<Attribute<null | string, any>>;
    operationalDatasetComponents$Changed: ClusterEvents.AttributeObservable<Attribute<null | TypeFromFields<{
        activeTimestampPresent: FieldType<boolean>;
        channelMaskPresent: FieldType<boolean>;
        channelPresent: FieldType<boolean>;
        delayPresent: FieldType<boolean>;
        extendedPanIdPresent: FieldType<boolean>;
        masterKeyPresent: FieldType<boolean>;
        meshLocalPrefixPresent: FieldType<boolean>;
        networkNamePresent: FieldType<boolean>;
        panIdPresent: FieldType<boolean>;
        pendingTimestampPresent: FieldType<boolean>;
        pskcPresent: FieldType<boolean>;
        securityPolicyPresent: FieldType<boolean>;
    }>, any>>;
    panId$Changed: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
    partitionId$Changed: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
    routeTable$Changed: ClusterEvents.AttributeObservable<Attribute<TypeFromFields<{
        age: FieldType<number>;
        allocated: FieldType<boolean>;
        extAddress: FieldType<number | bigint>;
        linkEstablished: FieldType<boolean>;
        lqiIn: FieldType<number>;
        lqiOut: FieldType<number>;
        nextHop: FieldType<number>;
        pathCost: FieldType<number>;
        rloc16: FieldType<number>;
        routerId: FieldType<number>;
    }>[], any>>;
    routingRole$Changed: ClusterEvents.AttributeObservable<Attribute<null | ThreadNetworkDiagnostics.RoutingRole, any>>;
    securityPolicy$Changed: ClusterEvents.AttributeObservable<Attribute<null | TypeFromFields<{
        flags: FieldType<number>;
        rotationTime: FieldType<number>;
    }>, any>>;
    stableDataVersion$Changed: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
    weighting$Changed: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
} & {
    activeTimestamp$Changed: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<null | number | bigint, any>>;
    delay$Changed: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<null | number, any>>;
    pendingTimestamp$Changed: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<null | number | bigint, any>>;
} & {} & {
    connectionStatus?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
        connectionStatus: FieldType<ThreadNetworkDiagnostics.ConnectionStatus>;
    }>, any>>;
    networkFaultChange?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
        current: FieldType<ThreadNetworkDiagnostics.NetworkFault[]>;
        previous: FieldType<ThreadNetworkDiagnostics.NetworkFault[]>;
    }>, any>>;
}

Access the behavior's events.

Type declaration

Optional ReadonlyconnectionStatus?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
connectionStatus: FieldType<ThreadNetworkDiagnostics.ConnectionStatus>;
}>, any>>
The ConnectionStatus Event shall indicate that a Node’s connection status to a Thread network has changed.

See
MatterSpecification.v13.Core § 11.14.8.2
Optional ReadonlynetworkFaultChange?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
current: FieldType<ThreadNetworkDiagnostics.NetworkFault[]>;
previous: FieldType<ThreadNetworkDiagnostics.NetworkFault[]>;
}>, any>>
The NetworkFaultChange Event shall indicate a change in the set of network faults currently detected by the Node.

See
MatterSpecification.v13.Core § 11.14.8.1

features

features: TypeFromBitSchema<{}> & TypeFromBitSchema<{
    errorCounts: BitFlag;
    macCounts: BitFlag;
    mleCounts: BitFlag;
    packetCounts: BitFlag;
}>

Supported features as a flag object.

session

session: SecureSession

`Readonly`state

state: Omit<ClusterState.Type<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior>, never> & {
    activeNetworkFaultsList: ThreadNetworkDiagnostics.NetworkFault[];
    channel: null | number;
    channelPage0Mask: null | Uint8Array;
    dataVersion: null | number;
    extendedPanId: null | number | bigint;
    leaderRouterId: null | number;
    meshLocalPrefix: null | Uint8Array;
    neighborTable: TypeFromFields<{
        age: FieldType<number>;
        averageRssi: FieldType<null | number>;
        extAddress: FieldType<number | bigint>;
        frameErrorRate: FieldType<number>;
        fullNetworkData: FieldType<boolean>;
        fullThreadDevice: FieldType<boolean>;
        isChild: FieldType<boolean>;
        lastRssi: FieldType<null | number>;
        linkFrameCounter: FieldType<number>;
        lqi: FieldType<number>;
        messageErrorRate: FieldType<number>;
        mleFrameCounter: FieldType<number>;
        rloc16: FieldType<number>;
        rxOnWhenIdle: FieldType<boolean>;
    }>[];
    networkName: null | string;
    operationalDatasetComponents: null | TypeFromFields<{
        activeTimestampPresent: FieldType<boolean>;
        channelMaskPresent: FieldType<boolean>;
        channelPresent: FieldType<boolean>;
        delayPresent: FieldType<boolean>;
        extendedPanIdPresent: FieldType<boolean>;
        masterKeyPresent: FieldType<boolean>;
        meshLocalPrefixPresent: FieldType<boolean>;
        networkNamePresent: FieldType<boolean>;
        panIdPresent: FieldType<boolean>;
        pendingTimestampPresent: FieldType<boolean>;
        pskcPresent: FieldType<boolean>;
        securityPolicyPresent: FieldType<boolean>;
    }>;
    panId: null | number;
    partitionId: null | number;
    routeTable: TypeFromFields<{
        age: FieldType<number>;
        allocated: FieldType<boolean>;
        extAddress: FieldType<number | bigint>;
        linkEstablished: FieldType<boolean>;
        lqiIn: FieldType<number>;
        lqiOut: FieldType<number>;
        nextHop: FieldType<number>;
        pathCost: FieldType<number>;
        rloc16: FieldType<number>;
        routerId: FieldType<number>;
    }>[];
    routingRole: null | ThreadNetworkDiagnostics.RoutingRole;
    securityPolicy: null | TypeFromFields<{
        flags: FieldType<number>;
        rotationTime: FieldType<number>;
    }>;
    stableDataVersion: null | number;
    weighting: null | number;
} & {
    activeTimestamp?: null | number | bigint;
    delay?: null | number;
    pendingTimestamp?: null | number | bigint;
} & {} & {}

Access the behavior's state.

Type declaration

ReadonlyactiveNetworkFaultsList: ThreadNetworkDiagnostics.NetworkFault[]
See
MatterSpecification.v13.Core § 11.14.6
Readonlychannel: null | number
The Channel attribute shall indicate the 802.15.4 channel number configured on the Node’s Thread interface (that is, the Active Operational Dataset’s current Channel value). A value of null shall indicate that the Thread interface is not currently configured or operational.

See
MatterSpecification.v13.Core § 11.14.6.1
ReadonlychannelPage0Mask: null | Uint8Array
The ChannelPage0Mask attribute indicates the channels within channel page 0, in the 2.4GHz ISM band. The channels are represented in most significant bit order, with bit value 1 meaning selected, bit value 0 meaning unselected. For example, the most significant bit of the left-most byte indicates channel 0. If channel 0 and channel 10 are selected, the mask would be: 80 20 00 00. Null when there is no dataset configured.

See
MatterSpecification.v13.Core § 11.14.6.61
ReadonlydataVersion: null | number
The DataVersion attribute shall indicate the full Network Data Version the Node currently uses. Null if not attached to a Thread network.

See
MatterSpecification.v13.Core § 11.14.6.12
ReadonlyextendedPanId: null | number | bigint
The ExtendedPanId attribute shall indicate the unique 64-bit identifier of the Node on the Thread network. A value of null shall indicate that the Thread interface is not currently configured or operational.

See
MatterSpecification.v13.Core § 11.14.6.5
ReadonlyleaderRouterId: null | number
The LeaderRouterId attribute shall indicate the 8-bit LeaderRouterId the Node shall attempt to utilize upon becoming a router or leader on the Thread network. Null if not attached to a Thread network.

See
MatterSpecification.v13.Core § 11.14.6.14
ReadonlymeshLocalPrefix: null | Uint8Array
The MeshLocalPrefix attribute shall indicate the mesh-local IPv6 prefix for the Thread network that the Node has been configured to join to. A value of null shall indicate that the Thread interface is not currently configured or operational.

See
MatterSpecification.v13.Core § 11.14.6.6
ReadonlyneighborTable: TypeFromFields<{
    age: FieldType<number>;
    averageRssi: FieldType<null | number>;
    extAddress: FieldType<number | bigint>;
    frameErrorRate: FieldType<number>;
    fullNetworkData: FieldType<boolean>;
    fullThreadDevice: FieldType<boolean>;
    isChild: FieldType<boolean>;
    lastRssi: FieldType<null | number>;
    linkFrameCounter: FieldType<number>;
    lqi: FieldType<number>;
    messageErrorRate: FieldType<number>;
    mleFrameCounter: FieldType<number>;
    rloc16: FieldType<number>;
    rxOnWhenIdle: FieldType<boolean>;
}>[]
The NeighborTable attribute shall indicate the current list of Nodes that comprise the neighbor table on the Node.

See
MatterSpecification.v13.Core § 11.14.6.8
ReadonlynetworkName: null | string
The NetworkName attribute shall indicate a human-readable (displayable) name for the Thread network that the Node has been configured to join to. A value of null shall indicate that the Thread interface is not currently configured or operational.

See
MatterSpecification.v13.Core § 11.14.6.3
ReadonlyoperationalDatasetComponents: null | TypeFromFields<{
    activeTimestampPresent: FieldType<boolean>;
    channelMaskPresent: FieldType<boolean>;
    channelPresent: FieldType<boolean>;
    delayPresent: FieldType<boolean>;
    extendedPanIdPresent: FieldType<boolean>;
    masterKeyPresent: FieldType<boolean>;
    meshLocalPrefixPresent: FieldType<boolean>;
    networkNamePresent: FieldType<boolean>;
    panIdPresent: FieldType<boolean>;
    pendingTimestampPresent: FieldType<boolean>;
    pskcPresent: FieldType<boolean>;
    securityPolicyPresent: FieldType<boolean>;
}>
The OperationalDatasetComponents attribute is a collection of flags to indicate the presence of various operationally acquired values.

See
MatterSpecification.v13.Core § 11.14.6.62
ReadonlypanId: null | number
The PanId attribute shall indicate the 16-bit identifier of the Node on the Thread network. A value of null shall indicate that the Thread interface is not currently configured or operational.

See
MatterSpecification.v13.Core § 11.14.6.4
ReadonlypartitionId: null | number
The PartitionId attribute shall indicate the Thread Leader Partition Id for the Thread network to which the Node is joined. Null if not attached to a Thread network.

See
MatterSpecification.v13.Core § 11.14.6.10
ReadonlyrouteTable: TypeFromFields<{
    age: FieldType<number>;
    allocated: FieldType<boolean>;
    extAddress: FieldType<number | bigint>;
    linkEstablished: FieldType<boolean>;
    lqiIn: FieldType<number>;
    lqiOut: FieldType<number>;
    nextHop: FieldType<number>;
    pathCost: FieldType<number>;
    rloc16: FieldType<number>;
    routerId: FieldType<number>;
}>[]
The RouteTable attribute shall indicate the current list of router capable Nodes for which routes have been established.

See
MatterSpecification.v13.Core § 11.14.6.9
ReadonlyroutingRole: null | ThreadNetworkDiagnostics.RoutingRole
The RoutingRole attribute shall indicate the role that this Node has within the routing of messages through the Thread network, as defined by RoutingRoleEnum. The potential roles are defined in the following table. A value of null shall indicate that the Thread interface is not currently configured or operational.

See
MatterSpecification.v13.Core § 11.14.6.2
ReadonlysecurityPolicy: null | TypeFromFields<{
flags: FieldType<number>;
rotationTime: FieldType<number>;
}>
The SecurityPolicy attribute indicates the current security policies for the Thread partition to which a Node is connected. Null when there is no dataset configured.

See
MatterSpecification.v13.Core § 11.14.6.60
ReadonlystableDataVersion: null | number
The StableDataVersion attribute shall indicate the Network Data Version for the stable subset of

data the Node currently uses. Null if not attached to a Thread network.

See
MatterSpecification.v13.Core § 11.14.6.13
Readonlyweighting: null | number
The Weighting attribute shall indicate the Thread Leader Weight used when operating in the Leader role. Null if not attached to a Thread network.

See
MatterSpecification.v13.Core § 11.14.6.11

Type declaration

Optional ReadonlyactiveTimestamp?: null | number | bigint
Null when there is no dataset configured.

See
MatterSpecification.v13.Core § 11.14.6.57
Optional Readonlydelay?: null | number
Null when there is no dataset configured.

See
MatterSpecification.v13.Core § 11.14.6.59
Optional ReadonlypendingTimestamp?: null | number | bigint
Null when there is no dataset configured.

See
MatterSpecification.v13.Core § 11.14.6.58

`Static` `Readonly`cluster

cluster: ThreadNetworkDiagnostics.Cluster

Base cluster state include all attribute values but may be extended by subclasses.

`Static` `Readonly`defaults

defaults: ClusterState.Type<ThreadNetworkDiagnostics.Cluster, Type<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior, ThreadNetworkDiagnosticsInterface>>

`Static` `Optional` `Readonly`dependencies

dependencies?: Iterable<Type, any, any>

`Static` `Readonly`early

early: boolean

`Static` `Readonly`Events

Events: ClusterEvents.Type<ThreadNetworkDiagnostics.Cluster, Type<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior, ThreadNetworkDiagnosticsInterface>>

`Static` `Readonly`ExtensionInterface

ExtensionInterface: {}

`Static` `Readonly`id

The behavior ID for ClusterBehaviors is the name of the cluster.

`Static` `Readonly`Interface

Interface: ThreadNetworkDiagnosticsInterface

`Static` `Readonly`Internal

Internal: (new () => {})

Type declaration

- new (): {}
- Implementation of internal state. Subclasses may override to extend.
  
  Returns {}

`Static` `Readonly`name

name: string

`Static` `Optional` `Readonly`schema

schema?: Schema

`Static` `Readonly`State

State: (new () => ClusterState.Type<ThreadNetworkDiagnostics.Cluster, Type<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior, ThreadNetworkDiagnosticsInterface>>)

`Static` `Readonly`supervisor

supervisor: RootSupervisor

`Static`supports

supports: ((other: Type) => boolean)

Type declaration

- (other): boolean
- Does this behavior support functionality of a specific implementation?
  Parameters
  - other: Type
  Returns boolean

Methods

[asyncDispose]

[asyncDispose](): MaybePromise
Release resources. This is the public API for releasing application resources held by behaviors in internal state.

Returns MaybePromise
Inherited from ThreadNetworkDiagnosticsBehavior.[asyncDispose]
- Defined in packages/node/dist/esm/behavior/Behavior.d.ts:115

asAdmin

asAdmin(fn): void
Execute logic with elevated privileges.

The provided function executes with privileges escalated to offline mode. This is not commonly necessary.

Elevated logic effectively ignores ACLs so should be used with care.

Note that interactions with the behavior will remain elevated until the synchronous completion of this call. You should only elevate privileges for synchronous logic.
Parameters
- fn: (() => void)
  the elevated logic
  - - (): void
    - Returns void
Returns void
Inherited from ThreadNetworkDiagnosticsBehavior.asAdmin
- Defined in packages/node/dist/esm/behavior/Behavior.d.ts:77

assertAttributeEnabled

assertAttributeEnabled<This, K>(this, attributeName): void
Type Parameters
- This extends Behavior
- K extends string | number | symbol
Parameters
- this: This
- attributeName: K
Returns void
Inherited from ThreadNetworkDiagnosticsBehavior.assertAttributeEnabled
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:112

`Protected`callback

callback<A, R>(reactor, options?): ((...args: A) => undefined | R)
Create a generic callback function that has the same properties as a Reactor.

Like a reactor, the callback's "this" will be bound to an active Behavior instance. Because of this: The reactor MUST be a real JS function - arrow functions will not work!
Type Parameters
- A extends any[]
- R
Parameters
- reactor: Reactor<A, R>
- Optionaloptions: Reactor.Options
Returns ((...args: A) => undefined | R)
- - (...args): undefined | R
  - Parameters
    - Rest...args: A
    Returns undefined | R
Inherited from ThreadNetworkDiagnosticsBehavior.callback
- Defined in packages/node/dist/esm/behavior/Behavior.d.ts:132

initialize

initialize(_options?): MaybePromise
Behaviors are ephemeral and should not perform initialization in their constructor. They can override this method instead.

This method may be synchronous or asyncronous. If asynchronous, the behavior will not be available for external use until initialization completes.
Parameters
- Optional_options: {}
Returns MaybePromise
Inherited from ThreadNetworkDiagnosticsBehavior.initialize
- Defined in packages/node/dist/esm/behavior/Behavior.d.ts:110

`Protected`reactTo

reactTo<O>(observable, reactor, options?): void
Install a Reactor.

Important: The reactor MUST be a real JS function - arrow functions will not work!
Type Parameters
- O extends Observable<any[], any>
Parameters
- observable: O
- reactor: Reactor<Parameters<O["emit"]>, ReturnType<O["emit"]>>
- Optionaloptions: Reactor.Options
Returns void
Inherited from ThreadNetworkDiagnosticsBehavior.reactTo
- Defined in packages/node/dist/esm/behavior/Behavior.d.ts:125

requireAttributeEnabled

requireAttributeEnabled<This, K>(this, attributeName): Exclude<This["state"][K], undefined>
Type Parameters
- This extends Behavior
- K extends string | number | symbol
Parameters
- this: This
- attributeName: K
Returns Exclude<This["state"][K], undefined>
Inherited from ThreadNetworkDiagnosticsBehavior.requireAttributeEnabled
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:111

toString

toString(): string
Description used in diagnostic messages.

Returns string
Inherited from ThreadNetworkDiagnosticsBehavior.toString
- Defined in packages/node/dist/esm/behavior/Behavior.d.ts:119

`Static`alter

alter<This, const AlterationsT>(this, alterations): Type<WithAlterations<This["cluster"], AlterationsT>, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const AlterationsT extends Alterations<This["cluster"]>
Parameters
- this: This
- alterations: AlterationsT
Returns Type<WithAlterations<This["cluster"], AlterationsT>, This, ClusterInterface.InterfaceOf<This>>
Inherited from ThreadNetworkDiagnosticsBehavior.alter
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:142

`Static`enable

enable<This, const FlagsT>(this, flags): Type<WithAlterations<This["cluster"], ElementFlagAlterations<FlagsT>>, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const FlagsT extends ElementFlags<This["cluster"]>
Parameters
- this: This
- flags: FlagsT
Returns Type<WithAlterations<This["cluster"], ElementFlagAlterations<FlagsT>>, This, ClusterInterface.InterfaceOf<This>>
Inherited from ThreadNetworkDiagnosticsBehavior.enable
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:144

`Static`for

for<This, const ClusterT>(this, cluster, schema?): Type<ClusterT, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const ClusterT extends ClusterType
Parameters
- this: This
- cluster: ClusterT
- Optionalschema: Schema
Returns Type<ClusterT, This, ClusterInterface.InterfaceOf<This>>
Inherited from ThreadNetworkDiagnosticsBehavior.for
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:140

`Static`set

set<This>(this, defaults): This
Type Parameters
- This extends Type
Parameters
- this: This
- defaults: Partial<RelaxTypes<InstanceType<This["State"]>>>
Returns This
Inherited from ThreadNetworkDiagnosticsBehavior.set
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:143

`Static`with

with<This, const FeaturesT>(this, ...features): Type<WithFeatures<This["cluster"], FeaturesT>, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const FeaturesT extends FeatureSelection<This["cluster"]>
Parameters
- this: This
- Rest...features: FeaturesT
Returns Type<WithFeatures<This["cluster"], FeaturesT>, This, ClusterInterface.InterfaceOf<This>>
Inherited from ThreadNetworkDiagnosticsBehavior.with
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:141

Class ThreadNetworkDiagnosticsServer

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ThreadNetworkDiagnosticsServer

Properties

[reference]

agent

cluster

context

endpoint

env

Readonlyevents

Type declaration

Optional ReadonlyconnectionStatus?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{ connectionStatus: FieldType<ThreadNetworkDiagnostics.ConnectionStatus>; }>, any>>

See

Optional ReadonlynetworkFaultChange?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{ current: FieldType<ThreadNetworkDiagnostics.NetworkFault[]>; previous: FieldType<ThreadNetworkDiagnostics.NetworkFault[]>; }>, any>>

See

features

session

Readonlystate

Type declaration

ReadonlyactiveNetworkFaultsList: ThreadNetworkDiagnostics.NetworkFault[]

See

Readonlychannel: null | number

See

ReadonlychannelPage0Mask: null | Uint8Array

See

ReadonlydataVersion: null | number

See

ReadonlyextendedPanId: null | number | bigint

See

ReadonlyleaderRouterId: null | number

See

ReadonlymeshLocalPrefix: null | Uint8Array

See

See

ReadonlynetworkName: null | string

See

See

ReadonlypanId: null | number

See

ReadonlypartitionId: null | number

See

See

ReadonlyroutingRole: null | ThreadNetworkDiagnostics.RoutingRole

See

ReadonlysecurityPolicy: null | TypeFromFields<{ flags: FieldType<number>; rotationTime: FieldType<number>; }>

See

ReadonlystableDataVersion: null | number

See

Readonlyweighting: null | number

See

Type declaration

Optional ReadonlyactiveTimestamp?: null | number | bigint

See

Optional Readonlydelay?: null | number

See

Optional ReadonlypendingTimestamp?: null | number | bigint

See

Static Readonlycluster

Static Readonlydefaults

Static Optional Readonlydependencies

Static Readonlyearly

Static ReadonlyEvents

Static ReadonlyExtensionInterface

Static Readonlyid

Static ReadonlyInterface

Static ReadonlyInternal

Type declaration

Returns {}

Static Readonlyname

Static Optional Readonlyschema

Static ReadonlyState

Static Readonlysupervisor

`Readonly`events

`Optional` `Readonly`connectionStatus?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
connectionStatus: FieldType<ThreadNetworkDiagnostics.ConnectionStatus>;
}>, any>>

`Optional` `Readonly`networkFaultChange?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
current: FieldType<ThreadNetworkDiagnostics.NetworkFault[]>;
previous: FieldType<ThreadNetworkDiagnostics.NetworkFault[]>;
}>, any>>

`Readonly`state

`Readonly`activeNetworkFaultsList: ThreadNetworkDiagnostics.NetworkFault[]

`Readonly`channel: null | number

`Readonly`channelPage0Mask: null | Uint8Array

`Readonly`dataVersion: null | number

`Readonly`extendedPanId: null | number | bigint

`Readonly`leaderRouterId: null | number

`Readonly`meshLocalPrefix: null | Uint8Array

`Readonly`networkName: null | string

`Readonly`panId: null | number

`Readonly`partitionId: null | number

`Readonly`routingRole: null | ThreadNetworkDiagnostics.RoutingRole

`Readonly`securityPolicy: null | TypeFromFields<{
flags: FieldType<number>;
rotationTime: FieldType<number>;
}>

`Readonly`stableDataVersion: null | number

`Readonly`weighting: null | number

`Optional` `Readonly`activeTimestamp?: null | number | bigint

`Optional` `Readonly`delay?: null | number

`Optional` `Readonly`pendingTimestamp?: null | number | bigint

`Static` `Readonly`cluster

`Static` `Readonly`defaults

`Static` `Optional` `Readonly`dependencies

`Static` `Readonly`early

`Static` `Readonly`Events

`Static` `Readonly`ExtensionInterface

`Static` `Readonly`id

`Static` `Readonly`Interface

`Static` `Readonly`Internal

`Static` `Readonly`name

`Static` `Optional` `Readonly`schema

`Static` `Readonly`State

`Static` `Readonly`supervisor

`Static`supports

`Protected`callback

`Protected`reactTo

`Static`alter

`Static`enable

`Static`for

`Static`set

`Static`with