compress.h revision 76259
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.8 2001/04/05 10:39:02 markus 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_send(int level);
24void	buffer_compress_init_recv(void);
25
26/* Frees any data structures allocated by buffer_compress_init. */
27void    buffer_compress_uninit(void);
28
29/*
30 * Compresses the contents of input_buffer into output_buffer.  All packets
31 * compressed using this function will form a single compressed data stream;
32 * however, data will be flushed at the end of every call so that each
33 * output_buffer can be decompressed independently (but in the appropriate
34 * order since they together form a single compression stream) by the
35 * receiver.  This appends the compressed data to the output buffer.
36 */
37void    buffer_compress(Buffer * input_buffer, Buffer * output_buffer);
38
39/*
40 * Uncompresses the contents of input_buffer into output_buffer.  All packets
41 * uncompressed using this function will form a single compressed data
42 * stream; however, data will be flushed at the end of every call so that
43 * each output_buffer.  This must be called for the same size units that the
44 * buffer_compress was called, and in the same order that buffers compressed
45 * with that.  This appends the uncompressed data to the output buffer.
46 */
47void    buffer_uncompress(Buffer * input_buffer, Buffer * output_buffer);
48
49#endif				/* COMPRESS_H */
50