Class Node<T>Abstract

A Matter Node.

In Matter, a "node" is an individually addressable top-level network resource.

Type Parameters

Hierarchy (view full)

Constructors

constructor

Accessors

[label] [value] agentType behaviors construction container diagnosticDict env events hasParts id lifecycle maybeId maybeNumber number owner parts path state type

Methods

[asyncDispose] [construct] [destruct] act add assertConstructable bringOnline cancel close createLifecycle createRuntime delete erase eventsOf initialize ownerOfType prepareRuntimeShutdown reset run set setStateOf start stateOf statusUpdate toString visit

Constructors

constructor

Accessors

[label]

  • get [label](): (string | Diagnostic)[]

  • Returns (string | Diagnostic)[]

[value]

  • get [value](): unknown

  • Hierarchical diagnostics of endpoint and children.

    Returns unknown

agentType

  • get agentType(): Type<T>

  • Create an Agent.Type for the endpoint.

    Returns Type<T>

behaviors

  • get behaviors(): Behaviors

  • Access the pool of behaviors supported by this endpoint.

    Returns Behaviors

construction

Protectedcontainer

diagnosticDict

  • get diagnosticDict(): Record<string, unknown> & Diagnostic

  • Diagnostic information regarding endpoint state.

    Returns Record<string, unknown> & Diagnostic

env

  • get env(): Environment

  • The endpoint's environment. Endpoint implementations use the environment to access platform components such as storage and network components.

    Returns Environment

events

  • get events(): EventsOf<T["behaviors"]>

  • Events for all behaviors keyed by behavior ID.

    Returns EventsOf<T["behaviors"]>

hasParts

  • get hasParts(): boolean

  • Is this a parent Endpoint?

    Returns boolean

id

  • get id(): string

  • A string that uniquely identifies an endpoint.

    This ID must be unique amongst all Parts with the same owner.

    Returns string

  • set id(id): void

  • Parameters

    • id: string

    Returns void

lifecycle

  • get lifecycle(): NodeLifecycle

  • Endpoint information that varies as the endpoint initializes.

    Returns NodeLifecycle

maybeId

  • get maybeId(): undefined | string

  • The endpoint ID or undefined if not yet assigned.

    Returns undefined | string

maybeNumber

  • get maybeNumber(): undefined | EndpointNumber

  • The endpoint number or undefined if not yet assigned.

    Returns undefined | EndpointNumber

number

  • get number(): EndpointNumber

  • The Matter EndpointNumber of the endpoint. This uniquely identifies the Endpoint in the scope of the Matter node.

    Returns EndpointNumber

  • set number(number): void

  • Parameters

    • number: number

    Returns void

owner

  • get owner(): undefined | Endpoint<Empty>

  • The owner of the endpoint.

    Every endpoint but the root endpoint (the "server node") is owned by another endpoint.

    Returns undefined | Endpoint<Empty>

  • set owner(owner): void

  • Parameters

    Returns void

parts

  • get parts(): Parts

  • Access child parts.

    Returns Parts

path

  • get path(): DataModelPath

  • Path identifying the endpoint in the Matter data model.

    Returns DataModelPath

state

  • get state(): Immutable<StateOf<T["behaviors"]>>

  • Current state values for all behaviors, keyed by behavior ID. This view is read-only.

    Returns Immutable<StateOf<T["behaviors"]>>

type

  • get type(): EndpointType

  • The type of endpoint this endpoint implements.

    Returns EndpointType

Methods

[asyncDispose]

  • [asyncDispose](): Promise<void>

  • Returns Promise<void>

[construct]

[destruct]

  • [destruct](): Promise<void>

  • Returns Promise<void>

