]>
Commit | Line | Data |
---|---|---|
8efc0c15 | 1 | /* |
5260325f | 2 | * Author: Tatu Ylonen <ylo@cs.hut.fi> |
5260325f | 3 | * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
4 | * All rights reserved | |
5260325f | 5 | * Code for manipulating FIFO buffers. |
35484284 | 6 | * |
bcbf86ec | 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". | |
5260325f | 12 | */ |
8efc0c15 | 13 | |
2a1e4639 | 14 | /* RCSID("$OpenBSD: buffer.h,v 1.8 2001/06/26 06:32:48 itojun Exp $"); */ |
8efc0c15 | 15 | |
16 | #ifndef BUFFER_H | |
17 | #define BUFFER_H | |
18 | ||
5260325f | 19 | typedef struct { |
20 | char *buf; /* Buffer for data. */ | |
1e3b8b07 | 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. */ | |
5260325f | 24 | } Buffer; |
8efc0c15 | 25 | /* Initializes the buffer structure. */ |
2a1e4639 | 26 | void buffer_init(Buffer *); |
8efc0c15 | 27 | |
28 | /* Frees any memory used for the buffer. */ | |
2a1e4639 | 29 | void buffer_free(Buffer *); |
8efc0c15 | 30 | |
31 | /* Clears any data from the buffer, making it empty. This does not actually | |
32 | zero the memory. */ | |
2a1e4639 | 33 | void buffer_clear(Buffer *); |
8efc0c15 | 34 | |
35 | /* Appends data to the buffer, expanding it if necessary. */ | |
2a1e4639 | 36 | void buffer_append(Buffer *, const char *, u_int); |
8efc0c15 | 37 | |
aa3378df | 38 | /* |
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. | |
42 | */ | |
2a1e4639 | 43 | void buffer_append_space(Buffer *, char **, u_int); |
8efc0c15 | 44 | |
45 | /* Returns the number of bytes of data in the buffer. */ | |
2a1e4639 | 46 | u_int buffer_len(Buffer *); |
8efc0c15 | 47 | |
48 | /* Gets data from the beginning of the buffer. */ | |
2a1e4639 | 49 | void buffer_get(Buffer *, char *, u_int); |
8efc0c15 | 50 | |
51 | /* Consumes the given number of bytes from the beginning of the buffer. */ | |
2a1e4639 | 52 | void buffer_consume(Buffer *, u_int); |
8efc0c15 | 53 | |
54 | /* Consumes the given number of bytes from the end of the buffer. */ | |
2a1e4639 | 55 | void buffer_consume_end(Buffer *, u_int); |
8efc0c15 | 56 | |
57 | /* Returns a pointer to the first used byte in the buffer. */ | |
2a1e4639 | 58 | char *buffer_ptr(Buffer *); |
8efc0c15 | 59 | |
aa3378df | 60 | /* |
61 | * Dumps the contents of the buffer to stderr in hex. This intended for | |
62 | * debugging purposes only. | |
63 | */ | |
2a1e4639 | 64 | void buffer_dump(Buffer *); |
8efc0c15 | 65 | |
5260325f | 66 | #endif /* BUFFER_H */ |