tree: 16b06cbba13c573736b8bd5ca21ddf6aec289dcd [path history] [tgz]
  1. .github/
  2. .jenkins.d/
  3. .waf-tools/
  4. docs/
  5. examples/
  6. PSync/
  7. tests/
  8. .gitignore
  9. .jenkins
  10. AUTHORS.md
  11. COPYING.md
  12. PSync.pc.in
  13. README.md
  14. waf
  15. wscript
README.md

PSync: Partial and Full Synchronization Library for NDN

CI Docs Language Latest version

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

Build

To build PSync from source:

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

To build on memory constrained platform, please use ./waf -j1 instead of ./waf. The command will disable parallel compilation.

If configured with tests (./waf configure --with-tests), the above commands will also generate 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

We greatly appreciate contributions to the PSync code base, provided that they are licensed under the LGPL 3.0+ or a compatible license (see below). If you are new to the NDN software community, please read the Contributor's Guide to get started.

License

PSync is an open source project licensed under the LGPL version 3. See COPYING.md for more information.