This repository contains IceFlow, a stream processing library based on Named-Data Networking (NDN) written in C++. Besides the actual library, a simple word counting example application is included in the repository to illustrate the use of IceFlow for stream processing use cases.
Detailed installation instructions for installing the required dependencies and IceFlow itself can be found in the file Install.md.
To set up the build system for the project, you need to have CMake (with a minimum version of 3.18) installed on your system. With CMake installed, you can generate the build files using the command
cmake .in the repository's root directory.
IceFlow's documentation can be found here.
If you have Doxygen installed, you can generate the documentation locally (after generating the build files) using the following command:
make docsIn order to achieve a consistent style, IceFlow's codebase is formatted using
clang-format.
After installing it (e.g., by using brew install clang-format on macOS) and generating the build files, you can format all source files by invoking
make formatThe CI pipeline will assert that the codebase is always correctly formatted and will fail otherwise.
IceFlow uses cppcheck to lint its source code. To perform the linting step locally, use the following command (after generating the build files):
make lint