Macros | Typedefs | Functions
compress_zlib.h File Reference

Go to the source code of this file.


#define tor_zlib_compress_free(st)


typedef struct tor_zlib_compress_state_t tor_zlib_compress_state_t


int tor_zlib_method_supported (void)
const char * tor_zlib_get_version_str (void)
const char * tor_zlib_get_header_version_str (void)
tor_zlib_compress_state_ttor_zlib_compress_new (int compress, compress_method_t method, compression_level_t compression_level)
tor_compress_output_t tor_zlib_compress_process (tor_zlib_compress_state_t *state, char **out, size_t *out_len, const char **in, size_t *in_len, int finish)
void tor_zlib_compress_free_ (tor_zlib_compress_state_t *state)
size_t tor_zlib_compress_state_size (const tor_zlib_compress_state_t *state)
size_t tor_zlib_get_total_allocation (void)
void tor_zlib_init (void)

Detailed Description

Header for compress_zlib.c.

Definition in file compress_zlib.h.

Macro Definition Documentation

◆ tor_zlib_compress_free

#define tor_zlib_compress_free (   st)
FREE_AND_NULL(tor_zlib_compress_state_t, \
void tor_zlib_compress_free_(tor_zlib_compress_state_t *state)

Definition at line 35 of file compress_zlib.h.

Typedef Documentation

◆ tor_zlib_compress_state_t

Internal state for an incremental zlib/gzip compression/decompression.

Definition at line 21 of file compress_zlib.h.

Function Documentation

◆ tor_zlib_compress_free_()

void tor_zlib_compress_free_ ( tor_zlib_compress_state_t state)

◆ tor_zlib_compress_new()

tor_zlib_compress_state_t* tor_zlib_compress_new ( int  compress_,
compress_method_t  method,
compression_level_t  compression_level 

Construct and return a tor_zlib_compress_state_t object using method. If compress, it's for compression; otherwise it's for decompression.

Definition at line 158 of file compress_zlib.c.

◆ tor_zlib_compress_process()

tor_compress_output_t tor_zlib_compress_process ( tor_zlib_compress_state_t state,
char **  out,
size_t *  out_len,
const char **  in,
size_t *  in_len,
int  finish 

Compress/decompress some bytes using state. Read up to *in_len bytes from *in, and write up to *out_len bytes to *out, adjusting the values as we go. If finish is true, we've reached the end of the input.

Return TOR_COMPRESS_DONE if we've finished the entire compression/decompression. Return TOR_COMPRESS_OK if we're processed everything from the input. Return TOR_COMPRESS_BUFFER_FULL if we're out of space on out. Return TOR_COMPRESS_ERROR if the stream is corrupt.

Definition at line 210 of file compress_zlib.c.

References tor_assert().

◆ tor_zlib_compress_state_size()

size_t tor_zlib_compress_state_size ( const tor_zlib_compress_state_t state)

Return the approximate number of bytes allocated for state.

Definition at line 286 of file compress_zlib.c.

References tor_zlib_compress_state_t::allocation, and tor_assert().

◆ tor_zlib_get_header_version_str()

const char* tor_zlib_get_header_version_str ( void  )

Return a string representation of the version of the version of zlib used at compilation.

Definition at line 103 of file compress_zlib.c.

◆ tor_zlib_get_total_allocation()

size_t tor_zlib_get_total_allocation ( void  )

Return the approximate number of bytes allocated for all zlib states.

Definition at line 294 of file compress_zlib.c.

References atomic_counter_get(), and total_zlib_allocation.

Referenced by tor_compress_get_total_allocation().

◆ tor_zlib_get_version_str()

const char* tor_zlib_get_version_str ( void  )

Return a string representation of the version of the currently running version of zlib.

Definition at line 95 of file compress_zlib.c.

◆ tor_zlib_init()

void tor_zlib_init ( void  )

Set up global state for the zlib module

Definition at line 301 of file compress_zlib.c.

References atomic_counter_init(), and total_zlib_allocation.

Referenced by tor_compress_init().

◆ tor_zlib_method_supported()

int tor_zlib_method_supported ( void  )

Return 1 if zlib/gzip compression is supported; otherwise 0.

Definition at line 84 of file compress_zlib.c.