Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jaguar-dart/jaguar_rpc
A simple JSON based RPC protocol
https://github.com/jaguar-dart/jaguar_rpc
dartlang jaguar json rpc rpc-server server
Last synced: 2 days ago
JSON representation
A simple JSON based RPC protocol
- Host: GitHub
- URL: https://github.com/jaguar-dart/jaguar_rpc
- Owner: Jaguar-dart
- License: other
- Created: 2017-12-23T06:53:26.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-08-22T12:16:49.000Z (about 6 years ago)
- Last Synced: 2023-08-20T22:28:50.232Z (about 1 year ago)
- Topics: dartlang, jaguar, json, rpc, rpc-server, server
- Language: Dart
- Size: 6.67 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# jaguar_rpc
A simple JSON based RPC protocol
# Example
## HTTP
```dart
main() async {
int contactIdGen = 0;
// RPC endpoint
final endpoint = new RpcEndpoint()
..route('/get/version', (_) => response(body: {'major': '1', 'minor': '0'}))
..route('/add/todo', (RpcRequest req) {
final newContact = new Contact.fromJson(req.body);
newContact.id = contactIdGen++;
contacts.contacts.add(newContact);
return response(body: contacts.json);
});
// Serve the endpoint with Jaguar http server
final server = new Jaguar();
server.addApi(rpcOnHttp(endpoint));
await server.serve();
}
```
Client:
```dart
main() async {
final client =
new JsonClient(new http.IOClient(), basePath: 'http://localhost:8080/');
{
final resp =
await client.post('/get/version', body: request('/get/version').toMap);
final rpcResp = new RpcResponse.decodeJson(resp.bodyStr);
print(rpcResp.status);
print(rpcResp.body);
}
{
final resp = await client.post('/add/todo',
body: request('/add/todo',
body: new Contact(name: 'teja', email: '[email protected]')
.json)
.toMap);
final rpcResp = new RpcResponse.decodeJson(resp.bodyStr);
print(rpcResp.status);
print(rpcResp.body);
}
}
```
## Websocket server
```dart
main() async {
int contactIdGen = 0;
// RPC endpoint
final endpoint = new RpcEndpoint()
..route('/get/version', (_) => response(body: {'major': '1', 'minor': '0'}))
..route('/add/todo', (RpcRequest req) {
final newContact = new Contact.fromJson(req.body);
newContact.id = contactIdGen++;
contacts.contacts.add(newContact);
return response(body: contacts.json);
});
// Serve the endpoint with Jaguar http server
final server = new Jaguar();
server.get('/ws', rpcOnWebSocket(endpoint));
await server.serve();
}
```
Client:
```dart
main() async {
// Client
final WebSocket socket = await WebSocket.connect('ws://localhost:8080/ws');
final Stream data =
socket.asBroadcastStream().map((d) => new RpcResponse.decodeJson(d));
{
socket.add(request('/get/version').json);
final RpcResponse rpcResp = await data.first;
print(rpcResp.status);
print(rpcResp.body);
}
{
socket.add(request('/add/todo',
body: new Contact(name: 'teja', email: '[email protected]').toMap)
.json);
final RpcResponse rpcResp = await data.first;
print(rpcResp.status);
print(rpcResp.body);
}
}
```
## WebSocket IO client
```dart
main() async {
// Client
final RpcWebSocketClient socket =
await RpcWebSocketClient.connect('ws://localhost:8080/ws');
{
final RpcResponse rpcResp = await socket.send(request('/get/version'));
print(rpcResp.status);
print(rpcResp.body);
}
{
final RpcResponse rpcResp = await socket.send(request('/add/todo',
body: new Contact(name: 'teja', email: '[email protected]').toMap));
print(rpcResp.status);
print(rpcResp.body);
}
}
```
## Isolate
> TODO
## TCP
> TODO
## Plain
```dart
main() {
int contactIdGen = 0;
final server = new RpcEndpoint()
..route('/get/version', (_) => response(body: {'major': '1', 'minor': '0'}))
..route('/add/todo', (RpcRequest req) {
final newContact = new Contact.fromJson(req.body);
newContact.id = contactIdGen++;
contacts.contacts.add(newContact);
return response(body: contacts.json);
});
{
final RpcResponse resp = server.handleRequest(request('/get/unknown'));
print(resp.status);
}
{
final RpcResponse resp = server.handleRequest(request('/add/todo',
body: new Contact(name: 'teja', email: '[email protected]').json));
print(resp.status);
print(resp.body);
}
}
```
# Native extension
> TODO
# TODO
+ [X] HTTP interface
+ [X] Websocket interface
+ [ ] TCP interface
+ [ ] Isolate interface