Persistent state for incremental USHER UART frame parsing. More...
#include <usher_protocol.h>
Data Fields | |
| uint8_t | payload [256] |
| uint8_t | error |
| uint8_t | msg_id |
| bool | msg_received |
| uint8_t | payload_len |
| uint8_t | status |
| uint8_t | payload_idx |
| uint8_t | ck_a |
| uint8_t | ck_b |
Detailed Description
Persistent state for incremental USHER UART frame parsing.
One instance must remain associated with one ordered byte stream. A completed message remains in payload until its consumer clears msg_received; feeding later bytes before that acknowledgement is counted as an error to avoid silently overwriting it.
Definition at line 415 of file usher_protocol.h.
Field Documentation
◆ ck_a
| uint8_t usher_transport::ck_a |
Running Fletcher-style checksum accumulators for the in-progress frame.
Definition at line 431 of file usher_protocol.h.
◆ ck_b
| uint8_t usher_transport::ck_b |
Definition at line 431 of file usher_protocol.h.
◆ error
| uint8_t usher_transport::error |
Count of framing or checksum faults observed while consuming this stream.
Definition at line 419 of file usher_protocol.h.
◆ msg_id
| uint8_t usher_transport::msg_id |
Message identifier from the current or most recently completed frame.
Definition at line 421 of file usher_protocol.h.
◆ msg_received
| bool usher_transport::msg_received |
True when payload contains one complete validated message awaiting dispatch.
Definition at line 423 of file usher_protocol.h.
◆ payload
| uint8_t usher_transport::payload[256] |
Storage for the validated payload of the most recently completed message.
Definition at line 417 of file usher_protocol.h.
◆ payload_idx
| uint8_t usher_transport::payload_idx |
Internal offset into payload while a frame is being assembled.
Definition at line 429 of file usher_protocol.h.
◆ payload_len
| uint8_t usher_transport::payload_len |
Number of payload bytes expected in the current frame.
Definition at line 425 of file usher_protocol.h.
◆ status
| uint8_t usher_transport::status |
Internal parser state: the next expected position in the frame.
Definition at line 427 of file usher_protocol.h.
The documentation for this struct was generated from the following file:
- src/usher_protocol.h