Skip to content
Collection of composable P2P libraries
OCaml Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib dune: deps Oct 27, 2019
test cycylon, vicinity, ringcast, poldercast Oct 27, 2019
.gitignore cycylon, vicinity, ringcast, poldercast Oct 27, 2019
.travis.yml travis Oct 27, 2019
LICENSE.md cycylon, vicinity, ringcast, poldercast Oct 27, 2019
Makefile
README.md cycylon, vicinity, ringcast, poldercast Oct 27, 2019
dune-project cycylon, vicinity, ringcast, poldercast Oct 27, 2019
p2p-cyclon-lwt.opam dune: deps Oct 27, 2019
p2p-cyclon.opam dune: deps Oct 27, 2019
p2p-poldercast-lwt.opam dune: deps Oct 27, 2019
p2p-poldercast.opam dune: deps Oct 27, 2019
p2p-ringcast-lwt.opam
p2p-ringcast.opam dune: deps Oct 27, 2019
p2p-vicinity-lwt.opam dune: deps Oct 27, 2019
p2p-vicinity.opam dune: deps Oct 27, 2019
p2p.opam dune: deps Oct 27, 2019

README.md

Build Status

Gossip-based protocols for P2P collaboration

P2Pcollab is a collacection of composable libraries implementing gossip-based protocols for P2P collaboration.

These libraries are distributed under the AGPL-3.0-only license.

Modules

  • PolderCast: P2P topic-based pub/sub
  • RingCast: P2P hybrid dissemination
  • VICINITY: P2P clustering & topology management
  • CYCLON: Random Peer Sampling

Installation

The libraries can be installed via opam:

opam install p2p
opam install p2p-cyclon
opam install p2p-cyclon-lwt
opam install p2p-vicinity
opam install p2p-vicinity-lwt
opam install p2p-ringcast
opam install p2p-ringcast-lwt
opam install p2p-poldercast
opam install p2p-poldercast-lwt

Building

To build from source, generate documentation, and run tests, use dune:

dune build
dune build @doc
dune runtest -f -j1 --no-buffer

In addition, the following Makefile targets are available as a shorthand for the above:

make
make build
make doc
make test

Documentation

The documentation and API reference is generated from the source interfaces. It can be consulted online or via odig, e.g.:

odig doc p2p
odig doc p2p-cyclon
...
You can’t perform that action at this time.