compression_pipeline.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2024, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#include "kcenon/network/detail/utils/result_types.h"
 
#include <cstdint>
#include <functional>
#include <memory>
#include <span>
#include <vector>
 
namespace kcenon::network::utils
{
 
    enum class compression_algorithm
    {
        none,    
        lz4,     
        gzip,    
        deflate  
    };
 
    class compression_pipeline
    {
    public:
        explicit compression_pipeline(
            compression_algorithm algo = compression_algorithm::lz4,
            size_t compression_threshold = 256);
 
        ~compression_pipeline() noexcept;
 
        auto compress(std::span<const uint8_t> input)
            -> Result<std::vector<uint8_t>>;
 
        auto compress(const std::vector<uint8_t>& input)
            -> Result<std::vector<uint8_t>>;
 
        auto decompress(std::span<const uint8_t> input)
            -> Result<std::vector<uint8_t>>;
 
        auto decompress(const std::vector<uint8_t>& input)
            -> Result<std::vector<uint8_t>>;
 
        auto set_compression_threshold(size_t bytes) -> void;
 
        auto get_compression_threshold() const -> size_t;
 
        auto get_algorithm() const -> compression_algorithm;
 
    private:
        class impl;
        std::unique_ptr<impl> pimpl_;
    };
 
    auto make_compress_function(std::shared_ptr<compression_pipeline> pipeline)
        -> std::function<std::vector<uint8_t>(const std::vector<uint8_t>&)>;
 
    auto make_decompress_function(std::shared_ptr<compression_pipeline> pipeline)
        -> std::function<std::vector<uint8_t>(const std::vector<uint8_t>&)>;
 
} // namespace kcenon::network::utils