https://github.com/named-data/ChronoSync

NDN sync library for multiuser realtime applications (deprecated, use ndn-svs or PSync)
https://github.com/named-data/ChronoSync

cpp library ndn sync

Last synced: 5 days ago
JSON representation

NDN sync library for multiuser realtime applications (deprecated, use ndn-svs or PSync)

• Host: GitHub
• URL: https://github.com/named-data/ChronoSync
• Owner: named-data
• License: gpl-3.0
• Fork: true (zhenkai/sync)
• Created: 2013-03-05T21:30:59.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2024-07-29T01:37:58.000Z (3 months ago)
• Last Synced: 2024-08-01T12:16:30.915Z (3 months ago)
• Topics: cpp, library, ndn, sync
• Language: C++
• Homepage:
• Size: 2.95 MB
• Stars: 26
• Watchers: 12
• Forks: 13
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: COPYING.md

Awesome Lists containing this project

• awesome-starred - named-data/ChronoSync - NDN sync library for multiuser realtime applications (DEPRECATED: use SVS, PSync, or other newer versions of sync) (library)

README

        
# ChronoSync: synchronization library for distributed realtime applications for NDN

![Latest version](https://img.shields.io/github/v/tag/named-data/ChronoSync?label=Latest%20version)

![Language](https://img.shields.io/badge/C%2B%2B-17-blue)

[![CI](https://github.com/named-data/ChronoSync/actions/workflows/ci.yml/badge.svg)](https://github.com/named-data/ChronoSync/actions/workflows/ci.yml)

[![Docs](https://github.com/named-data/ChronoSync/actions/workflows/docs.yml/badge.svg)](https://github.com/named-data/ChronoSync/actions/workflows/docs.yml)

> [!NOTE]

> DEPRECATION NOTICE: ChronoSync's design is outdated. We recommend using more recent

> sync protocols, such as [PSync](https://docs.named-data.net/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.