- itojun@cvs.openbsd.org 2002/05/13 02:37:39

[openssh.git] / buffer.h

diff --git a/buffer.h b/buffer.h
index 5e9fc278d9f7b09381d222788d1d34347a5a8040..5e4c41244230c6cd209e50feaaff15394bc64698 100644 (file)
--- a/buffer.h
+++ b/buffer.h
@@ -1,3 +1,5 @@
+/*     $OpenBSD: buffer.h,v 1.11 2002/03/04 17:27:39 stevesk Exp $     */
+
 /*
  * Author: Tatu Ylonen <ylo@cs.hut.fi>
  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
@@ -11,56 +13,31 @@
  * called by a name other than "ssh" or "Secure Shell".
  */
 
-/* RCSID("$OpenBSD: buffer.h,v 1.8 2001/06/26 06:32:48 itojun Exp $"); */
-
 #ifndef BUFFER_H
 #define BUFFER_H
 
 typedef struct {
-       char   *buf;            /* Buffer for data. */
-       u_int alloc;    /* Number of bytes allocated for data. */
-       u_int offset;   /* Offset of first byte containing data. */
-       u_int end;      /* Offset of last byte containing data. */
+       u_char  *buf;           /* Buffer for data. */
+       u_int    alloc;         /* Number of bytes allocated for data. */
+       u_int    offset;        /* Offset of first byte containing data. */
+       u_int    end;           /* Offset of last byte containing data. */
 }       Buffer;
-/* Initializes the buffer structure. */
-void    buffer_init(Buffer *);
-
-/* Frees any memory used for the buffer. */
-void    buffer_free(Buffer *);
-
-/* Clears any data from the buffer, making it empty.  This does not actually
-   zero the memory. */
-void    buffer_clear(Buffer *);
-
-/* Appends data to the buffer, expanding it if necessary. */
-void    buffer_append(Buffer *, const char *, u_int);
 
-/*
- * Appends space to the buffer, expanding the buffer if necessary. This does
- * not actually copy the data into the buffer, but instead returns a pointer
- * to the allocated region.
- */
-void    buffer_append_space(Buffer *, char **, u_int);
-
-/* Returns the number of bytes of data in the buffer. */
-u_int buffer_len(Buffer *);
+void    buffer_init(Buffer *);
+void    buffer_clear(Buffer *);
+void    buffer_free(Buffer *);
 
-/* Gets data from the beginning of the buffer. */
-void    buffer_get(Buffer *, char *, u_int);
+u_int   buffer_len(Buffer *);
+void   *buffer_ptr(Buffer *);
 
-/* Consumes the given number of bytes from the beginning of the buffer. */
-void    buffer_consume(Buffer *, u_int);
+void    buffer_append(Buffer *, const void *, u_int);
+void   *buffer_append_space(Buffer *, u_int);
 
-/* Consumes the given number of bytes from the end of the buffer. */
-void    buffer_consume_end(Buffer *, u_int);
+void    buffer_get(Buffer *, void *, u_int);
 
-/* Returns a pointer to the first used byte in the buffer. */
-char   *buffer_ptr(Buffer *);
+void    buffer_consume(Buffer *, u_int);
+void    buffer_consume_end(Buffer *, u_int);
 
-/*
- * Dumps the contents of the buffer to stderr in hex.  This intended for
- * debugging purposes only.
- */
-void    buffer_dump(Buffer *);
+void     buffer_dump(Buffer *);
 
 #endif                         /* BUFFER_H */