1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
/*
* Author: Tatu Ylonen <ylo@cs.hut.fi>
* Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
* All rights reserved
* Code for manipulating FIFO buffers.
*
* As far as I am concerned, the code I have written for this software
* can be used freely for any purpose. Any derived versions of this
* software must be clearly marked as such, and if the derived work is
* incompatible with the protocol description in the RFC file, it must be
* 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. */
} 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 *);
/* 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 */
|
