src/usr.bin/ssh/buffer.h - diff

Return to buffer.h CVS log

Up to [local] / src / usr.bin / ssh

Diff for /src/usr.bin/ssh/Attic/buffer.h between version 1.7.2.2 and 1.8

-version 1.7.2.2, 2002/03/09 00:20:44
+version 1.8, 2001/06/26 06:32:48
 Line 1
 Line 1
 Line 1
- /*      $OpenBSD$       */
  /*
   * Author: Tatu Ylonen <ylo@cs.hut.fi>
   * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
-Line 13
+Line 11
 Line 13
 Line 11
   * called by a name other than "ssh" or "Secure Shell".
   */
+ /* RCSID("$OpenBSD$"); */
  #ifndef BUFFER_H
  #define BUFFER_H
  typedef struct {
-         u_char  *buf;           /* Buffer for data. */
+         char   *buf;            /* Buffer for data. */
-         u_int    alloc;         /* Number of bytes allocated for data. */
+         u_int alloc;    /* Number of bytes allocated for data. */
-         u_int    offset;        /* Offset of first byte containing data. */
+         u_int offset;   /* Offset of first byte containing data. */
-         u_int    end;           /* Offset of last byte containing data. */
+         u_int end;      /* Offset of last byte containing data. */
  }       Buffer;
+ /* Initializes the buffer structure. */
+ void    buffer_init(Buffer *);
- void     buffer_init(Buffer *);
+ /* Frees any memory used for the buffer. */
- void     buffer_clear(Buffer *);
+ void    buffer_free(Buffer *);
- void     buffer_free(Buffer *);
- u_int    buffer_len(Buffer *);
+ /* Clears any data from the buffer, making it empty.  This does not actually
- void    *buffer_ptr(Buffer *);
+    zero the memory. */
+ void    buffer_clear(Buffer *);
- void     buffer_append(Buffer *, const void *, u_int);
+ /* Appends data to the buffer, expanding it if necessary. */
- void    *buffer_append_space(Buffer *, u_int);
+ void    buffer_append(Buffer *, const char *, u_int);
- void     buffer_get(Buffer *, void *, 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);
- void     buffer_consume(Buffer *, u_int);
+ /* Returns the number of bytes of data in the buffer. */
- void     buffer_consume_end(Buffer *, u_int);
+ u_int buffer_len(Buffer *);
- void     buffer_dump(Buffer *);
+ /* Gets data from the beginning of the buffer. */
+ void    buffer_get(Buffer *, char *, u_int);
+ /* Consumes the given number of bytes from the beginning of the buffer. */
+ void    buffer_consume(Buffer *, u_int);
+ /* Consumes the given number of bytes from the end of the buffer. */
+ void    buffer_consume_end(Buffer *, u_int);
+ /* Returns a pointer to the first used byte in the buffer. */
+ char   *buffer_ptr(Buffer *);
+ /*
+  * Dumps the contents of the buffer to stderr in hex.  This intended for
+  * debugging purposes only.
+  */
+ void    buffer_dump(Buffer *);
  #endif                          /* BUFFER_H */