README.md

asio_stream_compressor

asio_stream_compressor is a header-only library that allows to add ZSTD compression support for asynchronous streams with easy to use wrapper.

One minute example:

#include <boost/asio.hpp>
#include <boost/asio/spawn.hpp>
#include <asio_stream_compressor/asio_stream_compressor.h>

auto main(int, char**) -> int
{
  namespace ip = boost::asio::ip;
  boost::asio::io_context ctx;
  boost::asio::spawn(
      ctx,
      [&](auto yield)
      {
        std::string message = "Hello world!";
        asio_stream_compressor::compressor<ip::tcp::socket> sock(ctx);

        sock.next_layer().async_connect(
            ip::tcp::endpoint(ip::make_address("127.0.0.1"), 8080), yield);
        boost::asio::async_write(
            sock, boost::asio::buffer(message.data(), message.size()), yield);
        boost::asio::async_read(
            sock, boost::asio::buffer(message.data(), message.size()), yield);
      });
  ctx.run();
  return 0;
}

Requirements

• C++17 compatible compiler
• CMake >= 3.14
• Boost >= 1.70.0 or ASIO (tested with 1.22.1)
• zstd >= 1.4.0

Usage

The library can be added to a CMake project using either add_subdirectory or find_package. Once set up, include the individual headers from the asio_stream_compressor/ directory or the convenience header:

#include <asio_stream_compressor/asio_stream_compressor.h>

As a subdirectory

Add this repository to your project as submodule or using FetchContent

Using FetchContent:

include(FetchContent)
FetchContent_Declare(external_compressor
    GIT_REPOSITORY https://github.com/YaZasnyal/asio_stream_compressor.git
    GIT_TAG <tag or branch>
    )
FetchContent_Populate(external_compressor)
add_subdirectory(${external_compressor_SOURCE_DIR} ${external_compressor_BINARY_DIR})

Using submodules:

git submodule add https://github.com/YaZasnyal/asio_stream_compressor.git <path>

add_subdirectory(<path>)

As a CMake package

Clone the repository and install it.

cmake -B build -DCMAKE_INSTALL_PREFIX=/desired/installation/directory .
cmake --build build --target install

Locate it and link it to your target.

find_package(asio_stream_compressor)
target_link_libraries(your_app PUBLIC asio_stream_compressor::asio_stream_compressor)

CMake Options

There are some options that allow you to change the behavior of the library. This options should be set before calling add_subdirectory or find_package.

• asio_stream_compressor_ASIO_STANDALONE - tells library to use standalone asio instead of Boost.Asio
• asio_stream_compressor_ZSTD_SHARED - tells library to use shared version of zstd library in its public interface.

Building and installing

See the BUILDING document.

Contributing

See the CONTRIBUTING document.