ring_buf/ring__buf__yield_8h_source.html

/*

 * SPDX-License-Identifier: MIT

 * SPDX-FileCopyrightText: 2024, Roy Ratcliffe, Northumberland, United Kingdom

 */

#ifndef __RING_BUF_YIELD_H__

#define __RING_BUF_YIELD_H__


#include "ring_buf.h"


int ring_buf_get_claim_yield(struct ring_buf *buf, ring_buf_size_t size,

                             int yield(void *space, int index, void *extra),

                             void *extra);


int ring_buf_get_yield(struct ring_buf *buf, void *data, ring_buf_size_t size,

                       int yield(void *data, int index, void *extra),

                       void *extra);


#endif /* __RING_BUF_YIELD_H__ */

ring_buf.h
Ring buffer function prototypes.

ring_buf_size_t
size_t ring_buf_size_t
Ring buffer size type.
Definition ring_buf.h:64

ring_buf_get_yield
int ring_buf_get_yield(struct ring_buf *buf, void *data, ring_buf_size_t size, int yield(void *data, int index, void *extra), void *extra)
Copies buffer space and yields it to a callback function.
Definition ring_buf_yield.c:53

ring_buf_get_claim_yield
int ring_buf_get_claim_yield(struct ring_buf *buf, ring_buf_size_t size, int yield(void *space, int index, void *extra), void *extra)
Claims ring buffer space and yields it to a callback function.
Definition ring_buf_yield.c:34

ring_buf
Ring buffer instance.
Definition ring_buf.h:128