plasmid

A low-level implementation of the anti-entropy gossip protocol scuttlebutt.

API

var plasmid = require('plasmid')

var host = new plasmid.Host(id, [opts])

Create a new gossip host/participant uniquely identified by the provided id (must be unique within all participants). The behavior of the host can be adjusted with the following options:

• ordering - (default: depth) (breadth|depth)
• state - (default: LocalState) the state

var p = new plasmid.Host(1)

host.set(key, value)

Sets the local key to value.

host.get(key)

Gets the value for local key.

host.exchange()

Create a transform stream used to receive digests and respond with deltas accordingly (through whatever transport channel you want).

Caution: create a single stream per connection and do not reuse one stream to connect multiple hosts together.

var hostStream = host.createStream([opts])

Create a duplex stream used to send the digest and receive deltas (through whatever transport channel you want). The behavior of the stream can be adjusted with the following options:

• end - (default: true) whether the stream should end after completing to send its digest

var p = new plasmid.Host()
var q = new plasmid.Host()

var ps = ps.createStream()
ps.pipe(q.exchange()).pipe(ps)

Caution: create a single stream per connection and do not reuse one stream to connect multiple hosts together.

hostStream.gossip()

Manually trigger the gossip.

var ps = ps.createStream({ end: false })
ps.pipe(q.exchange()).pipe(ps)

ps.gossip()

new LocalState([opts])

The behavior of the local state can be adjusted with the following options:

• history - (default: true) whether to sync the full history of a key value pair instead of just syncing the most recent value

var p = new plasmid.Host(1, {
  state: new plasmid.State({ history: false })
})

MIT License

Copyright (c) 2014 Markus Ast

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.