| 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 | |
| Davide Pesavento | 5118959 | 2021-10-02 22:34:34 -0400 | [diff] [blame] | 4 | PSync is a C++ library for name synchronization that implements the `PSync protocol |
| 5 | <https://named-data.net/wp-content/uploads/2017/05/scalable_name-based_data_synchronization.pdf>`__. |
| 6 | It uses Invertible Bloom Lookup Table (IBLT), also known as Invertible Bloom Filter (IBF), |
| 7 | to represent the state of a producer in partial sync mode and the state of a node in full |
| 8 | sync mode. An IBF is a compact data structure where difference of two IBFs can be computed |
| 9 | efficiently. In partial sync, PSync uses a Bloom Filter to represent the subscription of |
| 10 | list of the consumer. |
| Ashlesh Gawande | 465d149 | 2019-01-10 15:12:01 -0600 | [diff] [blame] | 11 | |
| Davide Pesavento | 5118959 | 2021-10-02 22:34:34 -0400 | [diff] [blame] | 12 | PSync uses the `ndn-cxx <https://github.com/named-data/ndn-cxx>`__ library. |
| Ashlesh Gawande | 465d149 | 2019-01-10 15:12:01 -0600 | [diff] [blame] | 13 | |
| Davide Pesavento | 5118959 | 2021-10-02 22:34:34 -0400 | [diff] [blame] | 14 | Contributing |
| 15 | ------------ |
| Ashlesh Gawande | 465d149 | 2019-01-10 15:12:01 -0600 | [diff] [blame] | 16 | |
| Davide Pesavento | 5118959 | 2021-10-02 22:34:34 -0400 | [diff] [blame] | 17 | We greatly appreciate contributions to the PSync code base, provided that they are |
| 18 | licensed under the LGPL 3.0+ or a compatible license (see `COPYING.md |
| 19 | <https://github.com/named-data/PSync/blob/master/COPYING.md>`__ for more information). |
| 20 | If you are new to the NDN software community, please read the `Contributor's Guide |
| 21 | <https://github.com/named-data/.github/blob/master/CONTRIBUTING.md>`__ to get started. |
| 22 | |
| 23 | Please submit any bug reports or feature requests to the `PSync issue tracker |
| 24 | <https://redmine.named-data.net/projects/psync/issues>`__. |
| Ashlesh Gawande | 465d149 | 2019-01-10 15:12:01 -0600 | [diff] [blame] | 25 | |
| 26 | PSync Documentation |
| 27 | ------------------- |
| 28 | |
| 29 | .. toctree:: |
| 30 | :hidden: |
| Davide Pesavento | 5118959 | 2021-10-02 22:34:34 -0400 | [diff] [blame] | 31 | :maxdepth: 2 |
| Ashlesh Gawande | 465d149 | 2019-01-10 15:12:01 -0600 | [diff] [blame] | 32 | |
| 33 | install |
| 34 | examples |
| 35 | RELEASE-NOTES |
| 36 | releases |
| 37 | |
| 38 | - :doc:`install` |
| 39 | - :doc:`examples` |
| 40 | - :doc:`RELEASE-NOTES` |
| Davide Pesavento | 5118959 | 2021-10-02 22:34:34 -0400 | [diff] [blame] | 41 | - :doc:`releases` |