act

  • act<R>(purpose, actor): MaybePromise<R>

  • Execute a function against an Agent for the endpoint.

    Agents provide the highest-leve API for interacting with endpoints. The agent is a composite object with properties for each supported behavior.

    State changes made by actor are atomic and made permanent only when the actor exits unless you commit the transaction manually.

    actor runs in an "offline" context where ACLs are ignored and all state is read/write.

    The Agent is destroyed after actor exits so you should not maintain references to the agent, its behaviors or associated state.

    actor may be async. If so, the acting context will remain open until the returned Promise resolves.

    Type Parameters

    • R

    Parameters

    Returns MaybePromise<R>

  • act<R>(actor): MaybePromise<R>

  • Version of act without explicit diagnostic purpose.

    Type Parameters

    • R

    Parameters

    Returns MaybePromise<R>

add

ProtectedassertConstructable

  • assertConstructable(): void

  • Ensure requirements for construction are met.

    Returns void

bringOnline

  • bringOnline(): Promise<void>

  • Returns Promise<void>

    Deprecated

    use start

cancel

  • cancel(): Promise<void>

  • Take the node offline but leave state and structure intact. Happens automatically on close.

    Once the node is offline you may use start to bring the node online again.

    Returns Promise<void>

close

  • close(): Promise<void>

  • Returns Promise<void>

ProtectedcreateLifecycle

Protected AbstractcreateRuntime

  • createRuntime(): NetworkRuntime

  • Create the network runtime.

    Returns NetworkRuntime

delete

  • delete(): Promise<void>

  • Erase all persisted data and destroy the node.

    Returns Promise<void>

erase

  • erase(): Promise<void>

  • Perform "hard" reset of the endpoint, reverting all in-memory and persistent state to uninitialized.

    Returns Promise<void>

eventsOf

  • eventsOf<T>(type): InstanceType<T["Events"]>

  • Events for a specific behavior.

    Type Parameters

    Parameters

    • type: T

    Returns InstanceType<T["Events"]>

Protectedinitialize

  • initialize(): MaybePromise

  • Asynchronous initialization.

    Derivatives may override to perform async construction prior to full initialization.

    Returns MaybePromise

ownerOfType

  • ownerOfType<T>(type): undefined | Endpoint<T>

  • Search for the owner of a specific type.

    Returns undefined if this owner is not found on the way up to the root endpoint.

    Type Parameters

    Parameters

    • type: T

    Returns undefined | Endpoint<T>

AbstractprepareRuntimeShutdown

  • prepareRuntimeShutdown(): Promise<void>

  • Returns Promise<void>

reset

  • reset(): Promise<void>

  • Perform "soft" reset of the endpoint, reverting all in-memory structures to uninitialized.

    Returns Promise<void>

run

  • run(): Promise<void>

  • Run the node in standalone mode. Returns when the node is closed.

    Returns Promise<void>

set

  • set(values): Promise<void>

  • Update state values. This is a patch operation; it only modifies properties in values.

    values is an object with a Behavior.id as the key and state values as sub-objects.

    Input values must adhere to the Behavior.schema of the target Behavior. If not, set will throw an error.

    This is a transactional operation. An error results in no change. The endpoint will wait for exclusive access before applying changes.

    Parameters

    Returns Promise<void>

setStateOf

  • setStateOf<T>(type, values): Promise<void>

  • Update state values for a single behavior.

    The patch semantics used here are identical to set.

    Type Parameters

    Parameters

    Returns Promise<void>

start

  • start(): Promise<void>

  • Bring the node online.

    Returns Promise<void>

stateOf

  • stateOf<T>(type): Immutable<InstanceType<T["State"]>>

  • Current state for a specific behavior.

    Type Parameters

    Parameters

    • type: T

    Returns Immutable<InstanceType<T["State"]>>

ProtectedstatusUpdate

  • statusUpdate(message): void

  • Parameters

    • message: string

    Returns void

toString

  • toString(): string

  • Returns string

visit

  • visit<T>(visitor): T

  • Apply a depth-first visitor function to myself and all descendents.

    Type Parameters

    • T extends void | PromiseLike<void>

    Parameters

    Returns T

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods