Abstract message protocol for nodejs
JavaScript
Switch branches/tags
Latest commit f48c5bd Nov 14, 2013 TJ Holowaychuk Release 0.3.1
Permalink
Failed to load latest commit information.
benchmarks Initial commit Oct 28, 2013
examples Initial commit Oct 28, 2013
lib fix missing offset warning in 0.10.x buffer usage Nov 13, 2013
test change to emit framed buffer instead of arguments Oct 30, 2013
.gitignore Initial commit Oct 28, 2013
History.md Release 0.3.1 Nov 13, 2013
Makefile Initial commit Oct 28, 2013
Readme.md docs Oct 31, 2013
index.js Initial commit Oct 28, 2013
package.json Release 0.3.1 Nov 13, 2013

Readme.md

amp

Abstract Message Protocol codec and streaming parser for nodejs.

Installation

$ npm install amp

Example

var bin = amp.encode([new Buffer('hello'), new Buffer('world')]);
var msg = amp.decode(bin);
console.log(msg);

Protocol

AMP is a simple versioned protocol for framed messages containing zero or more "arguments". Each argument is opaque binary, thus you may use JSON, BSON, msgpack and others on top of AMP. Multiple argument support is used to allow a hybrid of binary/non-binary message args without requiring higher level serialization libraries like msgpack or BSON.

All multi-byte integers are big endian. The version and argc integers are stored in the first byte, followed by a sequence of zero or more <length> / <data> pairs, where length is a 32-bit unsigned integer.

      0        1 2 3 4     <length>    ...
+------------+----------+------------+
| <ver/argc> | <length> | <data>     | additional arguments
+------------+----------+------------+

License

MIT