slip_rx_state Struct Reference

Detailed Description

Structure used to contain the current state for the SLIP receiver.

For forward compatibility, instances of this structure should be initialized using SLIP_RX_STATE_INIT. For dynamic initialization use slip_rx_state_reinit().

For example:

// Buffer for SLIP processing on receive path.
uint8_t slip_rx_buffer[SLIP_RX_BUFFER_SIZE];
// State data for SLIP processing on receive path.
struct slip_rx_state slip_rx = SLIP_RX_STATE_INIT(slip_rx_buffer, sizeof(slip_rx_buffer));

Definition at line 42 of file slip.h.

#include <slip.h>

Data Fields
uint8_t *	buffer
	Reference to buffer where processed bytes are received. More...
size_t	buffer_length
	Length of the buffer. More...
size_t	length
	Length of the currently received frame, excluding escape bytes. More...
bool	escape
	Escape state. More...

Field Documentation

buffer

uint8_t* slip_rx_state::buffer

Reference to buffer where processed bytes are received.

Definition at line 44 of file slip.h.

buffer_length

size_t slip_rx_state::buffer_length

Length of the buffer.

Definition at line 45 of file slip.h.

escape

bool slip_rx_state::escape

Escape state.

Definition at line 47 of file slip.h.

length

size_t slip_rx_state::length

Length of the currently received frame, excluding escape bytes.

Definition at line 46 of file slip.h.

---

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

• slip.h