| Ashlesh Gawande | 0b2897e | 2018-06-20 14:40:47 -0500 | [diff] [blame] | 1 | PSYNC - Partial/Full Sync Library based on BF and IBF |
| 2 | ===================================================== |
| Ashlesh Gawande | 465d149 | 2019-01-10 15:12:01 -0600 | [diff] [blame] | 3 | |
| 4 | PSync is an ndn-cxx based C++ library for name synchronization that uses |
| 5 | |
| 6 | PSync library implements the `PSync protocol <https://named-data.net/wp-content/uploads/2017/05/scalable_name-based_data_synchronization.pdf>`_. It uses Invertible |
| 7 | Bloom Lookup Table (IBLT), also known as Invertible Bloom Filter (IBF), to represent the state |
| 8 | of a producer in partial sync mode and the state of a node in full sync mode. An IBF is a compact data |
| 9 | structure where difference of two IBFs can be computed efficiently. |
| 10 | In partial sync, PSync uses a Bloom Filter to represent the subscription of list of the consumer. |
| 11 | PSync uses `ndn-cxx <https://github.com/named-data/ndn-cxx>`_ library as NDN development |
| 12 | library. |
| 13 | |
| 14 | PSync is an open source project licensed under LGPL 3.0 (see ``COPYING.md`` for more |
| 15 | detail). We highly welcome all contributions to the PSync code base, provided that |
| 16 | they can be licensed under LGPL 3.0+ or other compatible license. |
| 17 | |
| 18 | Please submit any bugs or issues to the `PSync issue tracker |
| 19 | <https://redmine.named-data.net/projects/PSync/issues>`__. |
| 20 | |
| 21 | PSync Documentation |
| 22 | ------------------- |
| 23 | |
| 24 | .. toctree:: |
| 25 | :hidden: |
| 26 | :maxdepth: 3 |
| 27 | |
| 28 | install |
| 29 | examples |
| 30 | RELEASE-NOTES |
| 31 | releases |
| 32 | |
| 33 | - :doc:`install` |
| 34 | - :doc:`examples` |
| 35 | - :doc:`RELEASE-NOTES` |
| 36 | - :doc:`releases` |