https://github.com/AndersKaloer/Ring-Buffer

A simple ring buffer (circular buffer) designed for embedded systems.
https://github.com/AndersKaloer/Ring-Buffer

buffer c circular-buffer circularbuffer ring-buffer ringbuffer

Last synced: 2 months ago
JSON representation

A simple ring buffer (circular buffer) designed for embedded systems.

• Host: GitHub
• URL: https://github.com/AndersKaloer/Ring-Buffer
• Owner: AndersKaloer
• License: mit
• Created: 2014-02-04T21:06:34.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2023-12-01T07:36:28.000Z (about 1 year ago)
• Last Synced: 2024-02-17T06:35:03.594Z (12 months ago)
• Topics: buffer, c, circular-buffer, circularbuffer, ring-buffer, ringbuffer
• Language: C
• Size: 121 KB
• Stars: 454
• Watchers: 16
• Forks: 174
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Ring-Buffer

===========

A simple ring buffer (circular buffer) designed for embedded systems.

An example is given in [examples/simple.c](examples/simple.c).

The size of the memory buffer must be a power-of-two, and the ring buffer can contain at most `buf_size-1` bytes.

A new ring buffer is created using the ` ring_buffer_init(&ring_buffer, buff, sizeof(buff))` function:

```c

char buff[64];

ring_buffer_t ring_buffer;

ring_buffer_init(&ring_buffer, buff, sizeof(buff));

```

In this case, the buffer size is 64 bytes and the ring buffer can contain 63 bytes.

The module provides the following functions for accessing the ring buffer (documentation can be found in [ringbuffer.h](ringbuffer.h)):

```c

void ring_buffer_queue(ring_buffer_t *buffer, char data);

void ring_buffer_queue_arr(ring_buffer_t *buffer, const char *data, ring_buffer_size_t size);

uint8_t ring_buffer_dequeue(ring_buffer_t *buffer, char *data);

ring_buffer_size_t ring_buffer_dequeue_arr(ring_buffer_t *buffer, char *data, ring_buffer_size_t len);

uint8_t ring_buffer_peek(ring_buffer_t *buffer, char *data, ring_buffer_size_t index);

uint8_t ring_buffer_is_empty(ring_buffer_t *buffer);

uint8_t ring_buffer_is_full(ring_buffer_t *buffer);

ring_buffer_size_t ring_buffer_num_items(ring_buffer_t *buffer);

```