#include <ErrorHistory.h>
Inheritance diagram for hf::ErrorHistoryReader< Record >:
Public Member Functions | |
| virtual | ~ErrorHistoryReader () noexcept=default |
| virtual std::size_t | Size () const noexcept=0 |
| Number of entries currently held (≤ Capacity()). | |
| virtual std::size_t | Capacity () const noexcept=0 |
| Maximum number of entries the ring can hold. | |
| virtual uint32_t | Seq () const noexcept=0 |
Monotonic counter; bumps on every successful Push / Pop / Clear. | |
| virtual uint32_t | OverwriteCount () const noexcept=0 |
Number of Push calls that overwrote an older entry. | |
| virtual std::size_t | Snapshot (Record *out, std::size_t max_out) const noexcept=0 |
Copy up to max_out records into out, oldest first. | |
Constructor & Destructor Documentation
◆ ~ErrorHistoryReader()
template<typename Record >
|
virtualdefaultnoexcept |
Member Function Documentation
◆ Capacity()
template<typename Record >
|
pure virtualnoexcept |
Maximum number of entries the ring can hold.
Implemented in hf::ErrorHistory< Record, kCapacity >.
◆ OverwriteCount()
template<typename Record >
|
pure virtualnoexcept |
Number of Push calls that overwrote an older entry.
Implemented in hf::ErrorHistory< Record, kCapacity >.
◆ Seq()
template<typename Record >
|
pure virtualnoexcept |
Monotonic counter; bumps on every successful Push / Pop / Clear.
Implemented in hf::ErrorHistory< Record, kCapacity >.
◆ Size()
template<typename Record >
|
pure virtualnoexcept |
Number of entries currently held (≤ Capacity()).
Implemented in hf::ErrorHistory< Record, kCapacity >.
◆ Snapshot()
template<typename Record >
|
pure virtualnoexcept |
Copy up to max_out records into out, oldest first.
- Returns
- Number of records actually copied.
Implemented in hf::ErrorHistory< Record, kCapacity >.
The documentation for this class was generated from the following file:
