-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Migrate ktor (tcp and websocket) and nodejs tcp transport to new API (#…
…256)
- Loading branch information
Showing
30 changed files
with
1,339 additions
and
70 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
40 changes: 40 additions & 0 deletions
40
rsocket-transports/ktor-tcp/api/rsocket-transport-ktor-tcp.api
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
110 changes: 110 additions & 0 deletions
110
...-tcp/src/commonMain/kotlin/io/rsocket/kotlin/transport/ktor/tcp/KtorTcpClientTransport.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| /* | ||
| * Copyright 2015-2024 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.ktor.tcp | ||
|
|
||
| import io.ktor.network.selector.* | ||
| import io.ktor.network.sockets.* | ||
| import io.rsocket.kotlin.internal.io.* | ||
| import io.rsocket.kotlin.transport.* | ||
| import kotlinx.coroutines.* | ||
| import kotlin.coroutines.* | ||
|
|
||
| @OptIn(RSocketTransportApi::class) | ||
| public sealed interface KtorTcpClientTransport : RSocketTransport { | ||
| public fun target(remoteAddress: SocketAddress): RSocketClientTarget | ||
| public fun target(host: String, port: Int): RSocketClientTarget | ||
|
|
||
| public companion object Factory : | ||
| RSocketTransportFactory<KtorTcpClientTransport, KtorTcpClientTransportBuilder>(::KtorTcpClientTransportBuilderImpl) | ||
| } | ||
|
|
||
| @OptIn(RSocketTransportApi::class) | ||
| public sealed interface KtorTcpClientTransportBuilder : RSocketTransportBuilder<KtorTcpClientTransport> { | ||
| public fun dispatcher(context: CoroutineContext) | ||
| public fun inheritDispatcher(): Unit = dispatcher(EmptyCoroutineContext) | ||
|
|
||
| public fun selectorManagerDispatcher(context: CoroutineContext) | ||
| public fun selectorManager(manager: SelectorManager, manage: Boolean) | ||
|
|
||
| public fun socketOptions(block: SocketOptions.TCPClientSocketOptions.() -> Unit) | ||
|
|
||
| //TODO: TLS support | ||
| } | ||
|
|
||
| private class KtorTcpClientTransportBuilderImpl : KtorTcpClientTransportBuilder { | ||
| private var dispatcher: CoroutineContext = Dispatchers.Default | ||
| private var selector: KtorTcpSelector = KtorTcpSelector.FromContext(Dispatchers.IO) | ||
| private var socketOptions: SocketOptions.TCPClientSocketOptions.() -> Unit = {} | ||
|
|
||
| override fun dispatcher(context: CoroutineContext) { | ||
| check(context[Job] == null) { "Dispatcher shouldn't contain job" } | ||
| this.dispatcher = context | ||
| } | ||
|
|
||
| override fun socketOptions(block: SocketOptions.TCPClientSocketOptions.() -> Unit) { | ||
| this.socketOptions = block | ||
| } | ||
|
|
||
| override fun selectorManagerDispatcher(context: CoroutineContext) { | ||
| check(context[Job] == null) { "Dispatcher shouldn't contain job" } | ||
| this.selector = KtorTcpSelector.FromContext(context) | ||
| } | ||
|
|
||
| override fun selectorManager(manager: SelectorManager, manage: Boolean) { | ||
| this.selector = KtorTcpSelector.FromInstance(manager, manage) | ||
| } | ||
|
|
||
| @RSocketTransportApi | ||
| override fun buildTransport(context: CoroutineContext): KtorTcpClientTransport { | ||
| val transportContext = context.supervisorContext() + dispatcher | ||
| return KtorTcpClientTransportImpl( | ||
| coroutineContext = transportContext, | ||
| socketOptions = socketOptions, | ||
| selectorManager = selector.createFor(transportContext) | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| private class KtorTcpClientTransportImpl( | ||
| override val coroutineContext: CoroutineContext, | ||
| private val socketOptions: SocketOptions.TCPClientSocketOptions.() -> Unit, | ||
| private val selectorManager: SelectorManager, | ||
| ) : KtorTcpClientTransport { | ||
| override fun target(remoteAddress: SocketAddress): RSocketClientTarget = KtorTcpClientTargetImpl( | ||
| coroutineContext = coroutineContext.supervisorContext(), | ||
| socketOptions = socketOptions, | ||
| selectorManager = selectorManager, | ||
| remoteAddress = remoteAddress | ||
| ) | ||
|
|
||
| override fun target(host: String, port: Int): RSocketClientTarget = target(InetSocketAddress(host, port)) | ||
| } | ||
|
|
||
| @OptIn(RSocketTransportApi::class) | ||
| private class KtorTcpClientTargetImpl( | ||
| override val coroutineContext: CoroutineContext, | ||
| private val socketOptions: SocketOptions.TCPClientSocketOptions.() -> Unit, | ||
| private val selectorManager: SelectorManager, | ||
| private val remoteAddress: SocketAddress, | ||
| ) : RSocketClientTarget { | ||
|
|
||
| @RSocketTransportApi | ||
| override fun connectClient(handler: RSocketConnectionHandler): Job = launch { | ||
| val socket = aSocket(selectorManager).tcp().connect(remoteAddress, socketOptions) | ||
| handler.handleKtorTcpConnection(socket) | ||
| } | ||
| } |
111 changes: 111 additions & 0 deletions
111
.../ktor-tcp/src/commonMain/kotlin/io/rsocket/kotlin/transport/ktor/tcp/KtorTcpConnection.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| /* | ||
| * Copyright 2015-2024 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.ktor.tcp | ||
|
|
||
| import io.ktor.network.sockets.* | ||
| import io.ktor.utils.io.* | ||
| import io.ktor.utils.io.core.* | ||
| import io.rsocket.kotlin.internal.io.* | ||
| import io.rsocket.kotlin.transport.* | ||
| import io.rsocket.kotlin.transport.internal.* | ||
| import kotlinx.coroutines.* | ||
| import kotlinx.coroutines.channels.* | ||
|
|
||
| @RSocketTransportApi | ||
| internal suspend fun RSocketConnectionHandler.handleKtorTcpConnection(socket: Socket): Unit = coroutineScope { | ||
| val outboundQueue = PrioritizationFrameQueue(Channel.BUFFERED) | ||
| val inbound = channelForCloseable<ByteReadPacket>(Channel.BUFFERED) | ||
|
|
||
| val readerJob = launch { | ||
| val input = socket.openReadChannel() | ||
| try { | ||
| while (true) inbound.send(input.readFrame() ?: break) | ||
| input.cancel(null) | ||
| } catch (cause: Throwable) { | ||
| input.cancel(cause) | ||
| throw cause | ||
| } | ||
| }.onCompletion { inbound.cancel() } | ||
|
|
||
| val writerJob = launch { | ||
| val output = socket.openWriteChannel() | ||
| try { | ||
| while (true) { | ||
| // we write all available frames here, and only after it flush | ||
| // in this case, if there are several buffered frames we can send them in one go | ||
| // avoiding unnecessary flushes | ||
| output.writeFrame(outboundQueue.dequeueFrame() ?: break) | ||
| while (true) output.writeFrame(outboundQueue.tryDequeueFrame() ?: break) | ||
| output.flush() | ||
| } | ||
| output.close(null) | ||
| } catch (cause: Throwable) { | ||
| output.close(cause) | ||
| throw cause | ||
| } | ||
| }.onCompletion { outboundQueue.cancel() } | ||
|
|
||
| try { | ||
| handleConnection(KtorTcpConnection(outboundQueue, inbound)) | ||
| } finally { | ||
| readerJob.cancel() | ||
| outboundQueue.close() // will cause `writerJob` completion | ||
| // even if it was cancelled, we still need to close socket and await it closure | ||
| withContext(NonCancellable) { | ||
| // await completion of read/write and then close socket | ||
| readerJob.join() | ||
| writerJob.join() | ||
| // close socket | ||
| socket.close() | ||
| socket.socketContext.join() | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @RSocketTransportApi | ||
| private class KtorTcpConnection( | ||
| private val outboundQueue: PrioritizationFrameQueue, | ||
| private val inbound: ReceiveChannel<ByteReadPacket>, | ||
| ) : RSocketSequentialConnection { | ||
| override val isClosedForSend: Boolean get() = outboundQueue.isClosedForSend | ||
| override suspend fun sendFrame(streamId: Int, frame: ByteReadPacket) { | ||
| return outboundQueue.enqueueFrame(streamId, frame) | ||
| } | ||
|
|
||
| override suspend fun receiveFrame(): ByteReadPacket? { | ||
| return inbound.receiveCatching().getOrNull() | ||
| } | ||
| } | ||
|
|
||
| private suspend fun ByteWriteChannel.writeFrame(frame: ByteReadPacket) { | ||
| val packet = buildPacket { | ||
| writeInt24(frame.remaining.toInt()) | ||
| writePacket(frame) | ||
| } | ||
| try { | ||
| writePacket(packet) | ||
| } catch (cause: Throwable) { | ||
| packet.close() | ||
| throw cause | ||
| } | ||
| } | ||
|
|
||
| private suspend fun ByteReadChannel.readFrame(): ByteReadPacket? { | ||
| val lengthPacket = readRemaining(3) | ||
| if (lengthPacket.remaining == 0L) return null | ||
| return readPacket(lengthPacket.readInt24()) | ||
| } |
44 changes: 44 additions & 0 deletions
44
...ts/ktor-tcp/src/commonMain/kotlin/io/rsocket/kotlin/transport/ktor/tcp/KtorTcpSelector.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| /* | ||
| * Copyright 2015-2024 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.ktor.tcp | ||
|
|
||
| import io.ktor.network.selector.* | ||
| import kotlinx.coroutines.* | ||
| import kotlin.coroutines.* | ||
|
|
||
| internal sealed class KtorTcpSelector { | ||
| class FromContext(val context: CoroutineContext) : KtorTcpSelector() | ||
| class FromInstance(val selectorManager: SelectorManager, val manage: Boolean) : KtorTcpSelector() | ||
| } | ||
|
|
||
| internal fun KtorTcpSelector.createFor(parentContext: CoroutineContext): SelectorManager { | ||
| val selectorManager: SelectorManager | ||
| val manage: Boolean | ||
| when (this) { | ||
| is KtorTcpSelector.FromContext -> { | ||
| selectorManager = SelectorManager(parentContext + context) | ||
| manage = true | ||
| } | ||
|
|
||
| is KtorTcpSelector.FromInstance -> { | ||
| selectorManager = this.selectorManager | ||
| manage = this.manage | ||
| } | ||
| } | ||
| if (manage) Job(parentContext.job).invokeOnCompletion { selectorManager.close() } | ||
| return selectorManager | ||
| } |
Oops, something went wrong.