A synchronized, distributed P2P mesh data structure using WebRTC data channels
NOTE: From version
rtc-mesh is now an
(which is heaps better and cleaner).
rtc-mesh module provides a way of sharing data between clients using
var quickconnect = require'rtc-quickconnect';var mesh = require'rtc-mesh';// initialise the connectionvar qc = quickconnect''room: 'meshdemo-simple';// create the modelvar model = meshqc;// report data change eventsmodelon'change'console.log'captured change key: "' + key + '" set to ' value;;modelset'lastjoin' Datenow;
Here's an example using CRDT:
var quickconnect = require'rtc-quickconnect';var mesh = require'rtc-mesh';var Doc = require'crdt'Doc;var uuid = require'uuid';// initialise the connectionvar qc = quickconnect''room: 'meshdemo-crdt';// create the modelvar model = meshqc model: ;modelon'add'console.log'new row created: ' row;;modeladd id: uuidv4 name: 'Fred' ;
It's also possible to create invoke multiple meshes on a single data
channel using custom channel names (by default the a channel is created with
the name of
var quickconnect = require'rtc-quickconnect';var mesh = require'rtc-mesh';// initialise the connectionvar qc = quickconnect''room: 'meshdemo-multichannel';// create the modelsvar modelA = meshqc channelName: 'm1' ;var modelB = meshqc channelName: 'm2' ;// report data change eventsmodelAon'change'console.log'captured change for item in a: ' arguments;;modelBon'change'console.log'captured change for item in b: ' arguments;// update some keysmodelAset'lastjoin' Datenow;modelBset'lastRandom' Mathrandom * 10000 | 0;
mesh(qc, opts?) => Model
As displayed in the examples, the
mesh function expects to be passed a
quickconnect created signaller. Using
this object, it will create a data channel that will be responsible for sharing
scuttlebutt model information with peers.
In addition to the functions exposed by a scuttlebutt Model, the following helpers have also been added:
Get the value of the specified key and pass the result back through the
callback (node error first style). If the value is already
available in the local Model, then the callback will be triggered immediately.
If not, the callback will be triggered once the value has been set in the
Copyright 2014 National ICT Australia Limited (NICTA)
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.