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