feat(network): commonize raw socket interface

ktor-network/build.gradle.kts

@@ -6,7 +6,7 @@ kotlin {
     }
 
     sourceSets {
-        jvmAndNixMain {
+        commonMain {
             dependencies {
                 api(project(":ktor-utils"))
             }

ktor-network/jvmAndNix/src/io/ktor/network/selector/Selectable.kt → ktor-network/common/src/io/ktor/network/selector/ClosedChannelCancellationException.kt

@@ -2,10 +2,5 @@ package io.ktor.network.selector
 
 import kotlinx.coroutines.*
 
-/**
- * A selectable entity with selectable NIO [channel], [interestedOps] subscriptions.
- */
-public expect interface Selectable
-
 @Suppress("KDocMissingDocumentation")
 public class ClosedChannelCancellationException : CancellationException("Closed channel.")

ktor-network/common/src/io/ktor/network/selector/SelectorManager.kt

@@ -0,0 +1,17 @@
+package io.ktor.network.selector
+
+import io.ktor.utils.io.core.*
+import kotlinx.coroutines.*
+import kotlin.coroutines.*
+
+/**
+ * Creates the selector manager for current platform.
+ */
+@Suppress("FunctionName")
+public expect fun SelectorManager(
+    dispatcher: CoroutineContext = EmptyCoroutineContext
+): SelectorManager
+
+public expect interface SelectorManager : CoroutineScope, Closeable {
+
+}

ktor-network/common/src/io/ktor/network/sockets/ConnectUtils.kt

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2014-2022 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package io.ktor.network.sockets
+
+import io.ktor.network.selector.*
+
+internal expect suspend fun connect(
+    selector: SelectorManager,
+    remoteAddress: SocketAddress,
+    socketOptions: SocketOptions.TCPClientSocketOptions
+): Socket
+
+internal expect fun bind(
+    selector: SelectorManager,
+    localAddress: SocketAddress?,
+    socketOptions: SocketOptions.AcceptorOptions
+): ServerSocket
+
+internal expect fun UDPSocketBuilder.Companion.connectUDP(
+    selector: SelectorManager,
+    remoteAddress: SocketAddress,
+    localAddress: SocketAddress?,
+    options: SocketOptions.UDPSocketOptions
+): ConnectedDatagramSocket
+
+internal expect fun UDPSocketBuilder.Companion.bindUDP(
+    selector: SelectorManager,
+    localAddress: SocketAddress?,
+    options: SocketOptions.UDPSocketOptions
+): BoundDatagramSocket

ktor-network/jvmAndNix/src/io/ktor/network/sockets/Sockets.kt → ktor-network/common/src/io/ktor/network/sockets/Sockets.kt

@@ -1,6 +1,6 @@
 /*
-* Copyright 2014-2021 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
-*/
+ * Copyright 2014-2022 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+ */
 
 package io.ktor.network.sockets
 

ktor-network/jvmAndNix/src/io/ktor/network/sockets/UDPSocketBuilder.kt → ktor-network/common/src/io/ktor/network/sockets/UDPSocketBuilder.kt

@@ -1,3 +1,7 @@
+/*
+ * Copyright 2014-2022 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+ */
+
 package io.ktor.network.sockets
 
 import io.ktor.network.selector.*
@@ -28,16 +32,3 @@ public class UDPSocketBuilder(
 
     public companion object
 }
-
-internal expect fun UDPSocketBuilder.Companion.connectUDP(
-    selector: SelectorManager,
-    remoteAddress: SocketAddress,
-    localAddress: SocketAddress?,
-    options: SocketOptions.UDPSocketOptions
-): ConnectedDatagramSocket
-
-internal expect fun UDPSocketBuilder.Companion.bindUDP(
-    selector: SelectorManager,
-    localAddress: SocketAddress?,
-    options: SocketOptions.UDPSocketOptions
-): BoundDatagramSocket

ktor-network/js/src/io/ktor/network/selector/SelectorManager.kt

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2014-2022 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package io.ktor.network.selector
+
+import io.ktor.utils.io.core.*
+import kotlinx.coroutines.*
+import kotlin.coroutines.*
+
+/**
+ * Creates the selector manager for current platform.
+ */
+@Suppress("FunctionName")
+public actual fun SelectorManager(dispatcher: kotlin.coroutines.CoroutineContext): SelectorManager {
+    TODO("SelectorManager is not yet implemented on Javascript platform")
+}
+
+public actual interface SelectorManager : CoroutineScope, Closeable {
+
+}

ktor-network/js/src/io/ktor/network/sockets/ConnectUtils.kt

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2014-2022 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package io.ktor.network.sockets
+
+import io.ktor.network.selector.*
+
+internal actual suspend fun connect(
+    selector: SelectorManager,
+    remoteAddress: SocketAddress,
+    socketOptions: SocketOptions.TCPClientSocketOptions
+): Socket = TODO("Not yet implemented")
+
+internal actual fun bind(
+    selector: SelectorManager,
+    localAddress: SocketAddress?,
+    socketOptions: SocketOptions.AcceptorOptions
+): ServerSocket = TODO("Not yet implemented")
+
+internal actual fun UDPSocketBuilder.Companion.connectUDP(
+    selector: SelectorManager,
+    remoteAddress: SocketAddress,
+    localAddress: SocketAddress?,
+    options: SocketOptions.UDPSocketOptions
+): ConnectedDatagramSocket = TODO("Not yet implemented")
+
+internal actual fun UDPSocketBuilder.Companion.bindUDP(
+    selector: SelectorManager,
+    localAddress: SocketAddress?,
+    options: SocketOptions.UDPSocketOptions
+): BoundDatagramSocket = TODO("Not yet implemented")

ktor-network/js/src/io/ktor/network/sockets/SocketAddress.kt

@@ -0,0 +1,12 @@
+package io.ktor.network.sockets
+
+public actual sealed class SocketAddress
+
+public actual data class InetSocketAddress actual constructor(
+    public actual val hostname: String,
+    public actual val port: Int
+) : SocketAddress()
+
+public actual data class UnixSocketAddress actual constructor(
+    public actual val path: String
+) : SocketAddress()

ktor-network/js/src/io/ktor/network/sockets/SocketTimeoutException.kt

@@ -0,0 +1,15 @@
+/*
+* Copyright 2014-2021 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+*/
+
+package io.ktor.network.sockets
+
+import io.ktor.utils.io.errors.*
+
+@Suppress("EXPECT_WITHOUT_ACTUAL")
+public actual class SocketTimeoutException(
+    message: String,
+    cause: Throwable?
+) : IOException(message, cause) {
+    public actual constructor(message: String) : this(message, null)
+}

ktor-network/jvm/src/io/ktor/network/selector/JvmSelector.kt

@@ -5,7 +5,10 @@ import kotlinx.coroutines.*
 import java.io.*
 import java.nio.channels.*
 
-public actual interface Selectable : Closeable, DisposableHandle {
+/**
+ * A selectable entity with selectable NIO [channel], [interestedOps] subscriptions.
+ */
+public interface Selectable : Closeable, DisposableHandle {
     /**
      * Current selectable suspensions map
      */

ktor-network/jvm/src/io/ktor/network/selector/SelectorManager.kt

@@ -24,7 +24,7 @@ public actual interface SelectorManager : CoroutineScope, Closeable {
     /**
      * Notifies the selector that selectable has been closed.
      */
-    public actual fun notifyClosed(selectable: Selectable)
+    public fun notifyClosed(selectable: Selectable)
 
     /**
      * Suspends until [interest] is selected for [selectable]
@@ -35,9 +35,7 @@ public actual interface SelectorManager : CoroutineScope, Closeable {
      * In other words you can select for read and write at the same time but should never
      * try to read twice for the same selectable.
      */
-    public actual suspend fun select(selectable: Selectable, interest: SelectInterest)
-
-    public actual companion object
+    public suspend fun select(selectable: Selectable, interest: SelectInterest)
 }
 
 /**
@@ -65,14 +63,14 @@ public inline fun <C : Closeable, R> SelectorManager.buildOrClose(
  * @property [flag] to be set in NIO selector
  */
 @Suppress("KDocMissingDocumentation")
-public actual enum class SelectInterest(public val flag: Int) {
+public enum class SelectInterest(public val flag: Int) {
     READ(SelectionKey.OP_READ),
     WRITE(SelectionKey.OP_WRITE),
     ACCEPT(SelectionKey.OP_ACCEPT),
     CONNECT(SelectionKey.OP_CONNECT);
 
-    public actual companion object {
-        public actual val AllInterests: Array<SelectInterest> = values()
+    public companion object {
+        public val AllInterests: Array<SelectInterest> = values()
 
         public val flags: IntArray = values().map { it.flag }.toIntArray()
 

ktor-network/mingwX64/src/io/ktor/network/selector/SelectorManager.kt

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2014-2022 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package io.ktor.network.selector
+
+import io.ktor.utils.io.core.*
+import kotlinx.coroutines.*
+import kotlin.coroutines.*
+
+/**
+ * Creates the selector manager for current platform.
+ */
+@Suppress("FunctionName")
+public actual fun SelectorManager(dispatcher: kotlin.coroutines.CoroutineContext): SelectorManager {
+    TODO("SelectorManager is not yet implemented on Mingw x64 platform")
+}
+
+public actual interface SelectorManager : CoroutineScope, Closeable {
+
+}

ktor-network/mingwX64/src/io/ktor/network/sockets/ConnectUtils.kt

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2014-2022 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package io.ktor.network.sockets
+
+import io.ktor.network.selector.*
+
+internal actual suspend fun connect(
+    selector: SelectorManager,
+    remoteAddress: SocketAddress,
+    socketOptions: SocketOptions.TCPClientSocketOptions
+): Socket = TODO("Not yet implemented")
+
+internal actual fun bind(
+    selector: SelectorManager,
+    localAddress: SocketAddress?,
+    socketOptions: SocketOptions.AcceptorOptions
+): ServerSocket = TODO("Not yet implemented")
+
+internal actual fun UDPSocketBuilder.Companion.connectUDP(
+    selector: SelectorManager,
+    remoteAddress: SocketAddress,
+    localAddress: SocketAddress?,
+    options: SocketOptions.UDPSocketOptions
+): ConnectedDatagramSocket = TODO("Not yet implemented")
+
+internal actual fun UDPSocketBuilder.Companion.bindUDP(
+    selector: SelectorManager,
+    localAddress: SocketAddress?,
+    options: SocketOptions.UDPSocketOptions
+): BoundDatagramSocket = TODO("Not yet implemented")

ktor-network/mingwX64/src/io/ktor/network/sockets/SocketAddress.kt

@@ -0,0 +1,12 @@
+package io.ktor.network.sockets
+
+public actual sealed class SocketAddress
+
+public actual data class InetSocketAddress actual constructor(
+    public actual val hostname: String,
+    public actual val port: Int
+) : SocketAddress()
+
+public actual data class UnixSocketAddress actual constructor(
+    public actual val path: String
+) : SocketAddress()

ktor-network/mingwX64/src/io/ktor/network/sockets/SocketTimeoutException.kt

@@ -0,0 +1,15 @@
+/*
+* Copyright 2014-2021 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+*/
+
+package io.ktor.network.sockets
+
+import io.ktor.utils.io.errors.*
+
+@Suppress("EXPECT_WITHOUT_ACTUAL")
+public actual class SocketTimeoutException(
+    message: String,
+    cause: Throwable?
+) : IOException(message, cause) {
+    public actual constructor(message: String) : this(message, null)
+}