Zephyr Project API 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches

Opaque iterator state for zms_iter_next and zms_iter_next_all. More...

#include <zms.h>

Data Fields

uint64_t walk_addr
 Current walk address in the ATE ring.
uint64_t end_addr
 Snapshot of ate_wra taken at iterator initialization time.
zms_id_t mask_id
 ID mask used to filter returned entries.
zms_id_t min_id
 Inclusive minimum ID accepted by the iterator.
zms_id_t max_id
 Inclusive maximum ID accepted by the iterator.
zms_iter_predicate_t predicate_func
 Optional callback used to filter IDs.
bool exhausted
 True once the walk has completed the full ring.
int previous_sector_num
 Sector of the last ATE seen, cached to avoid re-reading the cycle below every step.
uint8_t current_cycle
 Cycle count of the sector identified by previous_sector_num.

Detailed Description

Opaque iterator state for zms_iter_next and zms_iter_next_all.

Must be initialised with zms_iter_init or zms_iter_init_with_config before use. Do not access fields directly.

Field Documentation

◆ current_cycle

uint8_t zms_iter::current_cycle

Cycle count of the sector identified by previous_sector_num.

◆ end_addr

uint64_t zms_iter::end_addr

Snapshot of ate_wra taken at iterator initialization time.

◆ exhausted

bool zms_iter::exhausted

True once the walk has completed the full ring.

◆ mask_id

zms_id_t zms_iter::mask_id

ID mask used to filter returned entries.

◆ max_id

zms_id_t zms_iter::max_id

Inclusive maximum ID accepted by the iterator.

◆ min_id

zms_id_t zms_iter::min_id

Inclusive minimum ID accepted by the iterator.

◆ predicate_func

zms_iter_predicate_t zms_iter::predicate_func

Optional callback used to filter IDs.

◆ previous_sector_num

int zms_iter::previous_sector_num

Sector of the last ATE seen, cached to avoid re-reading the cycle below every step.

◆ walk_addr

uint64_t zms_iter::walk_addr

Current walk address in the ATE ring.


The documentation for this struct was generated from the following file:
  • include/zephyr/kvss/zms.h