https://github.com/tj/node-amp
Abstract message protocol for nodejs
https://github.com/tj/node-amp
Last synced: 9 months ago
JSON representation
Abstract message protocol for nodejs
- Host: GitHub
- URL: https://github.com/tj/node-amp
- Owner: tj
- Created: 2013-10-28T02:26:45.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2019-01-03T11:21:27.000Z (about 7 years ago)
- Last Synced: 2025-04-14T22:13:11.419Z (9 months ago)
- Language: JavaScript
- Size: 16.6 KB
- Stars: 134
- Watchers: 6
- Forks: 16
- Open Issues: 2
-
Metadata Files:
- Readme: Readme.md
- Changelog: History.md
Awesome Lists containing this project
README
# amp
Abstract Message Protocol codec and streaming parser for nodejs.
## Installation
```
$ npm install amp
```
## Example
```js
var bin = amp.encode([Buffer.from('hello'), Buffer.from('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
`` / `` pairs, where `length` is a 32-bit unsigned integer.
```
0 1 2 3 4 ...
+------------+----------+------------+
| | | | additional arguments
+------------+----------+------------+
```
# License
MIT