README.md

ndn-svs: State Vector Sync library for distributed realtime applications for NDN

This library provides an implementation of the State Vector Sync (SVS) protocol and the Pub/Sub API for state synchronization between multiple clients over NDN.

ndn-svs uses the ndn-cxx library.

Installation

Prerequisites

• ndn-cxx and its dependencies

Build

To build ndn-svs 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.

Examples

To try out the demo CLI chat application:

./waf configure --enable-static --disable-shared --with-examples
./waf
./build/examples/chat <prefix>

Configure NFD to be multicast:

nfdc strategy set <sync-prefix> /localhost/nfd/strategy/multicast

Clear the content store of NFD if you restart the example:

nfdc cs erase /

where sync-prefix is /ndn/svs for the example application.

Contributing

Contributions are welcome through GitHub.

License

ndn-svs is free software distributed under the GNU Lesser General Public License version 2.1. See COPYING.md for details.