toxcore/toxav/ring_buffer.h

/* SPDX-License-Identifier: GPL-3.0-or-later
 * Copyright © 2016-2018 The TokTok team.
 * Copyright © 2013 Tox project.
 * Copyright © 2013 plutooo
 */
#ifndef C_TOXCORE_TOXAV_RING_BUFFER_H
#define C_TOXCORE_TOXAV_RING_BUFFER_H

#include <stdbool.h>
#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

/* Ring buffer */
typedef struct RingBuffer RingBuffer;
bool rb_full(const RingBuffer *b);
bool rb_empty(const RingBuffer *b);
void *rb_write(RingBuffer *b, void *p);
bool rb_read(RingBuffer *b, void **p);
RingBuffer *rb_new(int size);
void rb_kill(RingBuffer *b);
uint16_t rb_size(const RingBuffer *b);
uint16_t rb_data(const RingBuffer *b, void **dest);

#ifdef __cplusplus
}
#endif

#endif // C_TOXCORE_TOXAV_RING_BUFFER_H
Use spdx license identifier instead of GPL blurb. 2020-03-12 09:10:33 +08:00			`/* SPDX-License-Identifier: GPL-3.0-or-later`
Update copyright to 2018. 2018-08-26 07:36:42 +08:00			`* Copyright © 2016-2018 The TokTok team.`
Update license headers and remove redundant file name comment. "All rights reserved" was incorrect. The project was licensed under GPL3, which means a lot of rights are licensed to everybody in the world, i.e. not reserved to the "Tox Project". 2017-01-14 23:46:31 +08:00			`* Copyright © 2013 Tox project.`
			`* Copyright © 2013 plutooo`
			`*/`
Standardise header guards. Using the full path including the repo name. 2018-09-10 03:54:05 +08:00			`#ifndef C_TOXCORE_TOXAV_RING_BUFFER_H`
			`#define C_TOXCORE_TOXAV_RING_BUFFER_H`
Move ring buffer out of toxcore/util into toxav. Toxcore itself doesn't use this data structure. Only toxav does, so now toxav owns the code for it. 2016-09-22 22:20:33 +08:00
			`#include <stdbool.h>`
			`#include <stdint.h>`

Add some tests for our ring_buffer implementation. These can serve as documentation until we write actual api docs, probably using apidsl. 2018-07-04 02:14:36 +08:00			`#ifdef __cplusplus`
			`extern "C" {`
			`#endif`

Move ring buffer out of toxcore/util into toxav. Toxcore itself doesn't use this data structure. Only toxav does, so now toxav owns the code for it. 2016-09-22 22:20:33 +08:00			`/* Ring buffer */`
			`typedef struct RingBuffer RingBuffer;`
			`bool rb_full(const RingBuffer *b);`
			`bool rb_empty(const RingBuffer *b);`
			`void rb_write(RingBuffer b, void *p);`
			`bool rb_read(RingBuffer b, void *p);`
			`RingBuffer *rb_new(int size);`
			`void rb_kill(RingBuffer *b);`
			`uint16_t rb_size(const RingBuffer *b);`
			`uint16_t rb_data(const RingBuffer b, void *dest);`

Add some tests for our ring_buffer implementation. These can serve as documentation until we write actual api docs, probably using apidsl. 2018-07-04 02:14:36 +08:00			`#ifdef __cplusplus`
			`}`
			`#endif`

Standardise header guards. Using the full path including the repo name. 2018-09-10 03:54:05 +08:00			`#endif // C_TOXCORE_TOXAV_RING_BUFFER_H`