buffer.h

   1 /*
   2  * Author: Tatu Ylonen <ylo@cs.hut.fi>
   3  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   4  *                    All rights reserved
   5  * Code for manipulating FIFO buffers.
   6  *
   7  * As far as I am concerned, the code I have written for this software
   8  * can be used freely for any purpose.  Any derived versions of this
   9  * software must be clearly marked as such, and if the derived work is
  10  * incompatible with the protocol description in the RFC file, it must be
  11  * called by a name other than "ssh" or "Secure Shell".
  12  */
  13
  14 /* RCSID("$OpenBSD: buffer.h,v 1.10 2001/12/19 17:16:13 stevesk Exp $"); */
  15
  16 #ifndef BUFFER_H
  17 #define BUFFER_H
  18
  19 typedef struct {
  20         u_char  *buf;           /* Buffer for data. */
  21         u_int    alloc;         /* Number of bytes allocated for data. */
  22         u_int    offset;        /* Offset of first byte containing data. */
  23         u_int    end;           /* Offset of last byte containing data. */
  24 }       Buffer;
  25
  26 void     buffer_init(Buffer *);
  27 void     buffer_clear(Buffer *);
  28 void     buffer_free(Buffer *);
  29
  30 u_int    buffer_len(Buffer *);
  31 void    *buffer_ptr(Buffer *);
  32
  33 void     buffer_append(Buffer *, const void *, u_int);
  34 void    *buffer_append_space(Buffer *, u_int);
  35
  36 void     buffer_get(Buffer *, void *, u_int);
  37
  38 void     buffer_consume(Buffer *, u_int);
  39 void     buffer_consume_end(Buffer *, u_int);
  40
  41 void     buffer_dump(Buffer *);
  42
  43 #endif                          /* BUFFER_H */