circular_buffer.c File Reference

#include "circular_buffer.h"
#include <string.h>

Include dependency graph for circular_buffer.c:

Go to the source code of this file.

Functions
void	circular_buffer_init (struct circular_buffer *cb, uint8_t *buffer, size_t len)
	initialize a circular buffer. More...
int	circular_buffer_get (struct circular_buffer *cb, uint8_t *buf, size_t len)
	copy the next buffer available in cb to buf. More...
int	circular_buffer_put (struct circular_buffer *cb, uint8_t *buf, size_t len)
	Copy buf in the circular buffer. More...

Function Documentation

circular_buffer_get()

int circular_buffer_get	(	struct circular_buffer *	cb,
		uint8_t *	buf,
		size_t	len
	)

copy the next buffer available in cb to buf.

Parameters

cb	The circular buffer
buf	destination buffer
len	size of buf

Returns

Size of the data copied to buf, or an error code if negative.

Definition at line 22 of file circular_buffer.c.

References circular_buffer::_buf, circular_buffer::_buf_len, CIR_ERROR_BUFFER_TOO_SMALL, CIR_ERROR_NO_MSG, circular_buffer::read_offset, and circular_buffer::write_offset.

Referenced by sts3032_event().

Here is the caller graph for this function:

circular_buffer_init()

void circular_buffer_init	(	struct circular_buffer *	cb,
		uint8_t *	buffer,
		size_t	len
	)

initialize a circular buffer.

Parameters

cb	circular_buffer structure
buffer	buffer used internally by the circular buffer
len	size of buffer

Definition at line 13 of file circular_buffer.c.

References circular_buffer::_buf, circular_buffer::_buf_len, circular_buffer::read_offset, and circular_buffer::write_offset.

Referenced by actuators_sts3032_init().

Here is the caller graph for this function:

circular_buffer_put()

int circular_buffer_put	(	struct circular_buffer *	cb,
		uint8_t *	buf,
		size_t	len
	)

Copy buf in the circular buffer.

Parameters

cb	The circular buffer
buf	source buffer
len	Size of buf

Returns

0 on success, Error code if negative

len == available is invalid because it will cause write_offset to ne equal to read_offset, which is considered an empty buffer.

Definition at line 51 of file circular_buffer.c.

References circular_buffer::_buf, circular_buffer::_buf_len, CIR_ERROR_NO_SPACE_AVAILABLE, circular_buffer::read_offset, and circular_buffer::write_offset.

Referenced by write_buf().

Here is the caller graph for this function: