Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rsocket/rsocket-java
Java implementation of RSocket
https://github.com/rsocket/rsocket-java
aeron java netty reactive reactor-core rsocket rxjava stream
Last synced: about 2 months ago
JSON representation
Java implementation of RSocket
- Host: GitHub
- URL: https://github.com/rsocket/rsocket-java
- Owner: rsocket
- License: apache-2.0
- Created: 2015-07-08T04:36:42.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-05-25T02:09:33.000Z (4 months ago)
- Last Synced: 2024-06-21T21:44:01.949Z (3 months ago)
- Topics: aeron, java, netty, reactive, reactor-core, rsocket, rxjava, stream
- Language: Java
- Homepage: http://rsocket.io
- Size: 5.94 MB
- Stars: 2,346
- Watchers: 109
- Forks: 352
- Open Issues: 48
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
# RSocket
[](https://gitter.im/rsocket/rsocket-java)
RSocket is a binary protocol for use on byte stream transports such as TCP, WebSockets, and Aeron.
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)
- event subscription (infinite stream of many)
Learn more at http://rsocket.io
## Build and Binaries
[](https://github.com/rsocket/rsocket-java/actions/workflows/gradle-main.yml)
⚠️ The `master` branch is now dedicated to development of the `1.2.x` line.
Releases and milestones are available via Maven Central.
Example:
```groovy
repositories {
mavenCentral()
maven { url 'https://repo.spring.io/milestone' } // Reactor milestones (if needed)
}
dependencies {
implementation 'io.rsocket:rsocket-core:1.2.0-SNAPSHOT'
implementation 'io.rsocket:rsocket-transport-netty:1.2.0-SNAPSHOT'
}
```
Snapshots are available via [oss.jfrog.org](oss.jfrog.org) (OJO).
Example:
```groovy
repositories {
maven { url 'https://maven.pkg.github.com/rsocket/rsocket-java' }
maven { url 'https://repo.spring.io/snapshot' } // Reactor snapshots (if needed)
}
dependencies {
implementation 'io.rsocket:rsocket-core:1.2.0-SNAPSHOT'
implementation 'io.rsocket:rsocket-transport-netty:1.2.0-SNAPSHOT'
}
```
## Development
Install the google-java-format in Intellij, from Plugins preferences.
Enable under Preferences -> Other Settings -> google-java-format Settings
Format automatically with
```
$./gradlew goJF
```
## Debugging
Frames can be printed out to help debugging. Set the logger `io.rsocket.FrameLogger` to debug to print the frames.
## Requirements
- Java 8 - heavy dependence on Java 8 functional APIs and java.time, also on Reactor
- Android O - https://github.com/rsocket/rsocket-demo-android-java8
## Trivial Client
```java
package io.rsocket.transport.netty;
import io.rsocket.Payload;
import io.rsocket.RSocket;
import io.rsocket.core.RSocketConnector;
import io.rsocket.transport.netty.client.WebsocketClientTransport;
import io.rsocket.util.DefaultPayload;
import reactor.core.publisher.Flux;
import java.net.URI;
public class ExampleClient {
public static void main(String[] args) {
WebsocketClientTransport ws = WebsocketClientTransport.create(URI.create("ws://rsocket-demo.herokuapp.com/ws"));
RSocket clientRSocket = RSocketConnector.connectWith(ws).block();
try {
Flux s = clientRSocket.requestStream(DefaultPayload.create("peace"));
s.take(10).doOnNext(p -> System.out.println(p.getDataUtf8())).blockLast();
} finally {
clientRSocket.dispose();
}
}
}
```
## Zero Copy
By default to make RSocket easier to use it copies the incoming Payload. Copying the payload comes at cost to performance
and latency. If you want to use zero copy you must disable this. To disable copying you must include a `payloadDecoder`
argument in your `RSocketFactory`. This will let you manage the Payload without copying the data from the underlying
transport. You must free the Payload when you are done with them
or you will get a memory leak. Used correctly this will reduce latency and increase performance.
### Example Server setup
```java
RSocketServer.create(new PingHandler())
// Enable Zero Copy
.payloadDecoder(PayloadDecoder.ZERO_COPY)
.bind(TcpServerTransport.create(7878))
.block()
.onClose()
.block();
```
### Example Client setup
```java
RSocket clientRSocket =
RSocketConnector.create()
// Enable Zero Copy
.payloadDecoder(PayloadDecoder.ZERO_COPY)
.connect(TcpClientTransport.create(7878))
.block();
```
## Bugs and Feedback
For bugs, questions and discussions please use the [Github Issues](https://github.com/RSocket/reactivesocket-java/issues).
## LICENSE
Copyright 2015-2020 the original author or authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.