dhash2

dhash2 is a distributed data store based on the DHash protocol.

Installation

$ npm install thenativeweb/dhash2

Quick start

First you need to add a reference to dhash2.

var DHash = require('dhash2');

Then create a new node by calling the constructor function and specifying the host and the port to listen on.

var dhash = new DHash({
  host: 'localhost',
  port: 3000
});

To join another node, call the join function and provide the host and the port of the node you want to join.

dhash.join({
  host: 'localhost',
  port: 4000
}, function (err) {
  // ...
});

To store data, use the put function and provide a key as well as the value you want to store. To load data, use the get function and provide the key of the value you are looking for.

dhash.put('foo', { bar: 'baz' }, function (err) {
  dhash.get('foo', function (err, value) {
    console.log(value); // => { bar: 'baz' }
  });
});

Running the build

This module can be built using Grunt. Besides running the tests, this also analyses the code. To run Grunt, go to the folder where you have installed dhash2 and run grunt. You need to have grunt-cli installed.

$ grunt

License

The MIT License (MIT) Copyright (c) 2015 the native web.

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.