dpp::zlibcontext Class Reference

This is an opaque class containing zlib library specific structures. This wraps the C pointers needed for zlib with unique_ptr and gives us a nice buffer abstraction so we don't need to wrestle with raw pointers. More...

#include <zlibcontext.h>

Collaboration diagram for dpp::zlibcontext:

Public Member Functions
	zlibcontext ()
	Initialise zlib struct via inflateInit() and size the buffer. More...
	~zlibcontext ()
	Destroy zlib struct via inflateEnd() More...
exception_error_code	decompress (const std::string &buffer, std::string &decompressed)
	Decompress zlib deflated buffer. More...

Public Attributes
z_stream *	d_stream {}
	Zlib stream struct. The actual type is defined in zlib.h so is only defined in the implementation file. More...
std::vector< unsigned char >	decomp_buffer {}
	ZLib decompression buffer. This is automatically set to DECOMP_BUFFER_SIZE bytes when the class is constructed. More...
uint64_t	decompressed_total {}
	Total decompressed received bytes counter. More...

Detailed Description

This is an opaque class containing zlib library specific structures. This wraps the C pointers needed for zlib with unique_ptr and gives us a nice buffer abstraction so we don't need to wrestle with raw pointers.

Constructor & Destructor Documentation

zlibcontext()

dpp::zlibcontext::zlibcontext

(

)

Initialise zlib struct via inflateInit() and size the buffer.

~zlibcontext()

dpp::zlibcontext::~zlibcontext

(

)

Destroy zlib struct via inflateEnd()

Member Function Documentation

decompress()

exception_error_code dpp::zlibcontext::decompress	(	const std::string &	buffer,
		std::string &	decompressed
	)

Decompress zlib deflated buffer.

Parameters

buffer	input compressed stream
decompressed	output decompressed content

Returns

an error code on error, or err_no_code_specified (0) on success

Member Data Documentation

d_stream

z_stream* dpp::zlibcontext::d_stream {}

Zlib stream struct. The actual type is defined in zlib.h so is only defined in the implementation file.

decomp_buffer

std::vector<unsigned char> dpp::zlibcontext::decomp_buffer {}

ZLib decompression buffer. This is automatically set to DECOMP_BUFFER_SIZE bytes when the class is constructed.

decompressed_total

uint64_t dpp::zlibcontext::decompressed_total {}

Total decompressed received bytes counter.