Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fibjs/fib-rpc
Remote Procedure Calling for fibjs
https://github.com/fibjs/fib-rpc
rpc websocket
Last synced: 3 months ago
JSON representation
Remote Procedure Calling for fibjs
- Host: GitHub
- URL: https://github.com/fibjs/fib-rpc
- Owner: fibjs
- Created: 2017-03-27T13:58:11.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-07-30T18:54:20.000Z (over 5 years ago)
- Last Synced: 2024-07-07T14:47:19.266Z (4 months ago)
- Topics: rpc, websocket
- Language: JavaScript
- Size: 85 KB
- Stars: 0
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
Awesome Lists containing this project
- awesome - fib-rpc - Remote Procedure Calling for fibjs. (Packages / Server App)
README
# fib-rpc
[](https://www.npmjs.org/package/fib-rpc)
[](https://travis-ci.org/fibjs/fib-rpc)
[](https://ci.appveyor.com/project/richardo2016/fib-rpc)
Remote Procedure Calling for fibjs
## Introduction
`fib-rpc` is working on dispatching of remote procedure calling, it supports both http request and websocket(**recommended**).
obviously, it follows [JSON-RPC] protocol.
## Get Started
```
npm i -S fib-rpc
```
## Usage
you can use it with `http.Request`
```javascript
var js_remote = rpc.handler({
foo: function (p1, p2) {
return p1 + ',' + p2;
}
});
function js_call(r) {
var m = new http.Request();
m.value = 'test/tttt/tttt/';
m.json(r);
js_remote(m);
m.response.body.rewind();
return m.response.readAll().toString();
}
var result = js_call({
// method is required
method: 'foo',
// params is required and must be array
params: [100, 200],
// id is required
id: 1234
})
assert.equal(result, '{"id":1234,"result":"100,200"}');
```
but in most cases, you may prefer using it based on `Websocket`, which finshied by `rpc.connect`
```javascript
const ws = require('ws')
const http = require('http')
const rpc = require('fib-rpc')
const svr = new http.Server(8811, ws.upgrade(
rpc.handler(
{
test: function (v1, v2) {
return v1 + v2;
}
}
))
);
svr.asyncRun();
const remoting = rpc.connect("ws://127.0.0.1:8811");
remoting.test(1, 2) // 3
```
Learn `connect` from test case `'websocket rpc'` in [exmaple](./examples/connect.js).
### Custom Errors
use `RpcError` as typed Error thrown if required:
```javascript
const rpc = require('fib-rpc')
const js_remote = rpc.handler(
{
integerAdd: function (v1, v2) {
if (!Number.isInteger(v1) || !Number.isInteger(v2))
throw rpc.rpcError(4010000, 'Addend must be integer')
return v1 + v2;
}
}
);
const svr = new http.Server(8811, ws.upgrade(js_remote));
const remoting = rpc.connect("ws://127.0.0.1:8811");
try {
remoting.integerAdd(1.1, 2)
} catch (err_msg) {
console.log(err_msg) // 'Addend must be integer'
}
console.log(
js_call({
method: 'foo',
params: [1.1, 2],
id: 1234
})
) // code: 4010000, message: 'Addend must be integer'
```
## Samples
View [Samples](./examples), test them like this:
```bash
# build lib first.
npm i && npm run build
# chdir to examples
cd exapmles
npm i
# run example
fibjs ./connect.js
fibjs ./open_handler-js.js
```
[test.js]:test.js#L123:1
[JSON-RPC]:https://www.jsonrpc.org/specification#overview