2 * Empire - A multi-player, client/server Internet based war game.
3 * Copyright (C) 1986-2013, Dave Pare, Jeff Bailey, Thomas Ruschak,
4 * Ken Stevens, Steve McClure, Markus Armbruster
6 * Empire 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 3 of the License, or
9 * (at your option) any later version.
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.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
21 * See files README, COPYING and CREDITS in the root of the source
22 * tree for related information and legal notices. It is expected
23 * that future projects/authors will amend these files as needed.
27 * ringbuf.h: Simple ring buffer
29 * Known contributors to this file:
30 * Markus Armbruster, 2007
38 #define RING_SIZE 4096
40 /* Ring buffer, consumer reads, producer writes */
42 /* All members are private! */
44 * Consumer reads from buf[cons % RING_SIZE], incrementing cons
45 * Produces writes to buf[prod % RING_SIZE], incrementing prod
47 * prod == cons + RING_SIZE: full
48 * invariant: prod - cons <= RING_SIZE
51 unsigned char buf[RING_SIZE];
54 extern void ring_init(struct ring *);
55 extern int ring_len(struct ring *);
56 extern int ring_space(struct ring *);
57 extern int ring_peek(struct ring *, int);
58 extern int ring_getc(struct ring *);
59 extern int ring_putc(struct ring *, unsigned char);
60 extern int ring_putm(struct ring *, void *, size_t);
61 extern void ring_discard(struct ring *, int);
62 extern int ring_search(struct ring *, char *);
63 extern int ring_from_file(struct ring *, int fd);
64 extern int ring_to_file(struct ring *, int fd);