compression_configuration Class Reference

Provides command-line options for compression configuration. More...

#include <compression_configuration.hpp>

Collaboration diagram for compression_configuration:

Static Public Member Functions
static boost::program_options::options_description	make_options_description ()
	Creates the options description for compression CLI arguments.
static compression_options	read_options (const boost::program_options::variables_map &vm)
	Reads compression options from parsed variables map.
static std::uint8_t	to_compression_mask (const compression_options &opts)
	Converts compression options to protocol bitmask.

Detailed Description

Provides command-line options for compression configuration.

Standard compression options: -c, –compression-enabled Enable compression for network communication –compression-algorithm Algorithm: zlib, gzip, bzip2, all (default: all)

Member Function Documentation

make_options_description()

boost::program_options::options_description make_options_description ( )

static

Creates the options description for compression CLI arguments.

Returns

options_description for compression configuration.

read_options()

compression_options read_options ( const boost::program_options::variables_map &  vm )

static

Reads compression options from parsed variables map.

Parameters

vm	Parsed command-line options.

Returns

compression_options populated from the variables map.

to_compression_mask()

std::uint8_t to_compression_mask ( const compression_options &  opts )

static

Converts compression options to protocol bitmask.

Parameters

opts	The compression options.

Returns

Bitmask suitable for use in client_options.supported_compression.