ring_buf_circ.h File Reference

Circular ring buffer function prototypes. More...

#include <stddef.h>

Include dependency graph for ring_buf_circ.h:

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

Go to the source code of this file.

Functions
int	ring_buf_put_circ (struct ring_buf *buf, void *data, size_t size)
	Put data into a circular buffer.

Detailed Description

Circular ring buffer function prototypes.

Declares functions for putting data into a circular ring buffer.

Copyright

2024, 2025, Roy Ratcliffe, Northumberland, United Kingdom

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Definition in file ring_buf_circ.h.

Function Documentation

ring_buf_put_circ()

int ring_buf_put_circ	(	struct ring_buf *	buf,
		void *	data,
		size_t	size
	)

Put data into a circular buffer.

If the buffer is full, removes the oldest data to make space.

Parameters

buf	Ring buffer.
data	Address of bytes to put.
size	Number of bytes to put.

Returns

0 on success, -EMSGSIZE if the data will not fit.

Note

Uses ring_buf_get rather than ring_buf_get_claim, as the former handles discontiguous items. They amount to the same thing when the buffer size is a multiple of the item size.

Definition at line 42 of file ring_buf_circ.c.