HDLC_FRAME_T Struct Reference

Generic HDLC frame buffer descriptor. More...

#include <hdlc_common.h>

Data Fields
uint8_t *	payload
size_t	length
size_t	capacity

Detailed Description

Generic HDLC frame buffer descriptor.

Definition at line 37 of file hdlc_common.h.

Field Documentation

capacity

size_t HDLC_FRAME_T::capacity

Maximum number of bytes writable to payload.

Definition at line 44 of file hdlc_common.h.

Referenced by hdlc_encode(), hdlc_encode_byte(), hdlc_sync_acc_poll(), hdlc_sync_step_synced(), hdlc_sync_step_syncing(), tx_queue_drain(), and tx_queue_enqueue_udp_frame().

length

size_t HDLC_FRAME_T::length

Current number of valid bytes in payload.

Definition at line 42 of file hdlc_common.h.

Referenced by decode_hdlc_to_udp_tx(), drain_hdlc_frames_to_udp(), event_dispatch(), hdlc_decode(), hdlc_decode_byte(), hdlc_encode(), hdlc_encode_byte(), hdlc_get_bit(), hdlc_sync_reject_oversized_candidate(), hdlc_sync_step_hunting(), hdlc_sync_step_synced(), hdlc_sync_step_syncing(), poll_hdlc_idle_timeout(), poll_hdlc_no_progress(), print_status_event(), tx_queue_drain(), tx_queue_drain_bytes(), tx_queue_enqueue_udp_frame(), and tx_queue_is_empty().

payload

uint8_t* HDLC_FRAME_T::payload

Buffer containing encoded or decoded frame data.

Definition at line 40 of file hdlc_common.h.

Referenced by decode_hdlc_to_udp_tx(), event_dispatch(), hdlc_decode(), hdlc_decode_byte(), hdlc_encode(), hdlc_encode_byte(), hdlc_sync_acc_poll(), hdlc_sync_step_hunting(), hdlc_sync_step_synced(), hdlc_sync_step_syncing(), init_app(), poll_hdlc_idle_timeout(), poll_hdlc_no_progress(), tx_queue_drain(), tx_queue_drain_bytes(), and tx_queue_enqueue_udp_frame().

---

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

• hdlc_common.h