[gssapi-openssh.git] / openssh / buffer.h

/*	$OpenBSD: buffer.h,v 1.13 2005/03/14 11:46:56 markus Exp $	*/

/*
 * 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".
 */

#ifndef BUFFER_H
#define BUFFER_H

typedef struct {
	u_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;

#define	BUFFER_MAX_CHUNK	0x100000
#define	BUFFER_MAX_LEN		0xa00000
#define BUFFER_MAX_HPN_LEN	(2<<29)-1

void	 buffer_init(Buffer *);
void	 buffer_clear(Buffer *);
void	 buffer_free(Buffer *);

u_int	 buffer_len(Buffer *);
void	*buffer_ptr(Buffer *);

void	 buffer_append(Buffer *, const void *, u_int);
void	*buffer_append_space(Buffer *, u_int);

void	 buffer_get(Buffer *, void *, u_int);

void	 buffer_consume(Buffer *, u_int);
void	 buffer_consume_end(Buffer *, u_int);

void     buffer_dump(Buffer *);

int	 buffer_get_ret(Buffer *, void *, u_int);
int	 buffer_consume_ret(Buffer *, u_int);
int	 buffer_consume_end_ret(Buffer *, u_int);

#endif				/* BUFFER_H */
Commit	Line	Data
dec6d9fe	1	/* $OpenBSD: buffer.h,v 1.13 2005/03/14 11:46:56 markus Exp $ */
e9a17296	2
3c0ef626	3	/*
	4	* Author: Tatu Ylonen <ylo@cs.hut.fi>
	5	* Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
	6	* All rights reserved
	7	* Code for manipulating FIFO buffers.
	8	*
	9	* 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".
	14	*/
	15
3c0ef626	16	#ifndef BUFFER_H
	17	#define BUFFER_H
	18
	19	typedef struct {
e9a17296	20	u_char buf; / Buffer for data. */
3c0ef626	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. */
	24	} Buffer;
	25
dec6d9fe	26	#define BUFFER_MAX_CHUNK 0x100000
dec6d9fe	27	#define BUFFER_MAX_LEN 0xa00000
e90c2d47	28	#define BUFFER_MAX_HPN_LEN (2<<29)-1
dec6d9fe	29
3c0ef626	30	void buffer_init(Buffer *);
	31	void buffer_clear(Buffer *);
	32	void buffer_free(Buffer *);
	33
	34	u_int buffer_len(Buffer *);
e9a17296	35	void buffer_ptr(Buffer );
3c0ef626	36
e9a17296	37	void buffer_append(Buffer , const void , u_int);
e9a17296	38	void buffer_append_space(Buffer , u_int);
3c0ef626	39
e9a17296	40	void buffer_get(Buffer , void , u_int);
3c0ef626	41
	42	void buffer_consume(Buffer *, u_int);
	43	void buffer_consume_end(Buffer *, u_int);
	44
	45	void buffer_dump(Buffer *);
	46
996d5e62	47	int buffer_get_ret(Buffer , void , u_int);
	48	int buffer_consume_ret(Buffer *, u_int);
	49	int buffer_consume_end_ret(Buffer *, u_int);
	50
3c0ef626	51	#endif /* BUFFER_H */