Davide Pesavento
2ff10561bd
Mention gerrit in the README Change-Id: I468cedde1a15f760aef00ac2995dd5f73728b89e
61 lines
2.9 KiB
Markdown
61 lines
2.9 KiB
Markdown
# ChronoSync: synchronization library for distributed realtime applications for NDN
|
|
|
|
[](https://github.com/named-data/ChronoSync/actions/workflows/ci.yml)
|
|
[](https://github.com/named-data/ChronoSync/actions/workflows/docs.yml)
|
|
|
|
|
|
|
|
> DEPRECATION NOTICE: ChronoSync's design is outdated. We recommend using more recent sync protocols, such as [PSync](https://github.com/named-data/PSync) or [StateVectorSync](https://named-data.github.io/StateVectorSync/).
|
|
|
|
In supporting many distributed applications, such as group text messaging, file sharing,
|
|
and joint editing, a basic requirement is the efficient and robust synchronization of
|
|
knowledge about the dataset such as text messages, changes to the shared folder, or
|
|
document edits. This library implements the
|
|
[ChronoSync protocol](https://named-data.net/wp-content/uploads/2014/03/chronosync-icnp2013.pdf),
|
|
which exploits the features of the Named Data Networking architecture to efficiently
|
|
synchronize the state of a dataset among a distributed group of users. Using appropriate
|
|
naming rules, ChronoSync summarizes the state of a dataset in a condensed cryptographic
|
|
digest form and exchange it among the distributed parties. Differences of the dataset can
|
|
be inferred from the digests and disseminated efficiently to all parties. With the
|
|
complete and up-to-date knowledge of the dataset changes, applications can decide whether
|
|
or when to fetch which pieces of the data.
|
|
|
|
ChronoSync uses the [ndn-cxx](https://github.com/named-data/ndn-cxx) library.
|
|
|
|
## Installation
|
|
|
|
### Prerequisites
|
|
|
|
* [ndn-cxx and its dependencies](https://docs.named-data.net/ndn-cxx/current/INSTALL.html)
|
|
|
|
### Build
|
|
|
|
To build ChronoSync 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
|
|
[ChronoSync issue tracker](https://redmine.named-data.net/projects/chronosync/issues).
|
|
|
|
## Contributing
|
|
|
|
Contributions to ChronoSync are greatly appreciated and can be made through our
|
|
[Gerrit code review site](https://gerrit.named-data.net/).
|
|
If you are new to the NDN software community, please read our [Contributor's Guide](
|
|
https://github.com/named-data/.github/blob/main/CONTRIBUTING.md) to get started.
|
|
|
|
## License
|
|
|
|
ChronoSync is free software distributed under the GNU General Public License version 3.
|
|
See [`COPYING.md`](COPYING.md) for details.
|