Home

Welcome to the nepl wiki!

nepl

This is asynchronous and reliable connection protocol for node.
You can install via npm. (https://npmjs.org/package/nepl)

what is this?

This is node asyncronous transaction connection module. You can use this module when you want to connect other server in asynchronous timing and reliable context. In addition to this, you can use any task with this module. These task is done by process called by 'Consumer'. Only you have to do is making consumer. Therefore you have asynchrounous timing and reliable context.

how to use

Step1. Install via npm

$ npm install -g nepl

Step2. Create NeplReader

    var nepl = require('nepl');
	
	// Define your consumer
	var cons = function(txEntry){
	    for( var i = 0 ; i < txEntry.txs.length ; i++ ){
		    console.log('txString', txEntry.txs[i].txString);
		}
	};

	// Define reader configure
	var config = {
	    name = 'txReader',
		volume = '/from/where/to/somewhere/txvol',
		meta   = '/from/where/to/somewhere/meta',
		consumer : cons
	};

	// Create reader
	var nr = new nepl.NeplReader(config);

Step3. Start reader

$ node reader.js

If any transaction logs are written in /from/where/to/somewhere/txvol, this reader read these transactions and passes these to your consumer. You can access these transaction logs via NeplTX. NeplTX is an object like below.

> ntx;
{ context: 
   { timestamp: 1353326701068,
     writer: '/opt/local/lib/node_modules/nepl/NeplTX.js' },
  payload: { p1: 'prop1' } }

This object has two property. Context and payload. Context is meta data, therefore you don't have to modify this property. Your data has to be written in payload as javascript object. You can use it.

With writeToVol method in this object, you can write data to your transaction volume more easily. So the last thing you have to do is to create writer with this NeplTX.

Step 4. Create writer

    var nepl = require('nepl');
	
	var payload = {};
	payload['p1'] = 'prop1';
	payload['p2'] = 'prop2';
	
	var ntx = new nepl.NeplTX();
	tx.setPayload(payload);
	tx.writeToVol('/from/where/to/somewhere/txvol');

Reference

1. Author Blog
2. Mail

License

Distributed under the [MIT License][mit].

Copyright © 2012 Kai Sasaki (lewuathe at gmail.com)

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.

MIT License