Files: 89ecb61d9b081d818fab05349582c44773bfdf94 / tmpl / apis / scuttlebot / gossip.md
1300 bytesRaw
scuttlebot gossip plugin
Schedule connections randomly with a peerlist constructed from config, multicast UDP announcements, feed announcements, and API-calls.
peers: sync
Get the current peerlist.
peers
peers(cb)
add: sync
Add an address to the peer table.
add {addr}
add --host {string} --port {number} --key {feedid}
add(addr, cb)
add({ host:, port:, key: }, cb)
addr
(address string): An address string, of the following format:hostname:port:feedid
.host
(host string): IP address or hostname.port
(port number)key
(feedid)
connect: async
Add an address to the peer table, and connect immediately.
connect {addr}
connect --host {string} --port {number} --key {feedid}
connect(addr, cb)
connect({ host:, port:, key: }, cb)
addr
(address string): An address string, of the following format:hostname:port:feedid
.host
(host string): IP address or hostname.port
(port number)key
(feedid)
changes: source
Listen for gossip events.
changes
changes()
Events come in the following forms:
{ type: 'discover', peer:, source: }
{ type: 'connect', peer: }
{ type: 'connect-failure', peer: }
{ type: 'disconnect', peer: }
Built with git-ssb-web