named-data / PSync

Partial and Full Synchronization Library for NDN

PSync: Partial and Full Synchronization Library for NDN

The PSync library implements the PSync protocol. It uses Invertible Bloom Lookup Table (IBLT), also known as Invertible Bloom Filter (IBF), to represent the state of a producer in partial sync mode and the state of a node in full sync mode. An IBF is a compact data structure where difference of two IBFs can be computed efficiently. In partial sync, PSync uses a Bloom Filter to represent the subscription list of the consumer.

PSync uses the ndn-cxx library.

Installation

Prerequisites

• ndn-cxx and its dependencies

Build

To build PSync from source:

./waf configure
./waf
sudo ./waf install

To build on memory constrained systems, please use ./waf -j1 instead of ./waf. This will disable parallel compilation.

If configured with tests (./waf configure --with-tests), the above commands will also build a suite of unit tests that can be run with ./build/unit-tests.

Reporting bugs

Please submit any bug reports or feature requests to the PSync issue tracker.

Contributing

Contributions to PSync are greatly appreciated and can be made through our Gerrit code review site. If you are new to the NDN software community, please read our Contributor's Guide to get started.

License

PSync is free software distributed under the GNU Lesser General Public License version 3. See COPYING.md and COPYING.lesser for details.

PSync contains third-party software, licensed under the following licenses:

• The C++ Bloom Filter Library is licensed under the MIT license
• IBLT_Cplusplus is licensed under the MIT license
• The waf build system is licensed under the 3-clause BSD license