]> git.pond.sub.org Git - empserver/blob - src/client/ringbuf.h
Fix trailing whitespace
[empserver] / src / client / ringbuf.h
1 /*
2  *  Empire - A multi-player, client/server Internet based war game.
3  *  Copyright (C) 1986-2008, Dave Pare, Jeff Bailey, Thomas Ruschak,
4  *                           Ken Stevens, Steve McClure
5  *
6  *  This program is free software; you can redistribute it and/or modify
7  *  it under the terms of the GNU General Public License as published by
8  *  the Free Software Foundation; either version 2 of the License, or
9  *  (at your option) any later version.
10  *
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with this program; if not, write to the Free Software
18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  *  ---
21  *
22  *  See files README, COPYING and CREDITS in the root of the source
23  *  tree for related information and legal notices.  It is expected
24  *  that future projects/authors will amend these files as needed.
25  *
26  *  ---
27  *
28  *  ringbuf.h: Simple ring buffer
29  *
30  *  Known contributors to this file:
31  *     Markus Armbruster, 2007
32  */
33
34 #ifndef RINGBUF_H
35 #define RINGBUF_H
36
37 #include <stddef.h>
38
39 #define RING_SIZE 4096
40
41 /* Ring buffer, consumer reads, producer writes */
42 struct ring {
43     /* All members are private! */
44     /*
45      * Consumer reads from buf[cons % RING_SIZE], incrementing cons
46      * Produces writes to buf[prod % RING_SIZE], incrementing prod
47      * prod == cons: empty
48      * prod == cons + RING_SIZE: full
49      * invariant: prod - cons <= RING_SIZE
50      */
51     unsigned cons, prod;
52     unsigned char buf[RING_SIZE];
53 };
54
55 extern void ring_init(struct ring *);
56 extern int ring_len(struct ring *);
57 extern int ring_space(struct ring *);
58 extern int ring_peek(struct ring *, int);
59 extern int ring_getc(struct ring *);
60 extern int ring_putc(struct ring *, unsigned char);
61 extern int ring_putm(struct ring *, void *, size_t);
62 extern void ring_discard(struct ring *, int);
63 extern int ring_search(struct ring *, char *);
64 extern int ring_from_file(struct ring *, int fd);
65 extern int ring_to_file(struct ring *, int fd);
66
67 #endif