Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mostroverkhov committed Aug 21, 2023
1 parent 5d530a6 commit d2dcb94
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Very fast GRPC-like & GRPC-compatible services on JVM with rich streaming models

>multiple APIs: CompletableFuture or virtual threads; traditional streaming with GRPC-API (StreamObserver), or flavor of reactive: smallrye-mutiny, rxjava, reactor;
>
>pluggable networking: TCP, unix sockets, GRPC, websockets, websockets-over-http2;
>pluggable networking: TCP, unix sockets, VM sockets, GRPC, websockets, websockets-over-http2;
>
>service APIs / RPC codegen stubs (Message-Streams) are split from library runtime (RSocket-JVM, including network transports, load estimators, metrics);
>
Expand Down Expand Up @@ -77,7 +77,7 @@ Network transports are based on `Netty` only for compatibility with each vendor

Currently comprised of

* `TCP` & `UNIX domain sockets` - known efficient byte stream protocols for datacenter / inter-process communication;
* `TCP`, `UNIX domain sockets` & `VM sockets` - known efficient byte stream protocols for datacenter / inter-process communication;

and Http2 streams based transports for interop:

Expand All @@ -95,7 +95,8 @@ and Http2 streams based transports for interop:

## Build

Building `jauntsdn/RSocket-jvm` requires java11+ (for helidon-commons-reactive), while the rest (futures/grpc-stubs/rxjava/reactor/mutiny) are java8+.
Building `jauntsdn/RSocket-jvm` requires java20 for virtual threads API, java11+ for smallrye-mutiny;
futures / grpc-stubs / rxjava / reactor are java8+.
```
./gradlew
```
Expand All @@ -107,7 +108,7 @@ Building & installing artifacts into local maven repository

## Binaries

Binary releases are published on Maven Central for grpc, futures (CompletableFuture), reactor, rxjava, helidon & mutiny libraries.
Binary releases are published on Maven Central for virtual threads, futures (CompletableFuture), grpc stubs, reactor, rxjava & mutiny libraries.

```groovy
Expand Down Expand Up @@ -162,8 +163,8 @@ is essential for JVM-only Message Streams (RSocket-JVM) libraries.
**Shared transports**

Transports are shared, and considered part of runtime due to tight contract with RSocket-JVM for performance reasons.
This project offers strictly few highly optimized transports for interprocess/datacenter (TCP, UNIX sockets)
and cross-datacenter (GRPC-RSocketRPC, websocket, websocket-over-htp2) communication, instead of user-friendly APIs for
This project offers strictly few highly optimized transports for interprocess/datacenter (TCP, UNIX sockets, VM sockets)
and cross-datacenter (GRPC-RSocketRPC, websocket, websocket-over-http2) communication, instead of user-friendly APIs for
external implementors. This way if supported transports are extended or replaced, transport contract
is free to change to accommodate new needs.

Expand Down

0 comments on commit d2dcb94

Please sign in to comment.