https://github.com/chat-wane/rtc-SCAMP

In your future... I see a cab ride. Move out of the sticks, gentlemen.
https://github.com/chat-wane/rtc-SCAMP

Last synced: 9 days ago
JSON representation

In your future... I see a cab ride. Move out of the sticks, gentlemen.

• Host: GitHub
• URL: https://github.com/chat-wane/rtc-SCAMP
• Owner: Chat-Wane
• License: mit
• Created: 2015-01-05T13:12:44.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-02-27T13:35:23.000Z (over 9 years ago)
• Last Synced: 2024-09-25T16:58:08.192Z (about 1 month ago)
• Language: JavaScript
• Size: 1.11 MB
• Stars: 7
• Watchers: 6
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-peer-to-peer - rtc-SCAMP
• awesome-peer-to-peer - rtc-SCAMP

README

        
# rtc-SCAMP

Keywords: SCAMP, scalable membership, gossip, epidemic dissemination,

WebRTC

This project is an attempt to provide a full browser gossip protocol with

random peer sampling. More specifically, it implements the Scalable Membership

Protocol (SCAMP) [1] which is a gossip that automatically resizes its

neighbourhood tables in order to fit with the size of the network using local

knowledge only.

The Project rtc-SCAMP uses [WebRTC](http://www.webrtc.org) which allows

creating peer-to-peer connections within the browser. To our knowledge, there

do not exist any implementations which do not rely on a central server to

ease the initialisation phase of the membership. Thus, this project aims to

fill this gap. Such implementation would allow building distributed network

by only manually sharing a piece of data (e.g. by mail).

## Installation

You can get the module using the node packet manager: ``` $ npm install rtc-scamp```

Or using bower: ```$ bower install rtc-scamp```

## Usage

This module creates a network which implements the [p2pnetwork

API](https://github.com/justayak/network). It uses

[rtc-scamp-mbr](http://github.com/chat-wane/rtc-scamp-mbr) for the membership

part, i.e., how a peer can join the network. It uses

[bounded-broadcast-definition](https://github.com/Chat-Wane/BoundedBroadcastDefinition.git)

for the epidemic dissemination of messages which collects the unique identifier

of each message so they are broadcast only once.

## Example

The example is hosted [here](http://chat-wane.github.io/rtc-SCAMP/). The code

can be found on the

[gh-branch](https://github.com/Chat-Wane/rtc-SCAMP/tree/gh-pages) of this

project. To use it, follow the steps:



  
Open the link with any WebRTC compatible web browser (e.g. Chrome)

  
Click on "1. Make offer". 3 seconds later, a string appears in the

  text area. Copy the string.

  
Open a new tab with the same link and paste the string inside the

  empty textarea.

  
Click on "2. Accept offer". 3 seconds later, the string in the text area

  changes. Copy the string.

  
In the first tab, erase the text area and paste string.

  
Click on "3. Confirm handshake"

  
The connection has started between the two tabs



To connect more peers, follow the same process: create a new tab, generate the

offer, copy it to a tab which is already connected to the network and click on

"2. Accept offer". Few seconds later, the text changes. Copy it to the new tab

and "3. Handshake".  The peer is now connected to the network.

In this example, each peer regularly broadcasts their name. Also, when they

receive a broadcast message, they print it in the page. Normally, in each

connected tab, the name of every other peers should appear.

## References

[1] [Peer-to-Peer Membership Management for Gossip-Based Protocols](http://pages.saclay.inria.fr/laurent.massoulie/ieee_tocs.pdf)