[openssh.git] / compress.h

/*

compress.h

Author: Tatu Ylonen <ylo@cs.hut.fi>

Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
                   All rights reserved

Created: Wed Oct 25 22:12:46 1995 ylo

Interface to packet compression for ssh.

*/

/* RCSID("$Id$"); */

#ifndef COMPRESS_H
#define COMPRESS_H

/* Initializes compression; level is compression level from 1 to 9 (as in
   gzip). */
void buffer_compress_init(int level);

/* Frees any data structures allocated by buffer_compress_init. */
void buffer_compress_uninit();

/* Compresses the contents of input_buffer into output_buffer.  All
   packets compressed using this function will form a single
   compressed data stream; however, data will be flushed at the end of
   every call so that each output_buffer can be decompressed
   independently (but in the appropriate order since they together
   form a single compression stream) by the receiver.  This appends
   the compressed data to the output buffer. */
void buffer_compress(Buffer *input_buffer, Buffer *output_buffer);

/* Uncompresses the contents of input_buffer into output_buffer.  All
   packets uncompressed using this function will form a single
   compressed data stream; however, data will be flushed at the end of
   every call so that each output_buffer.  This must be called for the
   same size units that the buffer_compress was called, and in the
   same order that buffers compressed with that.  This appends the
   uncompressed data to the output buffer. */
void buffer_uncompress(Buffer *input_buffer, Buffer *output_buffer);

#endif /* COMPRESS_H */
Commit	Line	Data
8efc0c15	1	/*
	2
	3	compress.h
	4
	5	Author: Tatu Ylonen <ylo@cs.hut.fi>
	6
	7	Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
	8	All rights reserved
	9
	10	Created: Wed Oct 25 22:12:46 1995 ylo
	11
	12	Interface to packet compression for ssh.
	13
	14	*/
	15
	16	/* RCSID("$Id$"); */
	17
	18	#ifndef COMPRESS_H
	19	#define COMPRESS_H
	20
	21	/* Initializes compression; level is compression level from 1 to 9 (as in
	22	gzip). */
	23	void buffer_compress_init(int level);
	24
	25	/* Frees any data structures allocated by buffer_compress_init. */
	26	void buffer_compress_uninit();
	27
	28	/* Compresses the contents of input_buffer into output_buffer. All
	29	packets compressed using this function will form a single
	30	compressed data stream; however, data will be flushed at the end of
	31	every call so that each output_buffer can be decompressed
	32	independently (but in the appropriate order since they together
	33	form a single compression stream) by the receiver. This appends
	34	the compressed data to the output buffer. */
	35	void buffer_compress(Buffer input_buffer, Buffer output_buffer);
	36
	37	/* Uncompresses the contents of input_buffer into output_buffer. All
	38	packets uncompressed using this function will form a single
	39	compressed data stream; however, data will be flushed at the end of
	40	every call so that each output_buffer. This must be called for the
	41	same size units that the buffer_compress was called, and in the
	42	same order that buffers compressed with that. This appends the
	43	uncompressed data to the output buffer. */
	44	void buffer_uncompress(Buffer input_buffer, Buffer output_buffer);
	45
	46	#endif /* COMPRESS_H */