Ring Buffer API
#include "src/btstack_ring_buffer.h"
btstack_ring_buffer_init
void btstack_ring_buffer_init(btstack_ring_buffer_t * ring_buffer, uint8_t * storage, uint32_t storage_size);
Init ring buffer
Parameters
- ring_buffer: object
- storage
- storage_size: in bytes
btstack_ring_buffer_reset
void btstack_ring_buffer_reset(btstack_ring_buffer_t * ring_buffer);
Reset ring buffer to initial state (empty)
Parameters
- ring_buffer: object
btstack_ring_buffer_empty
int btstack_ring_buffer_empty(btstack_ring_buffer_t * ring_buffer);
Check if ring buffer is empty
Parameters
- ring_buffer: object
Returns
- int: TRUE if empty
btstack_ring_buffer_bytes_available
uint32_t btstack_ring_buffer_bytes_available(btstack_ring_buffer_t * ring_buffer);
Get number of bytes available for read
Parameters
- ring_buffer: object
Returns
- uint32_t: number of bytes available for read
btstack_ring_buffer_bytes_free
uint32_t btstack_ring_buffer_bytes_free(btstack_ring_buffer_t * ring_buffer);
Get free space available for write
Parameters
- ring_buffer: object
Returns
- uint32_t: number of bytes available for write
btstack_ring_buffer_write
int btstack_ring_buffer_write(btstack_ring_buffer_t * ring_buffer, const uint8_t* data, uint32_t data_length);
Write bytes into ring buffer
Parameters
- ring_buffer: object
- data: to store
- data_length
Returns
- int: 0 if ok, ERROR_CODE_MEMORY_CAPACITY_EXCEEDED if not enough space in buffer
btstack_ring_buffer_read
void btstack_ring_buffer_read(btstack_ring_buffer_t * ring_buffer, uint8_t * buffer, uint32_t length, uint32_t * number_of_bytes_read);
Read from ring buffer
Parameters
- ring_buffer: object
- buffer: to store read data
- length: to read
- number_of_bytes_read