src/common/torgzip.h

   1 /* Copyright (c) 2003, Roger Dingledine
   2  * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
   3  * Copyright (c) 2007-2010, The Tor Project, Inc. */
   4 /* See LICENSE for licensing information */
   5
   6 /**
   7  * \file torgzip.h
   8  * \brief Headers for torgzip.h
   9  **/
  10
  11 #ifndef _TOR_TORGZIP_H
  12 #define _TOR_TORGZIP_H
  13
  14 /** Enumeration of what kind of compression to use.  Only ZLIB_METHOD is
  15  * guaranteed to be supported by the compress/uncompress functions here;
  16  * GZIP_METHOD may be supported if we built against zlib version 1.2 or later
  17  * and is_gzip_supported() returns true. */
  18 typedef enum {
  19   NO_METHOD=0, GZIP_METHOD=1, ZLIB_METHOD=2, UNKNOWN_METHOD=3
  20 } compress_method_t;
  21
  22 int
  23 tor_gzip_compress(char **out, size_t *out_len,
  24                   const char *in, size_t in_len,
  25                   compress_method_t method);
  26 int
  27 tor_gzip_uncompress(char **out, size_t *out_len,
  28                     const char *in, size_t in_len,
  29                     compress_method_t method,
  30                     int complete_only,
  31                     int protocol_warn_level);
  32
  33 int is_gzip_supported(void);
  34
  35 compress_method_t detect_compression_method(const char *in, size_t in_len);
  36
  37 /** Return values from tor_zlib_process; see that function's documentation for
  38  * details. */
  39 typedef enum {
  40   TOR_ZLIB_OK, TOR_ZLIB_DONE, TOR_ZLIB_BUF_FULL, TOR_ZLIB_ERR
  41 } tor_zlib_output_t;
  42 /** Internal state for an incremental zlib compression/decompression. */
  43 typedef struct tor_zlib_state_t tor_zlib_state_t;
  44 tor_zlib_state_t *tor_zlib_new(int compress, compress_method_t method);
  45
  46 tor_zlib_output_t tor_zlib_process(tor_zlib_state_t *state,
  47                                    char **out, size_t *out_len,
  48                                    const char **in, size_t *in_len,
  49                                    int finish);
  50 void tor_zlib_free(tor_zlib_state_t *state);
  51
  52 #endif
  53