Skip to content
Branch: master
Go to file

Latest commit

OlegDokuka committed 2dbf61d Jul 6, 2020
Signed-off-by: Oleh Dokuka <>


Failed to load latest commit information.
Latest commit message
Commit time
May 12, 2020


Join the chat at

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

Build and Binaries

Build Status

⚠️ The master branch is now dedicated to development of the 1.1.x line.

Releases are available via Maven Central.


repositories {
dependencies {
    implementation 'io.rsocket:rsocket-core:1.1.0-SNAPSHOT'
    implementation 'io.rsocket:rsocket-transport-netty:1.1.0-SNAPSHOT'

Snapshots are available via (OJO).


repositories {
	maven { url '' }
dependencies {
    implementation 'io.rsocket:rsocket-core:1.1.1-SNAPSHOT'
    implementation 'io.rsocket:rsocket-transport-netty:1.1.1-SNAPSHOT'


Install the google-java-format in Intellij, from Plugins preferences. Enable under Preferences -> Other Settings -> google-java-format Settings

Format automatically with

$./gradlew goJF


Frames can be printed out to help debugging. Set the logger io.rsocket.FrameLogger to debug to print the frames.


Trivial Client

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;


public class ExampleClient {
    public static void main(String[] args) {
        WebsocketClientTransport ws = WebsocketClientTransport.create(URI.create("ws://"));
        RSocket clientRSocket = RSocketConnector.connectWith(ws).block();

        try {
            Flux<Payload> s = clientRSocket.requestStream(DefaultPayload.create("peace"));

            s.take(10).doOnNext(p -> System.out.println(p.getDataUtf8())).blockLast();
        } finally {

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

RSocketServer.create(new PingHandler())
        // Enable Zero Copy

Example Client setup

RSocket clientRSocket =
            // Enable Zero Copy

Bugs and Feedback

For bugs, questions and discussions please use the Github Issues.


Copyright 2015-2018 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

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.

You can’t perform that action at this time.