Skip to content

andreiavrammsd/cpp-channel

Repository files navigation

Channel

build codecov documentation

Thread-safe container for sharing data between threads. Header-only.

  • Thread-safe push and fetch.
  • Use stream operators to push (<<) and fetch (>>) items.
  • Value type must be default constructible.
  • Blocking (forever waiting to fetch).
  • Range-based for loop supported.
  • Close to prevent pushing and stop waiting to fetch.
  • Integrates well with STL algorithms in some cases. Eg: std::move(ch.begin(), ch.end(), ...).
  • Tested with GCC, Clang, and MSVC.

Requirements

  • C++11 or newer

Installation

  • Copy the include directory into your project and add it to your include path.
  • With CMake
  • With Bazel

Usage

#include <cassert> #include <msd/channel.hpp> int main() { msd::channel<int> chan; // unbuffered int in = 1; int out = 0; // Send to channel chan << in; // Read from channel chan >> out; assert(out == 1); }
#include <msd/channel.hpp> int main() { msd::channel<int> chan{2}; // buffered // Send to channel chan << 1; chan << 2; chan << 3; // blocking because capacity is 2 (and no one reads from channel) }
#include <msd/channel.hpp> int main() { msd::channel<int> chan{2}; // buffered int in = 1; int out = 0; // Send to channel chan << in; chan << in; // Read from channel chan >> out; chan >> out; chan >> out; // blocking because channel is empty (and no one writes on it) }
#include <iostream> #include <msd/channel.hpp> int main() { msd::channel<int> chan; int in1 = 1; int in2 = 2; chan << in1 << in2; for (const auto out : chan) { // blocking: forever waiting for channel items std::cout << out << '\n'; } }

See examples and documentation.


Developed with CLion and Visual Studio Code.