Annotation of src/usr.bin/ssh/compress.h, Revision 1.3
1.1 deraadt 1: /*
1.2 deraadt 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: */
1.1 deraadt 15:
1.3 ! markus 16: /* RCSID("$Id: compress.h,v 1.2 1999/11/24 00:26:01 deraadt Exp $"); */
1.1 deraadt 17:
18: #ifndef COMPRESS_H
19: #define COMPRESS_H
20:
1.3 ! markus 21: /*
! 22: * Initializes compression; level is compression level from 1 to 9 (as in
! 23: * gzip).
! 24: */
1.2 deraadt 25: void buffer_compress_init(int level);
1.1 deraadt 26:
27: /* Frees any data structures allocated by buffer_compress_init. */
1.2 deraadt 28: void buffer_compress_uninit();
1.1 deraadt 29:
1.3 ! markus 30: /*
! 31: * Compresses the contents of input_buffer into output_buffer. All packets
! 32: * compressed using this function will form a single compressed data stream;
! 33: * however, data will be flushed at the end of every call so that each
! 34: * output_buffer can be decompressed independently (but in the appropriate
! 35: * order since they together form a single compression stream) by the
! 36: * receiver. This appends the compressed data to the output buffer.
! 37: */
1.2 deraadt 38: void buffer_compress(Buffer * input_buffer, Buffer * output_buffer);
1.1 deraadt 39:
1.3 ! markus 40: /*
! 41: * Uncompresses the contents of input_buffer into output_buffer. All packets
! 42: * uncompressed using this function will form a single compressed data
! 43: * stream; however, data will be flushed at the end of every call so that
! 44: * each output_buffer. This must be called for the same size units that the
! 45: * buffer_compress was called, and in the same order that buffers compressed
! 46: * with that. This appends the uncompressed data to the output buffer.
! 47: */
1.2 deraadt 48: void buffer_uncompress(Buffer * input_buffer, Buffer * output_buffer);
1.1 deraadt 49:
1.2 deraadt 50: #endif /* COMPRESS_H */