Module session

Module session 

Source
Expand description

The ULCP session state machine.

Structs§

AlertConfig
How this board serves PROP_ALERT.
BatteryFields
Which battery measurements the platform is capable of reporting through PROP_BATTERY. Fixed for the life of a session: these bits bound the field-flags octet of every snapshot.
GnssConfig
That this board has a GNSS receiver (CAP_GNSS).
RadioSettings
Radio configuration owned by the session and pushed to the radio via Effect::ApplyRadio.
Session
SessionConfig
Fixed properties of the device this session runs on.
TimeConfig
That this board keeps a wall clock (CAP_TIME).

Enums§

Effect
A radio side effect for the caller to execute.
IdentitySource
A staged PROP_DEV_PRIVATE_KEY provisioning request (see Effect::ProvisionIdentity).
SavedStatus
What PROP_SAVED reports about the stored snapshot.
SnapshotError
Why a stored snapshot payload was rejected. Rejection is never silent: the boot path walks back a generation and reports through PROP_SAVED (spec §Saved State).
TxOutcome
Physical-radio outcome of the transmit started by Effect::StartTransmit, reported via Session::on_tx_result.
TxPower
Transmit power selection for one pending transmit.

Constants§

DEFAULT_IDENT_PRECISION
Post-reset value of PROP_GNSS_IDENT_PRECISION: a ~38 × 19 m cell, fine enough to place a node on a street and coarse enough not to place it in a room.
MAX_CHANNEL_KEYS
Maximum number of PROP_HOST_CHANNEL_KEYS entries.
MAX_DEVICE_NAME_LEN
Maximum UTF-8 byte length of PROP_DEV_NAME.
MAX_DEV_PEERS
Maximum number of PROP_DEV_PEERS entries.
MAX_IDENT_PRECISION
Largest PROP_GNSS_IDENT_PRECISION, matching the location encoding’s own maximum.
MAX_MTU
Largest radio payload the session can carry (SX126x-class limit).
MAX_PEER_KEYS
Maximum number of PROP_HOST_PEER_KEYS entries.
MAX_REPEATER_REGIONS
Maximum number of PROP_MAC_REPEATER_REGIONS entries. Matches the MAC’s own repeater region capacity, so any value this session accepts fits the forwarding policy it ends up configuring.
MAX_RX_FILTERS
Maximum number of explicit PROP_HOST_RX_FILTERS entries.
PRIVATE_KEY_LEN
Ed25519 private keys are 32 octets, like public keys.
RX_QUEUE_CAPACITY
PROP_HOST_RX_QUEUE_CAPACITY: the fixed size of the inbound queue.
SNAPSHOT_MAX
Largest encoded snapshot the session produces (see Session::encode_snapshot); sized for every table at capacity with headroom for future properties.