kcenon::network::utils::compression_pipeline Class Reference

Message compression and decompression pipeline. More...

#include <compression_pipeline.h>

Collaboration diagram for kcenon::network::utils::compression_pipeline:

Classes
class	impl

Public Member Functions
	compression_pipeline (compression_algorithm algo=compression_algorithm::lz4, size_t compression_threshold=256)
	Constructs a compression pipeline.
	~compression_pipeline () noexcept
	Destructor.
auto	compress (std::span< const uint8_t > input) -> Result< std::vector< uint8_t > >
	Compresses input data.
auto	compress (const std::vector< uint8_t > &input) -> Result< std::vector< uint8_t > >
	Compresses input data (vector overload)
auto	decompress (std::span< const uint8_t > input) -> Result< std::vector< uint8_t > >
	Decompresses input data.
auto	decompress (const std::vector< uint8_t > &input) -> Result< std::vector< uint8_t > >
	Decompresses input data (vector overload)
auto	set_compression_threshold (size_t bytes) -> void
	Sets compression threshold.
auto	get_compression_threshold () const -> size_t
	Gets current compression threshold.
auto	get_algorithm () const -> compression_algorithm
	Gets current algorithm.

Private Attributes
std::unique_ptr< impl >	pimpl_

Detailed Description

Message compression and decompression pipeline.

Thread Safety

• All public methods are thread-safe
• Can be used from multiple threads concurrently

Key Features

• LZ4 fast compression algorithm
• Configurable compression threshold
• Automatic size threshold handling
• Error handling via Result<T> pattern

Usage Example

auto pipeline = std::make_shared<compression_pipeline>(
    compression_algorithm::lz4,
    256  // Don't compress messages smaller than 256 bytes
);
 
// Compress data
std::vector<uint8_t> data = {...};
auto result = pipeline->compress(data);
if (!result.is_err()) {
    auto compressed = result.value();
    // Send compressed data...
}
 
// Decompress data
auto decompressed = pipeline->decompress(compressed);

Definition at line 63 of file compression_pipeline.h.

Constructor & Destructor Documentation

compression_pipeline()

kcenon::network::utils::compression_pipeline::compression_pipeline ( compression_algorithm algo = compression_algorithm::lz4, size_t compression_threshold = 256 )

explicit

Constructs a compression pipeline.

Parameters

algo	Compression algorithm to use
compression_threshold	Minimum size to compress (bytes)

Definition at line 448 of file compression_pipeline.cpp.

        : pimpl_(std::make_unique<impl>(algo, compression_threshold))
    {
    }

~compression_pipeline()

kcenon::network::utils::compression_pipeline::~compression_pipeline ( )

defaultnoexcept

Destructor.

Member Function Documentation

compress() [1/2]

auto kcenon::network::utils::compression_pipeline::compress

(

const std::vector< uint8_t > &

input

)

-> Result<std::vector<uint8_t>>

Compresses input data (vector overload)

Parameters

input

Data to compress

Returns

Compressed data or error

Definition at line 462 of file compression_pipeline.cpp.

    {
        return pimpl_->compress(std::span<const uint8_t>(input));
    }

compress() [2/2]

auto kcenon::network::utils::compression_pipeline::compress

(

std::span< const uint8_t >

input

)

-> Result<std::vector<uint8_t>>

Compresses input data.

Parameters

input

Data to compress

Returns

Compressed data or error

If input size is below threshold, returns uncompressed data. If compression fails or produces larger output, returns uncompressed data.

Definition at line 456 of file compression_pipeline.cpp.

    {
        return pimpl_->compress(input);
    }

decompress() [1/2]

auto kcenon::network::utils::compression_pipeline::decompress

(

const std::vector< uint8_t > &

input

)

-> Result<std::vector<uint8_t>>

Decompresses input data (vector overload)

Parameters

input

Data to decompress

Returns

Decompressed data or error

Definition at line 474 of file compression_pipeline.cpp.

    {
        return pimpl_->decompress(std::span<const uint8_t>(input));
    }

decompress() [2/2]

auto kcenon::network::utils::compression_pipeline::decompress

(

std::span< const uint8_t >

input

)

-> Result<std::vector<uint8_t>>

Decompresses input data.

Parameters

input

Data to decompress

Returns

Decompressed data or error

Definition at line 468 of file compression_pipeline.cpp.

    {
        return pimpl_->decompress(input);
    }

get_algorithm()

auto kcenon::network::utils::compression_pipeline::get_algorithm

(

)

const -> compression_algorithm

Gets current algorithm.

Returns

Compression algorithm

Definition at line 490 of file compression_pipeline.cpp.

    {
        return pimpl_->get_algorithm();
    }

References kcenon::network::utils::compression_pipeline::impl::get_algorithm(), and pimpl_.

Here is the call graph for this function:

get_compression_threshold()

auto kcenon::network::utils::compression_pipeline::get_compression_threshold

(

)

const -> size_t

Gets current compression threshold.

Returns

Threshold in bytes

Definition at line 485 of file compression_pipeline.cpp.

    {
        return pimpl_->get_compression_threshold();
    }

References kcenon::network::utils::compression_pipeline::impl::get_compression_threshold(), and pimpl_.

Here is the call graph for this function:

set_compression_threshold()

auto kcenon::network::utils::compression_pipeline::set_compression_threshold

(

size_t

bytes

)

-> void

Sets compression threshold.

Parameters

bytes

Minimum size to compress

Definition at line 480 of file compression_pipeline.cpp.

    {
        pimpl_->set_compression_threshold(bytes);
    }

Member Data Documentation

pimpl_

std::unique_ptr<impl> kcenon::network::utils::compression_pipeline::pimpl_

private

Definition at line 135 of file compression_pipeline.h.

Referenced by get_algorithm(), and get_compression_threshold().

---

The documentation for this class was generated from the following files:

• src/internal/utils/compression_pipeline.h
• src/internal/utils/compression_pipeline.cpp