ChronoSync library

Clone this repo:
  1. 2907a29 build: tweak the version calculation fallback logic by Davide Pesavento · 4 weeks ago master
  2. 34a0b3f build: change the fallback version suffix to `+git.{sha}` by Davide Pesavento · 4 weeks ago
  3. 1fa0861 More prominent deprecation notice by Davide Pesavento · 9 weeks ago
  4. 7558ed2 build: update sphinx tool by Davide Pesavento · 9 weeks ago
  5. 2620684 build: update waf to version 2.0.27 by Davide Pesavento · 10 weeks ago

ChronoSync: synchronization library for distributed realtime applications for NDN

Latest version Language CI Docs

[!NOTE] 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 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.

Contributing

Contributions to ChronoSync are greatly appreciated and can be made through our Gerrit code review site. If you are new to the NDN software community, please read our Contributor's Guide to get started.

License

ChronoSync is free software distributed under the GNU General Public License version 3. See COPYING.md for details.