ra8_c6link_rx_view Struct Reference

Where the payload of a classified frame is, and what it claims to be. More...

#include <ra8_c6link_internal.h>

Data Fields
uint16_t	offset
	Byte offset of the payload within the transaction.
uint16_t	len
	Payload length in bytes.
uint8_t	if_type
	Interface type from the header.
uint8_t	if_num
	Interface number from the header.

Detailed Description

Where the payload of a classified frame is, and what it claims to be.

Filled only when the classifier returns k_ra8_c6link_frame_data. Holds offsets rather than a pointer so it cannot outlive the buffer it describes.

Invariant

offset equals k_ra8_c6link_header_bytes for any data frame.

offset + len never exceeds k_ra8_c6link_frame_bytes.

Example:

const uint8_t* payload = &rx[view.offset];

See also

ra8_c6link_frame_class_t

Since

0.1.0

Definition at line 99 of file ra8_c6link_internal.h.

Field Documentation

if_num

uint8_t ra8_c6link_rx_view::if_num

Interface number from the header.

Definition at line 103 of file ra8_c6link_internal.h.

Referenced by priv_c6link_frame_classify().

if_type

uint8_t ra8_c6link_rx_view::if_type

Interface type from the header.

Definition at line 102 of file ra8_c6link_internal.h.

Referenced by priv_c6link_dispatch(), and priv_c6link_frame_classify().

len

uint16_t ra8_c6link_rx_view::len

Payload length in bytes.

Definition at line 101 of file ra8_c6link_internal.h.

Referenced by priv_c6link_dispatch(), and priv_c6link_frame_classify().

offset

uint16_t ra8_c6link_rx_view::offset

Byte offset of the payload within the transaction.

Definition at line 100 of file ra8_c6link_internal.h.

Referenced by priv_c6link_dispatch(), and priv_c6link_frame_classify().

---

The documentation for this struct was generated from the following file:

• libs/ra8_c6link/src/ra8_c6link_internal.h