Skip to main content

Module node

Module node 

Source
Expand description

A node’s tree of endpoints and clusters, and what a wildcard path expands to (Core §7.2, §8.2.1.6).

A node is a fixed set of endpoints; each endpoint is a fixed set of cluster instances. “Fixed” is the point: Node borrows slices of const descriptors rather than owning anything, so the whole shape of a device lives in flash and costs no RAM.

§Expansion is the whole of §8.2.1.6

Each path in the list that is a Wildcard Path SHALL be expanded into a complete list of existent paths. This is done by generating all permutations where the wildcarded elements are replaced with existent elements.

and, in the same section, the sentence that decides the shape of this module:

This process does not check access qualities, such as read or write access, privileges, or fabric qualities.

So Node::expand yields every path that exists, and says nothing about whether the caller may have it. Access is applied afterwards, and §8.4.3.2 is precise about why the order matters: a concrete path that fails a check produces an AttributeStatusIB naming the failure, while an expanded path that fails one is “discarded” silently. A client that asked for a specific attribute learns it may not have it; a client that asked for everything simply does not see it. Merging the two would leak the shape of a node to a subject with no privilege over it.

Structs§

Endpoint
One endpoint: a set of cluster instances (§7.2).
Expand
The paths a wildcard names, produced one at a time.
ExpandCommands
The commands a wildcard path names, produced one at a time.
ExpandCursor
How far a wildcard expansion got, so the next message can carry on from there.
Node
A node’s data model: its endpoints and everything on them.
Resolved
One path that exists on a node, with the descriptors it resolves to.
ResolvedCommand
One command that exists on a node, with the descriptors it resolves to.
ResolvedEvent
One event that exists on a node, with the descriptors it resolves to.

Enums§

Malformed
Why a node’s descriptors are not usable.
Missing
Which level of a concrete path was not found (§8.4.3.2).
MissingCommand
Which level of a concrete command path was not found (§8.8.2.3).