2 * Author: Tatu Ylonen <ylo@cs.hut.fi>
3 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5 * Code for manipulating FIFO buffers.
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".
14 /* RCSID("$OpenBSD: buffer.h,v 1.7 2000/12/19 23:17:55 markus Exp $"); */
20 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. */
25 /* Initializes the buffer structure. */
26 void buffer_init(Buffer * buffer);
28 /* Frees any memory used for the buffer. */
29 void buffer_free(Buffer * buffer);
31 /* Clears any data from the buffer, making it empty. This does not actually
33 void buffer_clear(Buffer * buffer);
35 /* Appends data to the buffer, expanding it if necessary. */
36 void buffer_append(Buffer * buffer, const char *data, u_int len);
39 * Appends space to the buffer, expanding the buffer if necessary. This does
40 * not actually copy the data into the buffer, but instead returns a pointer
41 * to the allocated region.
43 void buffer_append_space(Buffer * buffer, char **datap, u_int len);
45 /* Returns the number of bytes of data in the buffer. */
46 u_int buffer_len(Buffer * buffer);
48 /* Gets data from the beginning of the buffer. */
49 void buffer_get(Buffer * buffer, char *buf, u_int len);
51 /* Consumes the given number of bytes from the beginning of the buffer. */
52 void buffer_consume(Buffer * buffer, u_int bytes);
54 /* Consumes the given number of bytes from the end of the buffer. */
55 void buffer_consume_end(Buffer * buffer, u_int bytes);
57 /* Returns a pointer to the first used byte in the buffer. */
58 char *buffer_ptr(Buffer * buffer);
61 * Dumps the contents of the buffer to stderr in hex. This intended for
62 * debugging purposes only.
64 void buffer_dump(Buffer * buffer);