Ring Buffer

Ring buffer. More...

Collaboration diagram for Ring Buffer:

Detailed Description

Ring buffer.

Data Structures
struct	ring_t
	Ring buffer structure. More...

Macros
#define	RING_CREATE(bufferPtr, bufferSize)    {.buffer = bufferPtr, .size = bufferSize, .readIndex = 0, .writeIndex = 0, .dataLength = 0}
	Create a ring buffer initializer.

Functions
static void	ring_init (ring_t *ring, void *buffer, uint64_t size)
	Initialize a ring buffer.
static uint64_t	ring_data_length (const ring_t *ring)
	Get the length of data currently stored in the ring buffer.
static uint64_t	ring_free_length (const ring_t *ring)
	Get the length of free space in the ring buffer.
static uint64_t	ring_write (ring_t *ring, const void *buffer, uint64_t count)
	Write data to the ring buffer.
static uint64_t	ring_read (ring_t *ring, void *buffer, uint64_t count)
	Read data from the ring buffer.
static uint64_t	ring_read_at (const ring_t *ring, uint64_t offset, void *buffer, uint64_t count)
	Read data from the ring buffer at a specific offset without modifying the read index.
static void	ring_move_read_forward (ring_t *ring, uint64_t offset)
	Move the read index forward by a specified offset.
static uint64_t	ring_get_byte (const ring_t *ring, uint64_t offset, uint8_t *byte)
	Get a byte from the ring buffer at a specific offset without modifying the read index.

Macro Definition Documentation

RING_CREATE

#define RING_CREATE	(		bufferPtr,
			bufferSize
	)		{.buffer = bufferPtr, .size = bufferSize, .readIndex = 0, .writeIndex = 0, .dataLength = 0}

Create a ring buffer initializer.

Parameters

bufferPtr	Pointer to the buffer memory.
bufferSize	Size of the buffer memory in bytes.

Definition at line 33 of file ring.h.

Function Documentation

ring_init()

static void ring_init ( ring_t *  ring, void *  buffer, uint64_t  size  )

inlinestatic

Initialize a ring buffer.

Parameters

ring	Pointer to the ring buffer to initialize.
buffer	Pointer to the buffer memory.
size	Size of the buffer memory in bytes.

Definition at line 43 of file ring.h.

Here is the caller graph for this function:

ring_data_length()

static uint64_t ring_data_length ( const ring_t *  ring )

inlinestatic

Get the length of data currently stored in the ring buffer.

Parameters

ring	Pointer to the ring buffer.

Returns

Length of data in bytes.

Definition at line 58 of file ring.h.

Here is the caller graph for this function:

ring_free_length()

static uint64_t ring_free_length ( const ring_t *  ring )

inlinestatic

Get the length of free space in the ring buffer.

Parameters

ring	Pointer to the ring buffer.

Returns

Length of free space in bytes.

Definition at line 69 of file ring.h.

Here is the caller graph for this function:

ring_write()

static uint64_t ring_write ( ring_t *  ring, const void *  buffer, uint64_t  count  )

inlinestatic

Write data to the ring buffer.

If the data to be written exceeds the free space in the buffer, the oldest data will be overwritten.

Parameters

ring	Pointer to the ring buffer.
buffer	Pointer to the data to write.
count	Number of bytes to write.

Returns

Number of bytes written.

Definition at line 85 of file ring.h.

Here is the call graph for this function:

Here is the caller graph for this function:

ring_read()

static uint64_t ring_read ( ring_t *  ring, void *  buffer, uint64_t  count  )

inlinestatic

Read data from the ring buffer.

Parameters

ring	Pointer to the ring buffer.
buffer	Pointer to the buffer to store the read data.
count	Number of bytes to read.

Returns

Number of bytes read, or ERR if not enough data is available.

Definition at line 121 of file ring.h.

Here is the call graph for this function:

Here is the caller graph for this function:

ring_read_at()

static uint64_t ring_read_at ( const ring_t *  ring, uint64_t  offset, void *  buffer, uint64_t  count  )

inlinestatic

Read data from the ring buffer at a specific offset without modifying the read index.

Parameters

ring	Pointer to the ring buffer.
offset	Offset from the current read index to start reading.
buffer	Pointer to the buffer to store the read data.
count	Number of bytes to read.

Returns

Number of bytes read, or 0 if offset is out of bounds.

Definition at line 156 of file ring.h.

Here is the call graph for this function:

Here is the caller graph for this function:

ring_move_read_forward()

static void ring_move_read_forward ( ring_t *  ring, uint64_t  offset  )

static

Move the read index forward by a specified offset.

If the offset exceeds the current data length, no action is taken.

Parameters

ring	Pointer to the ring buffer.
offset	Number of bytes to move the read index forward.

Definition at line 191 of file ring.h.

Here is the call graph for this function:

Here is the caller graph for this function:

ring_get_byte()

static uint64_t ring_get_byte ( const ring_t *  ring, uint64_t  offset, uint8_t *  byte  )

inlinestatic

Get a byte from the ring buffer at a specific offset without modifying the read index.

Parameters

ring	Pointer to the ring buffer.
offset	Offset from the current read index to get the byte.
byte	Pointer to store the retrieved byte.

Returns

0 on success, or ERR if offset is out of bounds.

Definition at line 210 of file ring.h.

Here is the caller graph for this function: