ieee802154::RingBuffer Class Reference

Efficient ring buffer for storing frame data. More...

#include <RingBuffer.h>

Public Member Functions
int	available () const
int	availableForWrite () const
void	clear ()
bool	isEmpty () const
bool	isFull () const
bool	peek (uint8_t &out) const
int	read ()
int	readArray (uint8_t *dest, size_t len)
void	resize (size_t new_size)
	RingBuffer (int size=128)
size_t	size () const
bool	write (uint8_t byte)
int	writeArray (const uint8_t *data, size_t len)

Detailed Description

Efficient ring buffer for storing frame data.

Implements a FIFO circular buffer for byte storage and retrieval. Used internally by ESP32TransceiverStream for TX and RX buffering. Supports push, read, peek, and bulk operations with minimal memory movement.

• Data is written at the tail and read from the head.
• Buffer automatically wraps around when full.
• Provides methods for available space, bulk read/write, and peeking.

Copyright

GPLv3

Constructor & Destructor Documentation

RingBuffer()

ieee802154::RingBuffer::RingBuffer ( int  size = 128 )

inline

Member Function Documentation

available()

int ieee802154::RingBuffer::available ( ) const

inline

availableForWrite()

int ieee802154::RingBuffer::availableForWrite ( ) const

inline

clear()

void ieee802154::RingBuffer::clear ( )

inline

isEmpty()

bool ieee802154::RingBuffer::isEmpty ( ) const

inline

isFull()

bool ieee802154::RingBuffer::isFull ( ) const

inline

peek()

bool ieee802154::RingBuffer::peek ( uint8_t &  out ) const

inline

read()

int ieee802154::RingBuffer::read ( )

inline

readArray()

int ieee802154::RingBuffer::readArray ( uint8_t *  dest, size_t  len  )

inline

resize()

void ieee802154::RingBuffer::resize ( size_t  new_size )

inline

size()

size_t ieee802154::RingBuffer::size ( ) const

inline

write()

bool ieee802154::RingBuffer::write ( uint8_t  byte )

inline

writeArray()

int ieee802154::RingBuffer::writeArray ( const uint8_t *  data, size_t  len  )

inline

---

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

• src/RingBuffer.h