tr_ring_buffer.h File Reference

#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>

Include dependency graph for tr_ring_buffer.h:

Go to the source code of this file.

Data Structures
struct	tr_ring_buffer_t
	Ring buffer object definition. More...

Functions
bool	tr_ring_buffer_init (tr_ring_buffer_t *p_rb)
bool	tr_ring_buffer_write (tr_ring_buffer_t *p_rb, uint8_t data)
size_t	tr_ring_buffer_read (tr_ring_buffer_t *p_rb, uint8_t *p_data, size_t length)
size_t	tr_ring_buffer_get_available (tr_ring_buffer_t *p_rb)

Detailed Description

A simple ring buffer for handling transfer of bytes.

The ring buffer supports a buffer of up to 256 bytes.

SPDX-License-Identifier: LicenseRef-TridentMSLA SPDX-FileCopyrightText: 2024 Trident IoT, LLC https://www.tridentiot.com