| commit | 36651f17f38c2771c8508beeb48f882107f0494d | [log] [tgz] |
|---|---|---|
| author | Davide Pesavento <davidepesa@gmail.com> | Mon Jan 02 17:07:21 2023 -0500 |
| committer | Davide Pesavento <davidepesa@gmail.com> | Thu Jan 05 04:07:05 2023 -0500 |
| tree | 8bad934a5e2c3d24a7940505255c37cf45163c9f | |
| parent | 59f6fabe5086fc8bbcc38b82933c6bc79c869cef [diff] |
docs: improve formatting and document structure Change-Id: I4b0b4cc3eae000aa1c988c5d308c3f78052ad96d
- .jenkins.d/00-deps.sh[diff]
- COPYING.md[diff]
- README.md[diff]
- docs/conf.py[diff]
- docs/examples.rst[diff]
- docs/index.rst[diff]
- docs/release-notes/release-notes-0.1.0.rst[diff]
- docs/release-notes/release-notes-0.2.0.rst[diff]
- docs/release-notes/release-notes-0.3.0.rst[diff]
- .github/
- .jenkins.d/
- .waf-tools/
- docs/
- examples/
- PSync/
- tests/
- .gitignore
- .jenkins
- AUTHORS.md
- COPYING.md
- PSync.pc.in
- README.md
- waf
- wscript
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
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 GNU LGPL version 3 or a compatible license. 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 for details.