alldata-peer-client-http

AllData Peer HTTP client module

npm install alldata-peer-client-http
6 downloads in the last week
15 downloads in the last month

alldata-peer-client-http

Stability: 1 - Experimental

NPM version

Peer Client HTTP module for AllData, a distributed master-less write-once immutable event store database implementing "All Data" part of Lambda Architecture.

Usage

var AllDataPeerClient = require('alldata-peer-client-http');
var AllDataKeygen = require('alldata-keygen');

var allDataPeerClient = new AllDataPeerClient({
    method: "POST",
    path: "/_put",
    port: 80 
});

var event1 = {customer: 1, action: "site visit"};
var key1 = AllDataKeygen.createKey();

allDataPeerClient._put({hostname: "first.peer.com"}, key1, event1, function (error) {
    if (error) {
        console.log("Saving event1 failed on first peer: " + error.message);
    } else {
        console.log("Saving event1 succeeded on first peer.");
    }
});

allDataPeerClient._put({hostname: "second.peer.com"}, key1, event1, function (error) {
    if (error) {
        console.log("Saving event1 failed on second peer: " + error.message);
    } else {
        console.log("Saving event1 succeeded on second peer.");
    }
});

Test

npm test

Overview

AllDataPeerClient is a Peer HTTP client for AllData. Once configured, it generates _put requests to other peers via HTTP in order to implement various consistency levels for AllData.

Documentation

AllDataClient

Public API

new AllDataPeerClient(options)

  • options: Object
    • method: String (Default: POST) HTTP method.
    • path: String (Default: /) HTTP request path.
    • port: Number (Default: 80) HTTP port of remote server.

Creates a new instance of AllDataPeerClient.

allDataPeerClient._put(options, key, event, callback)

  • options: Object HTTP options specific to this _put.
    • hostname: String HTTP hostname of the AllData peer.
    • method: String (Default: as specified in constructor options.method) HTTP method.
    • path: String (Default: as specified in constructor options.path) HTTP request path.
    • port: Integer (Default: as specified in constructor options.port) HTTP port of remote server.
  • key: String AllData key generated for the event.
  • event: Object JavaScript object representing the event to store.
  • callback: Function function (error) {} Callback to call in case of success or failure.

Attempts to store the event with specified key at AllData peer specified in options.hostname via HTTP. callback must be provided and it will be called with an Error instance if an error occurs or with no parameters otherwise.

allDataPeerClient._put({hostname: "first.peer.com"}, key1, event1, function (error) {
    if (error) console.log('put failed: ' + error.message); 
});
npm loves you