circbuffer.h

   1 /*
   2  * Dropbear SSH
   3  *
   4  * Copyright (c) 2002-2004 Matt Johnston
   5  * All rights reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE. */
  24
  25 #ifndef _CIRCBUFFER_H_
  26 #define _CIRCBUFFER_H_
  27 struct circbuf {
  28
  29         unsigned int size;
  30         unsigned int readpos;
  31         unsigned int writepos;
  32         unsigned int used;
  33         unsigned char* data;
  34 };
  35
  36 typedef struct circbuf circbuffer;
  37
  38 circbuffer * cbuf_new(unsigned int size);
  39 void cbuf_free(circbuffer * cbuf);
  40
  41 unsigned int cbuf_getused(circbuffer * cbuf); /* how much data stored */
  42 unsigned int cbuf_getavail(circbuffer * cbuf); /* how much we can write */
  43 unsigned int cbuf_readlen(circbuffer *cbuf); /* max linear read len */
  44 unsigned int cbuf_writelen(circbuffer *cbuf); /* max linear write len */
  45
  46 unsigned char* cbuf_readptr(circbuffer *cbuf, unsigned int len);
  47 unsigned char* cbuf_writeptr(circbuffer *cbuf, unsigned int len);
  48 void cbuf_incrwrite(circbuffer *cbuf, unsigned int len);
  49 void cbuf_incrread(circbuffer *cbuf, unsigned int len);
  50 #endif