blob: 43414ae99e5555b09bace5a4c22e3820b3dcd7cc [file] [log] [blame]
Damien Miller499a0d52006-04-23 12:06:03 +10001/* $OpenBSD: buffer.h,v 1.15 2006/04/16 00:48:52 djm Exp $ */
Ben Lindstrom05764b92002-03-05 01:53:02 +00002
Damien Millerd4a8b7e1999-10-27 13:42:43 +10003/*
Damien Miller95def091999-11-25 00:26:21 +11004 * Author: Tatu Ylonen <ylo@cs.hut.fi>
Damien Miller95def091999-11-25 00:26:21 +11005 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
6 * All rights reserved
Damien Miller95def091999-11-25 00:26:21 +11007 * Code for manipulating FIFO buffers.
Damien Miller5f056372000-04-16 12:31:48 +10008 *
Damien Millere4340be2000-09-16 13:29:08 +11009 * As far as I am concerned, the code I have written for this software
10 * can be used freely for any purpose. Any derived versions of this
11 * software must be clearly marked as such, and if the derived work is
12 * incompatible with the protocol description in the RFC file, it must be
13 * called by a name other than "ssh" or "Secure Shell".
Damien Miller95def091999-11-25 00:26:21 +110014 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100015
Damien Millerd4a8b7e1999-10-27 13:42:43 +100016#ifndef BUFFER_H
17#define BUFFER_H
18
Damien Miller95def091999-11-25 00:26:21 +110019typedef struct {
Damien Miller5a6b4fe2001-12-21 14:56:54 +110020 u_char *buf; /* Buffer for data. */
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000021 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. */
Damien Miller95def091999-11-25 00:26:21 +110024} Buffer;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100025
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000026void buffer_init(Buffer *);
27void buffer_clear(Buffer *);
28void buffer_free(Buffer *);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100029
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000030u_int buffer_len(Buffer *);
Damien Miller5a6b4fe2001-12-21 14:56:54 +110031void *buffer_ptr(Buffer *);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100032
Damien Miller5a6b4fe2001-12-21 14:56:54 +110033void buffer_append(Buffer *, const void *, u_int);
34void *buffer_append_space(Buffer *, u_int);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100035
Damien Miller499a0d52006-04-23 12:06:03 +100036int buffer_check_alloc(Buffer *, u_int);
37
Damien Miller5a6b4fe2001-12-21 14:56:54 +110038void buffer_get(Buffer *, void *, u_int);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100039
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000040void buffer_consume(Buffer *, u_int);
41void buffer_consume_end(Buffer *, u_int);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100042
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000043void buffer_dump(Buffer *);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100044
Darren Tucker50dbe832004-11-05 20:41:24 +110045int buffer_get_ret(Buffer *, void *, u_int);
46int buffer_consume_ret(Buffer *, u_int);
47int buffer_consume_end_ret(Buffer *, u_int);
48
Damien Miller95def091999-11-25 00:26:21 +110049#endif /* BUFFER_H */