#include <stdint.h>

Include dependency graph for circbuf.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	_circ_buf_

Typedefs
typedef struct _circ_buf_	CircBuffer

Functions
void	AuAdvancePointer (CircBuffer *cbuf)
	AuAdvancePointer – advances the pointer of the buffer.

void	AuRetreatPointer (CircBuffer *cbuf)
	AuRetreatPointer – retreat the pointer of the buffer.

void	AuCircBufReset (CircBuffer *cbuf)
	AuCircBufReset – reset the entire buffer.

CircBuffer *	AuCircBufInitialise (uint8_t *buffer, size_t sz)
	AuCircBufInitialise – initialise a new circular buffer.

void	AuCircBufFree (CircBuffer *cbuf)
	AuCircBufFree – free a circular buffer.

size_t	AuCircBufSize (CircBuffer *cbuf)
	AuCircBufSize – returns the circular buffer size.

size_t	AuCircBufCapacity (CircBuffer *cbuf)
	AuCircBufCapacity – returns the circular buffer capacity.

void	AuCircBufPutData (CircBuffer *cbuf, uint8_t data)
	AuCircBufPutData – puts a data to circular buffer.

int	AuCircBufPut (CircBuffer *cbuf, uint8_t data)
	AuCircBufPut – puts data onto circular buffer.

int	AuCircBufGet (CircBuffer cbuf, uint8_t data)
	AuCircBufGet – gets a data from circular buffer.

bool	CircBufEmpty (CircBuffer *cbuf)
	CircBufEmpty – checks if the circular buffer is empty.

bool	CircBufFull (CircBuffer *cbuf)
	CircBufFull – checks if the circular buffer is full.

Typedef Documentation

◆ CircBuffer

typedef struct _circ_buf_ CircBuffer

BSD 2-Clause License

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Function Documentation

◆ AuAdvancePointer()

void AuAdvancePointer ( CircBuffer * cbuf )

extern

AuAdvancePointer – advances the pointer of the buffer.

BSD 2-Clause License

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Parameters

cbuf	– Pointer to the circular buffer

◆ AuCircBufCapacity()

size_t AuCircBufCapacity ( CircBuffer * cbuf )

extern

AuCircBufCapacity – returns the circular buffer capacity.

◆ AuCircBufFree()

void AuCircBufFree ( CircBuffer * cbuf )

extern

AuCircBufFree – free a circular buffer.

Parameters

cbuf	– Pointer to the circular buffer to free

◆ AuCircBufGet()

int AuCircBufGet	(	CircBuffer *	cbuf,
		uint8_t *	data
	)

extern

AuCircBufGet – gets a data from circular buffer.

Parameters

cbuf	– Pointer to the circular buffer
data	– Pointer to the buffer where to put the data

◆ AuCircBufInitialise()

CircBuffer * AuCircBufInitialise	(	uint8_t *	buffer,
		size_t	sz
	)

extern

AuCircBufInitialise – initialise a new circular buffer.

Parameters

buffer	– Pointer to the actual buffer pointer
sz	– size of the buffer

◆ AuCircBufPut()

int AuCircBufPut	(	CircBuffer *	cbuf,
		uint8_t	data
	)

extern

AuCircBufPut – puts data onto circular buffer.

Parameters

cbuf	– Pointer to the circular buffer
data	– data to put

◆ AuCircBufPutData()

void AuCircBufPutData	(	CircBuffer *	cbuf,
		uint8_t	data
	)

extern

AuCircBufPutData – puts a data to circular buffer.

Parameters

cbuf--	Pointer to the circular buffer
data	– data to put

◆ AuCircBufReset()

void AuCircBufReset ( CircBuffer * cbuf )

extern

AuCircBufReset – reset the entire buffer.

Parameters

cbuf	– Pointer to the circular buffer

◆ AuCircBufSize()

size_t AuCircBufSize ( CircBuffer * cbuf )

extern

AuCircBufSize – returns the circular buffer size.

Parameters

cbuf	– Pointer to the circular buffer size

◆ AuRetreatPointer()

void AuRetreatPointer ( CircBuffer * cbuf )

extern

AuRetreatPointer – retreat the pointer of the buffer.

Parameters

cbuf	– Pointer to the circular buffer

◆ CircBufEmpty()

bool CircBufEmpty ( CircBuffer * cbuf )

extern

CircBufEmpty – checks if the circular buffer is empty.

Parameters

cbuf	– Pointer to the circular buffer

◆ CircBufFull()

bool CircBufFull ( CircBuffer * cbuf )

extern

CircBufFull – checks if the circular buffer is full.

Parameters

cbuf	– Pointer to the circular buffer

Classes

Typedefs

Functions

Typedef Documentation

◆ CircBuffer

Function Documentation

◆ AuAdvancePointer()

◆ AuCircBufCapacity()

◆ AuCircBufFree()

◆ AuCircBufGet()

◆ AuCircBufInitialise()

◆ AuCircBufPut()

◆ AuCircBufPutData()

◆ AuCircBufReset()

◆ AuCircBufSize()

◆ AuRetreatPointer()

◆ CircBufEmpty()

◆ CircBufFull()