Gitiles
Code Review Sign In
gerrit.named-data.net / ChronoSync / 55492d5a146b2102b6349a8f6f5d2b152e7d6521
commit55492d5a146b2102b6349a8f6f5d2b152e7d6521[log] [tgz]
authorDavide Pesavento <davidepesa@gmail.com>Mon Sep 19 18:38:02 2022 -0400
committerDavide Pesavento <davidepesa@gmail.com>Mon Sep 19 18:38:02 2022 -0400
treeff94b9ecfd466293f6e9c11b7398c7263a61aa5d
parent15a7442759a0bdb1e5089735cc15fe6a11f3b67c [diff]
docs: simplify conf.py and fix compatibility with upcoming Sphinx 6.0

Change-Id: I970c5691cb4b1879854023a3747c2bf63189c128
6 files changed
tree: ff94b9ecfd466293f6e9c11b7398c7263a61aa5d
  1. .github/
  2. .jenkins.d/
  3. .waf-tools/
  4. docs/
  5. src/
  6. tests/
  7. .gitignore
  8. .jenkins
  9. .mailmap
  10. AUTHORS.md
  11. ChronoSync.pc.in
  12. COPYING.md
  13. README.md
  14. RELEASE_NOTES.md
  15. waf
  16. wscript
README.md

ChronoSync: synchronization library for distributed realtime applications for NDN

CI Docs Language Latest version

DEPRECATION NOTICE: ChronoSync's design is outdated. We recommend using more recent sync protocols, such as PSync or 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, 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 library.

Installation

Prerequisites

Build

To build ChronoSync from the 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 ChronoSync issue tracker.

Contributing

We greatly appreciate contributions to the ChronoSync code base, provided that they are licensed under the GPL 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

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