Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/linux-china/rsocket-deno
🦕RSocket Deno module
https://github.com/linux-china/rsocket-deno
deno rsocket
Last synced: 3 months ago
JSON representation
🦕RSocket Deno module
- Host: GitHub
- URL: https://github.com/linux-china/rsocket-deno
- Owner: linux-china
- License: apache-2.0
- Created: 2020-05-27T02:25:30.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-07-04T08:06:45.000Z (over 3 years ago)
- Last Synced: 2024-10-17T03:17:59.997Z (4 months ago)
- Topics: deno, rsocket
- Language: TypeScript
- Homepage:
- Size: 174 KB
- Stars: 11
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
RSocket Deno module
===================
🦕Deno library to create/consume async RSocket services.
# What is RSocket?
RSocket is a binary protocol for use on byte stream transports such as TCP and WebSocket.
It enables the following symmetric interaction models via async message passing over a single connection:
* request/response (stream of 1)
* request/stream (finite stream of many)
* fire-and-forget (no response)
* channel (bi-directional streams)
Yes, RSocket is designed for async/reactive communication between services.
# How to use?
Now RSocket Deno is under active development, please execute following command to make sure all code are updated to last version.
```
deno run --reload https://deno.land/x/rsocket/mod.ts
```
### Start RSocket Server with Deno
```
$ deno run --allow-net https://deno.land/x/rsocket/rsocket_server.ts
```
and RSocket server side code as following:
```typescript
import {
RSocketServer,
forRequestResponse,
Payload
} from "https://deno.land/x/rsocket/mod.ts"
await RSocketServer.create(forRequestResponse(
async (payload: Payload): Promise => {
console.log(`Received: ${payload.getDataUtf8()} `)
return Payload.fromText("Hello, this is Deno Server!", "");
})
).bind("tcp://0.0.0.0:42252");
console.log("RSocket Server started on 0.0.0.0:42252")
```
### Start RSocket requester to test async RPC call
```
$ deno run --allow-net https://deno.land/x/rsocket/rsocket_client.ts
```
and RSocket client side code as following:
```typescript
import {
RSocketConnector,
Payload
} from "https://deno.land/x/rsocket/mod.ts"
const rsocket = await RSocketConnector.create().connect("tcp://127.0.0.1:42252");
const result = await rsocket.requestResponse(Payload.fromText("Hello, I'm requester!", ""));
console.log(result.getDataUtf8());
```
# Service router and stub
#### Service route for RSocket server side
```typescript
import {
RSocketServer,
RSocket,
ConnectionSetupPayload,
RSocketRouteHandler
} from "https://deno.land/x/rsocket/mod.ts"
//RSocket Service
class UserService {
async findNickById(id: number): Promise {
return "DenoServer";
}
}
const server = await RSocketServer.create({
accept(setup: ConnectionSetupPayload, sendingSocket: RSocket) {
return RSocketRouteHandler.fromHandler("com.example.UserService", new UserService());
}
}).bind("tcp://127.0.0.1:42252");
```
### Service stub for requester side
```typescript
import {RSocketConnector, buildServiceStub} from "https://deno.land/x/rsocket/mod.ts"
const rsocket = await RSocketConnector.create().connect("tcp://127.0.0.1:42252");
interface UserService {
findNickById(id: number): Promise;
}
const userService = buildServiceStub(rsocket, "com.example.UserService")
let nick = await userService.findNickById(1);
console.log(nick)
```
# WebSocket support
Just use "ws://127.0.0.0:42252" format.
# Interoperate with Spring Boot RSocket
* Deno Spring Boot integration: https://github.com/linux-china/rsocket-deno-service
* springRSocket_test.ts: https://deno.land/x/rsocket/tests/requester/springRSocket_test.ts
# Reactive streams interoperation with RxJS
Reactive Streams supplies interoperation with RxJS, such as Publisher to Observable or Observable to Publisher.
```typescript
// @deno-types="https://deno.land/x/types/rxjs/v6.5.5/rxjs.d.ts"
import {Observable, range, of} from "https://cdn.pika.dev/[email protected]";
// @deno-types="https://deno.land/x/types/rxjs/v6.5.5/operators.d.ts"
import operators from 'https://dev.jspm.io/[email protected]/operators';
const {map, filter} = operators;
import { publisherToObservable, observableToPublisher } from "https://deno.land/x/rsocket/reactivestreams/rxjs.ts"
```
or you can use https://deno.land/x/rxjs
```typescript
import {Observable} from "https://deno.land/x/rxjs/mod.ts";
import {map, last} from "https://deno.land/x/rxjs/src/operators/index.ts";
```
# TODO
#### RSocket
- Operations
- [x] REQUEST_FNF
- [x] REQUEST_RESPONSE
- [x] REQUEST_STREAM
- [x] REQUEST_CHANNEL
- [x] METADATA_PUSH
- More Operations
- [x] Error
- [ ] Cancel
- [x] Keepalive
- QoS
- [ ] RequestN
- [ ] Lease
- Transport
- [x] TCP
- [x] Websocket
- High Level APIs
- [x] Client
- [x] Server
- Misc
- [x] RxJS
# References
* RSocket: https://rsocket.io/
* Deno: https://deno.land/
* RSocket-JS: https://github.com/rsocket/rsocket-js
* RxJS: https://github.com/ReactiveX/rxjs
* rxjs-for-await: https://github.com/benlesh/rxjs-for-await
* IxJS: Interactive Extensions for JavaScript https://github.com/ReactiveX/IxJS