A network swarm that uses discovery-channel to find and connect to peers.
This module implements peer connection state and builds on discovery-channel which implements peer discovery. This uses TCP sockets by default and has experimental support for UTP.
npm install discovery-swarm
var swarm =var sw =swsw // can be any id/name/hashsw
var sw = swarm(opts)
Create a new swarm. Options include:
id: crypto // peer-id for userstream: stream // stream to replicate across peersconnect: fn // connect local and remote streams yourselfutp: true // use utp for discoverytcp: true // use tcp for discoverymaxConnections: 0 // max number of connections.whitelist: // array of ip addresses to restrict connections to
For full list of
opts take a look at discovery-channel
sw.join(key, [opts], [cb])
Join a channel specified by
key (usually a name, hash or id, must be a Buffer or a string). After joining will immediately search for peers advertising this key, and re-announce on a timer.
If you pass
opts.announce as a falsy value you don't announce your port (e.g. you will be in discover-only mode)
If you specify cb, it will be called when the first round of discovery has completed. But only on the first round.
Leave the channel specified
Number of peers we are trying to connect to
Number of peers discovered but not connected to yet
List of connections to other peers.
sw.on('connection', connection, info)
Emitted when you connect to another peer. Info is an object that contains info about the connection
type: 'tcp' // the type, tcp or utpinitiator: true // whether we initiated the connection or someone else didchannel: // the channel this connetion was initiated on. only set if initiator === truehost: '127.0.0.1' // the remote address of the peer.port: 8080 // the remote port of the peer.id: // the remote peer's peer-id.
Listen on a specific port. Should be called before add