From 6356286e42fd33f9886ff7ef25080d6464f1447a Mon Sep 17 00:00:00 2001 From: Kevin Viglucci Date: Mon, 1 Mar 2021 21:52:55 -0600 Subject: [PATCH 1/2] fix: launch.json wrong cwd --- .vscode/launch.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.vscode/launch.json b/.vscode/launch.json index 5c12b87d..ad6c7034 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -16,7 +16,7 @@ "/**" ], "type": "pwa-node", - "cwd": "${workspaceFolder}/website" + "cwd": "${workspaceFolder}" } ] -} \ No newline at end of file +} From b4512dc05b9c1e6efba4764bad3382d337d9cf72 Mon Sep 17 00:00:00 2001 From: Kevin Viglucci Date: Mon, 1 Mar 2021 21:55:25 -0600 Subject: [PATCH 2/2] refactor: remove WIP getting-started-page to allow merge to master before #29 --- .../examples/Connector/Java.mdx | 8 -- .../examples/Connector/Kotlin.mdx | 29 ----- .../examples/Connector/index.js | 7 -- .../examples/Dependencies/Java.mdx | 13 -- .../examples/Dependencies/Kotlin.mdx | 30 ----- .../examples/Dependencies/index.js | 7 -- .../examples/Encoding/Java.mdx | 11 -- .../examples/Encoding/index.js | 5 - content-docs/getting-started/index.mdx | 112 ------------------ sidebars.js | 1 - 10 files changed, 223 deletions(-) delete mode 100644 content-docs/getting-started/examples/Connector/Java.mdx delete mode 100644 content-docs/getting-started/examples/Connector/Kotlin.mdx delete mode 100644 content-docs/getting-started/examples/Connector/index.js delete mode 100644 content-docs/getting-started/examples/Dependencies/Java.mdx delete mode 100644 content-docs/getting-started/examples/Dependencies/Kotlin.mdx delete mode 100644 content-docs/getting-started/examples/Dependencies/index.js delete mode 100644 content-docs/getting-started/examples/Encoding/Java.mdx delete mode 100644 content-docs/getting-started/examples/Encoding/index.js delete mode 100644 content-docs/getting-started/index.mdx diff --git a/content-docs/getting-started/examples/Connector/Java.mdx b/content-docs/getting-started/examples/Connector/Java.mdx deleted file mode 100644 index f48f6679..00000000 --- a/content-docs/getting-started/examples/Connector/Java.mdx +++ /dev/null @@ -1,8 +0,0 @@ -```java -WebsocketClientTransport ws = WebsocketClientTransport.create( - URI.create("ws://rsocket-demo.herokuapp.com/ws")); - -RSocket clientRSocket = RSocketConnector - .connectWith(ws) - .block(); -``` diff --git a/content-docs/getting-started/examples/Connector/Kotlin.mdx b/content-docs/getting-started/examples/Connector/Kotlin.mdx deleted file mode 100644 index 89d97ece..00000000 --- a/content-docs/getting-started/examples/Connector/Kotlin.mdx +++ /dev/null @@ -1,29 +0,0 @@ -```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") -``` diff --git a/content-docs/getting-started/examples/Connector/index.js b/content-docs/getting-started/examples/Connector/index.js deleted file mode 100644 index ff907b45..00000000 --- a/content-docs/getting-started/examples/Connector/index.js +++ /dev/null @@ -1,7 +0,0 @@ -import Java from './Java.mdx'; -import Kotlin from './Kotlin.mdx'; - -export default { - Java, - Kotlin -}; \ No newline at end of file diff --git a/content-docs/getting-started/examples/Dependencies/Java.mdx b/content-docs/getting-started/examples/Dependencies/Java.mdx deleted file mode 100644 index ce31abc6..00000000 --- a/content-docs/getting-started/examples/Dependencies/Java.mdx +++ /dev/null @@ -1,13 +0,0 @@ -```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' -} -``` diff --git a/content-docs/getting-started/examples/Dependencies/Kotlin.mdx b/content-docs/getting-started/examples/Dependencies/Kotlin.mdx deleted file mode 100644 index db7094de..00000000 --- a/content-docs/getting-started/examples/Dependencies/Kotlin.mdx +++ /dev/null @@ -1,30 +0,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' -} -``` diff --git a/content-docs/getting-started/examples/Dependencies/index.js b/content-docs/getting-started/examples/Dependencies/index.js deleted file mode 100644 index ff907b45..00000000 --- a/content-docs/getting-started/examples/Dependencies/index.js +++ /dev/null @@ -1,7 +0,0 @@ -import Java from './Java.mdx'; -import Kotlin from './Kotlin.mdx'; - -export default { - Java, - Kotlin -}; \ No newline at end of file diff --git a/content-docs/getting-started/examples/Encoding/Java.mdx b/content-docs/getting-started/examples/Encoding/Java.mdx deleted file mode 100644 index 7fd19085..00000000 --- a/content-docs/getting-started/examples/Encoding/Java.mdx +++ /dev/null @@ -1,11 +0,0 @@ -```java -@Bean -public RSocket rSocket() { - Mono source = RSocketConnector.create() - .metadataMimeType("message/x.rsocket.composite-metadata.v0") - .dataMimeType("application/json") - .connect(TcpClientTransport.create("localhost", 7000)); - - return RSocketClient.from(source); -} -``` diff --git a/content-docs/getting-started/examples/Encoding/index.js b/content-docs/getting-started/examples/Encoding/index.js deleted file mode 100644 index 18f92112..00000000 --- a/content-docs/getting-started/examples/Encoding/index.js +++ /dev/null @@ -1,5 +0,0 @@ -import Java from './Java.mdx'; - -export default { - Java -}; \ No newline at end of file diff --git a/content-docs/getting-started/index.mdx b/content-docs/getting-started/index.mdx deleted file mode 100644 index c09ea8a0..00000000 --- a/content-docs/getting-started/index.mdx +++ /dev/null @@ -1,112 +0,0 @@ ---- -slug: /getting-started -title: Getting Started -sidebar_label: Getting Started ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import CodeBlock from '@theme/CodeBlock'; -import ExampleTabs from '@theme/ExampleTabs'; -import DependenciesExamples from './examples/Dependencies'; -import ConnectorExamples from './examples/Connector'; -import EncodingExamples from './examples/Encoding'; - -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. - - - -### 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](protocol.md#transport-protocol). - -The below examples demonstrate creating a RSocket Connector in various languages using the WebSocket transport. - - - -:::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](protocol.md#framing) in an RSocket payload can be specified when the RSocket Client or RSocket Server is created. - - - -### 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 diff --git a/sidebars.js b/sidebars.js index 967e6e20..6f61b5be 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1,7 +1,6 @@ module.exports = { "docs": { "About": [ - "getting-started/index", "faq", "motivations", "protocol",