https://github.com/yyyar/yamp-js
JavaScript implementation of a Yamp protocol client and server
https://github.com/yyyar/yamp-js
Last synced: 7 months ago
JSON representation
JavaScript implementation of a Yamp protocol client and server
- Host: GitHub
- URL: https://github.com/yyyar/yamp-js
- Owner: yyyar
- License: mit
- Created: 2017-06-12T15:37:13.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-07-08T07:56:26.000Z (about 8 years ago)
- Last Synced: 2025-01-07T08:49:34.147Z (9 months ago)
- Language: JavaScript
- Size: 113 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# yamp-js [](https://travis-ci.org/yyyar/yamp-js)
yamp-js is implementation of [yamp protocol](https://github.com/yyyar/yamp) in JavaScript.
**Status: under development.** May contain critical bugs, not suitable for production usage.
## Features
* Full Yamp v1.0 draft implementation: handshake, events, res/res, progressive responses, request cancelling.
* Works both in Node.Js and in Browser (websocket).
* Pluggable body serializers. Built-in JSON and MsgPack.
* TCP and Websocket transports.
## Basic Example
Yamp allows bi-directional message transfer between two parties. The following
example covers most simple use case and shows basic events and request/response
handling using websocket transfer and json serialization format.
Node.Js (Server):
```javascript
const Yamp = require('yamp-js');
/* Create server and listen for clients */
let server = Yamp.createServer("websocket", {host: '0.0.0.0', port: 8888}, {type: 'json'}).serve();
server.on('connection', (conn) => {
console.log('New connection ', conn.remoteAddress);
conn.on('close', (reason) => {
console.log('Connection to ' + conn.remoteAddress + ' closed', reason);
});
/* handle event */
conn.onEvent('foo', (obj) => {
console.log('Got ', obj, 'from client');
});
/* handle request */
conn.onRequest('sum', (ctx, a, sendResponse) => {
if (!Array.isArray(a)) {
return sendResponse("Error. Not an array");
}
let result = a.reduce( (acc, val) => { return acc + val; }, 0);
sendResponse(null, result);
});
/* send request to client */
conn.sendRequest('mul-on-client', [1,2,3], (err, res) => {
console.log('Got response: ', err, res);
});
});
```
Browser JavaScript (Client):
```html
Yamp.createClient('websocket-browser', {url: 'ws://localhost:8888'}).connect((err, conn) => {
if (err) {
return console.log('Cant open connection: ' + err);
}
conn.on('close', () => {
console.log('Connection closed');
})
/* handle request on client */
conn.onRequest('mul-on-client', (ctx, a, sendResponse) => {
if (!Array.isArray(a)) {
return sendResponse("Error. Not an array");
}
let result = a.reduce( (acc, val) => { return acc * val; }, 1);
sendResponse(null, result);
});
/* Send simple event to server */
conn.sendEvent('foo', {anything:['you', 'want']});
/* Send request and get response */
conn.sendRequest('sum', [1,2,3,4,5], function(err, res) {
console.log("Got response: ", err, res);
});
});
```
For more examples see `examples` directory.
## API Documentation
TODO
## License
MIT. See LICENSE file for more details.
## Author
- [Yaroslav Pogrebnyak](http://pogrebnyak.info)