JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1380803
  • Score
    100M100P100Q181289F
  • License MIT

Abstract messaging protocol

Package Exports

  • amp

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (amp) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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