git.pond.sub.org Git - empserver/blob - src/client/ioqueue.h

   1 /*
   2  *  Empire - A multi-player, client/server Internet based war game.
   3  *  Copyright (C) 1986-2006, 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 the "LEGAL", "LICENSE", "CREDITS" and "README" files for all the
  23  *  related information and legal notices. It is expected that any future
  24  *  projects/authors will amend these files as needed.
  25  *
  26  *  ---
  27  *
  28  *  ioqueue.h: stores and frees data associated with a file descriptor.
  29  *             uses writev to write, and read to read.
  30  *
  31  *  Known contributors to this file:
  32  *
  33  */
  34
  35 #ifndef IOQUEUE_H
  36 #define IOQUEUE_H
  37
  38 struct ioqueue {
  39     struct qelem queue;         /* queue fwd/back */
  40     int bsize;                  /* basic block size */
  41     int cc;                     /* character count */
  42 };
  43
  44 struct io {
  45     struct qelem queue;         /* list of ioqueue elements */
  46     int nbytes;                 /* number of data bytes present */
  47     int offset;                 /* offset into current entry */
  48     char *data;         /* pointer to start */
  49 };
  50
  51 void ioq_init(struct ioqueue *ioq, int bsize);
  52 int ioq_peek(struct ioqueue *ioq, char *buf, int cc);
  53 int ioq_dequeue(struct ioqueue *ioq, int cc);
  54 int ioq_read(struct ioqueue *ioq, char *buf, int cc);
  55 void ioq_write(struct ioqueue *ioq, char *buf, int cc);
  56 int ioq_qsize(struct ioqueue *ioq);
  57 void ioq_drain(struct ioqueue *ioq);
  58 char *ioq_gets(struct ioqueue *ioq, char *buf, int cc, int *eol);
  59
  60 #endif