wip

rsocket-transport-api/build.gradle.kts

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2015-2023 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.
+ */
+
+import rsocketbuild.*
+
+plugins {
+    id("rsocketbuild.template.library")
+}
+
+kotlin {
+    jvmTarget()
+    jsTarget()
+    nativeTargets()
+
+    sourceSets {
+        commonMain {
+            dependencies {
+                api(libs.kotlinx.coroutines.core)
+                api(libs.ktor.io)
+            }
+        }
+    }
+}
+
+description = "RSocket Transport API"

rsocket-transport-api/src/commonMain/kotlin/io/rsocket/kotlin/transport/RSocketClientTransport.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2015-2023 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.
+ */
+
+package io.rsocket.kotlin.transport
+
+@SubclassOptInRequired(RSocketTransportApi::class)
+public interface RSocketClientTransport : RSocketTransport {
+    @RSocketTransportApi
+    public suspend fun connect(): RSocketTransportConnection
+}

rsocket-transport-api/src/commonMain/kotlin/io/rsocket/kotlin/transport/RSocketServerTransport.kt

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2015-2023 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.
+ */
+
+package io.rsocket.kotlin.transport
+
+import kotlinx.coroutines.*
+
+@SubclassOptInRequired(RSocketTransportApi::class)
+public interface RSocketServerTransport<Instance : RSocketServerInstance> : RSocketTransport {
+    @RSocketTransportApi
+    public suspend fun bind(acceptor: RSocketServerAcceptor): Instance
+}
+
+@RSocketTransportApi
+public interface RSocketServerAcceptor {
+    public suspend fun accept(connection: RSocketTransportConnection)
+}
+
+// cancelling it will cancel server
+// coroutineContext of transport should contain SupervisorJob
+@SubclassOptInRequired(RSocketTransportApi::class)
+public interface RSocketServerInstance : CoroutineScope

rsocket-transport-api/src/commonMain/kotlin/io/rsocket/kotlin/transport/RSocketTransport.kt

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2015-2023 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.
+ */
+
+package io.rsocket.kotlin.transport
+
+import kotlinx.coroutines.*
+import kotlin.coroutines.*
+
+// coroutineContext of transport should contain SupervisorJob
+@SubclassOptInRequired(RSocketTransportApi::class)
+public interface RSocketTransport : CoroutineScope
+
+// coroutineContext of transport should contain SupervisorJob
+@SubclassOptInRequired(RSocketTransportApi::class)
+public interface RSocketTransportEngine<Target, Transport : RSocketTransport> : CoroutineScope {
+    public fun createTransport(target: Target): Transport
+}
+
+// TODO: split into transport factory and RSocketTransportEngineFactory
+@SubclassOptInRequired(RSocketTransportApi::class)
+public interface RSocketTransportFactory<Target, Transport : RSocketTransport, Engine : RSocketTransportEngine<Target, Transport>, Builder> {
+    public operator fun invoke(context: CoroutineContext, target: Target, block: Builder.() -> Unit = {}): Transport
+    public fun Engine(context: CoroutineContext, block: Builder.() -> Unit = {}): Engine
+}

rsocket-transport-api/src/commonMain/kotlin/io/rsocket/kotlin/transport/RSocketTransportApi.kt

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2015-2023 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.
+ */
+
+package io.rsocket.kotlin.transport
+
+@Retention(value = AnnotationRetention.BINARY)
+@RequiresOptIn(
+    level = RequiresOptIn.Level.WARNING,
+    message = "This is an API which is used to implement transport for RSocket, such as WS or TCP. This API should not be used from general code"
+)
+public annotation class RSocketTransportApi

rsocket-transport-api/src/commonMain/kotlin/io/rsocket/kotlin/transport/RSocketTransportConnection.kt

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2015-2023 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.
+ */
+
+package io.rsocket.kotlin.transport
+
+import io.ktor.utils.io.core.*
+import io.ktor.utils.io.core.internal.*
+import io.ktor.utils.io.pool.*
+import kotlinx.coroutines.*
+
+// todo: rename to session
+// coroutineContext of connection should NOT contain SupervisorJob
+@RSocketTransportApi
+public sealed interface RSocketTransportConnection : CoroutineScope {
+    public val bufferPool: ObjectPool<ChunkBuffer> get() = ChunkBuffer.Pool
+
+    public interface Sequential : RSocketTransportConnection {
+        public suspend fun sendFrame(frame: ByteReadPacket)
+        public suspend fun receiveFrame(): ByteReadPacket
+    }
+
+    public interface Multiplexed : RSocketTransportConnection {
+        public interface Stream : Closeable {
+            public fun prioritize()
+            public suspend fun sendFrame(frame: ByteReadPacket)
+            public suspend fun receiveFrame(): ByteReadPacket
+        }
+
+        public suspend fun createStream(): Stream
+        public suspend fun awaitStream(): Stream
+    }
+}

settings.gradle.kts

@@ -34,6 +34,7 @@ include("rsocket-test")
 
 // standalone transport modules
 include(
+    "rsocket-transport-api",
     "rsocket-transport-local",
     "rsocket-transport-ktor-tcp",
     "rsocket-transport-ktor-websocket-shared",