Getting Started

The Vanilla RSocket getting started guide overviews key concepts and patterns that you will encounter when working with the various language specific RSocket reference implementations.

Dependencies

Each language specific RSocket reference implementation requires a number of different dependencies. While these dependencies will differ between the various language specific reference implementations, many common patterns are shared amongst them.

Java

// build.gradle

repositories {

mavenCentral()

maven { url 'https://repo.spring.io/milestone' } // Reactor milestones (if needed)

}

dependencies {

implementation 'io.rsocket:rsocket-core:1.1.0'

implementation 'io.rsocket:rsocket-transport-netty:1.1.0'

}

Kotlin

// build.grade

repositories {

jcenter()

}

dependencies {

implementation 'io.rsocket.kotlin:rsocket-core:0.12.0'

implementation 'io.rsocket.kotlin:rsocket-transport-ktor:0.12.0'

// client feature for ktor

// implementation 'io.rsocket.kotlin:rsocket-transport-ktor-client:0.12.0'

// server feature for ktor

// implementation 'io.rsocket.kotlin:rsocket-transport-ktor-server:0.12.0'

// one of ktor engines to work with websockets

// client engines

// implementation 'io.ktor:ktor-client-js:1.4.3' //js

// implementation 'io.ktor:ktor-client-cio:1.4.3' //jvm

// implementation 'io.ktor:ktor-client-okhttp:1.4.3' //jvm

// server engines (jvm only)

// implementation 'io.ktor:ktor-server-cio:1.4.3'

// implementation 'io.ktor:ktor-server-netty:1.4.3'

// implementation 'io.ktor:ktor-server-jetty:1.4.3'

// implementation 'io.ktor:ktor-server-tomcat:1.4.3'

}

Connectors (Clients)

Connectors are the primary method for connecting an RSocket Client to an RSocket Server. Each connector implementation is geared towards supporting one of the various transports as described in the transports protocol.

The below examples demonstrate creating a RSocket Connector in various languages using the WebSocket transport.

Java

WebsocketClientTransport ws = WebsocketClientTransport.create(

URI.create("ws://rsocket-demo.herokuapp.com/ws"));

RSocket clientRSocket = RSocketConnector

.connectWith(ws)

.block();

Kotlin

//create ktor client

val client = HttpClient(CIO) {

install(WebSockets)

install(RSocketSupport) {

connector = RSocketConnector {

//configure rSocket connector (all values have defaults)

connectionConfig {

keepAlive = KeepAlive(

interval = 30.seconds,

maxLifetime = 2.minutes

)

//payload for setup frame

setupPayload { buildPayload { data("hello world") } }

//mime types

payloadMimeType = PayloadMimeType(

data = "application/json",

metadata = "application/json"

)

}

}

}

}

//connect to some url

val rSocket: RSocket = client.rSocket("wss://rsocket-demo.herokuapp.com/rsocket")

info

RSocket has been designed for and tested with TCP, WebSocket, Aeron, and HTTP/2 streams as transport protocols.

Servers

TODO

Working with Payloads (data & metadata)

Payloads represent the concept of passing data back and forth between an RSocket Client and an RSocket Server, with a distinction between data and metadata. If we were to relate these concepts to HTTP, then data would represent the HTTP response/request body, and metadata would describe the HTTP request/response headers.

A single RSocket payload is capable of containing both data as well as metadata, and each can leverage different encodings. For example, an RSocket payload could encode its data as JSON (application/json), and its metadata as protobuf (application/vnd.google.protobuf).

note

It is most common for data and metadata to leverage the same encoding, but is not required.

Specifying Encoding

Encoding for the data/metadata frames in an RSocket payload can be specified when the RSocket Client or RSocket Server is created.

Java

@Bean

public RSocket rSocket() {

Mono<RSocket> source = RSocketConnector.create()

.metadataMimeType("message/x.rsocket.composite-metadata.v0")

.dataMimeType("application/json")

.connect(TcpClientTransport.create("localhost", 7000));

return RSocketClient.from(source);

}

Kotlin

Sorry, no example available.

Composite Metadata

TODO

Request routing

TODO

Tracing

TODO

Authentication Metadata

TODO

Getting Started with RSocket RPC

Dependency Setup

TODO

Code Generation

TODO

Reactive API

TODO

Single

TODO

Flowable

TODO

Project Reactor

TODO

Tutorials

TODO

Chat App

TODO