1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
/*
* Copyright (C) 2013-2014 Olivier Gayot
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef RING_BUFFER_H
#define RING_BUFFER_H
/* needed for the definition of NULL */
#include <stdlib.h>
#include <stdint.h>
#include <sys/types.h>
typedef struct t_ring_buffer {
char buffer[8192];
uint16_t off_r;
uint16_t off_w;
size_t size_filled;
} t_ring_buffer;
/* do not remove for backward compatibility */
typedef t_ring_buffer t_rb;
typedef t_ring_buffer ring_buffer_t;
typedef t_ring_buffer rb_t;
static inline size_t rb_get_size(const rb_t *rb)
{
return sizeof(rb->buffer);
}
/*
* initializes rb with default values.
* returns 0 on success
*/
int rb_init(rb_t *rb);
/* returns an initialized newly allocated ring buffer */
__attribute((malloc)) rb_t *rb_new(void);
void rb_delete(rb_t **);
/* put n bytes of src into the ring buffer pointed by rb */
rb_t *rb_put(rb_t *rb, const void *src, size_t n);
/*
* take at most n bytes from the ring buffer pointed by rb and
* put them into dest
*/
size_t rb_get(rb_t *rb, void *dest, size_t n);
/*
* like rb_get but does not modify the ring_buffer (the bytes are kept
* in the ring_buffer)
*/
size_t rb_peek(const rb_t *ring_buffer, void *dest, size_t size);
/*
* remove a maximum of n bytes from the ring buffer pointed to by rb
* the functions returns the number of bytes actually removed
*/
static inline size_t rb_remove(rb_t *rb, size_t n)
{
return rb_get(rb, NULL, n);
}
#endif /* RING_BUFFER_H */
|
