Expand description
Item codecs for the full protocol’s multi-value properties.
Each multi-value property defines an item form (what the host writes) and a digest form (what the device reports). The two differ exactly where the item form carries symmetric key material: digest forms never contain secrets. See “Multi-Value Properties” in the full ULCP spec.
Whole-table values concatenate items: fixed-size items back to back
(see fixed_items), or PUI-length-prefixed items for properties
documented with an item length prefix (see prefixed_items /
encode_prefixed_item). Single items carried by
CMD_PROP_INSERT/CMD_PROP_REMOVE are never length-prefixed; the
framing layer bounds them.
Structs§
- Peer
KeyEntry - One
PROP_HOST_PEER_KEYSentry in item form: the peer’s public key and the pairwise keys derived by the host. Secret-bearing — the digest form isSelf::public_keyalone. - Prefixed
Items
Enums§
- Filter
- One
PROP_HOST_RX_FILTERSentry. Item and digest forms are identical; the remove selector is the full item. - Item
Error
Constants§
- CHANNEL_
ID_ LEN - Length of a derived channel identifier (the digest form of a channel key).
- CHANNEL_
KEY_ LEN - Length of a channel key item (
PROP_HOST_CHANNEL_KEYS,PROP_DEV_CHANNEL_KEYS). - FILTER_
CHANNEL_ ID FILTER_TYPEfor a 2-octet channel-identifier filter.- FILTER_
DEST_ HINT FILTER_TYPEfor a 3-octet destination-hint filter.- FILTER_
PKT_ TYPE FILTER_TYPEfor a 1-octet FCF packet-type filter.- PUBLIC_
KEY_ LEN - Length of an Ed25519 public key (peer entries,
PROP_HOST_KEY,PROP_DEV_KEY). - REGION_
CODE_ LEN - Length of a routing-domain region code
(
PROP_MAC_REPEATER_REGIONS,PROP_MAC_REPEATER_DEFAULT_REGION, and the Supported Regions node-identity option they mirror).
Functions§
- encode_
prefixed_ item - Append one PUI-length-prefixed item to
out, returning the number of bytes written. - fixed_
items - Iterate the fixed-size items of a whole-table value with no item length prefix (channel keys, peer public keys, peer key entries).
- prefixed_
items - Iterate the PUI-length-prefixed items of a whole-table value
(properties documented with an item length prefix, such as
PROP_HOST_RX_FILTERS).