introduce SocketType enum for public API

Author: lhoward

FlyingFox/Tests/AsyncSocketTests.swift

@@ -40,7 +40,7 @@ extension AsyncSocket {
     }
 
     static func make(pool: some AsyncSocketPool) throws -> AsyncSocket {
-        let socket = try Socket(domain: AF_UNIX, type: Socket.stream)
+        let socket = try Socket(domain: AF_UNIX, type: .stream)
         return try AsyncSocket(socket: socket, pool: pool)
     }
 

FlyingSocks/Sources/AsyncSocket.swift

@@ -83,7 +83,7 @@ public struct AsyncSocket: Sendable {
                                  pool: some AsyncSocketPool,
                                  timeout: TimeInterval = 5) async throws -> Self {
         try await withThrowingTimeout(seconds: timeout) {
-            let socket = try Socket(domain: Int32(type(of: address).family), type: Socket.stream)
+            let socket = try Socket(domain: Int32(type(of: address).family), type: .stream)
             let asyncSocket = try AsyncSocket(socket: socket, pool: pool)
             try await asyncSocket.connect(to: address)
             return asyncSocket

FlyingSocks/Sources/Socket.swift

@@ -36,6 +36,22 @@ import WinSDK.WinSock2
 #endif
 import Foundation
 
+public enum SocketType: Sendable {
+    case stream
+    case datagram
+}
+
+extension SocketType {
+    var rawValue: Int32 {
+        switch self {
+        case .stream:
+            Socket.stream
+        case .datagram:
+            Socket.datagram
+        }
+    }
+}
+
 public struct Socket: Sendable, Hashable {
 
     public let file: FileDescriptor
@@ -53,9 +69,10 @@ public struct Socket: Sendable, Hashable {
     }
 
     public init(domain: Int32) throws {
-        try self.init(domain: domain, type: Socket.stream)
+        try self.init(domain: domain, type: .stream)
     }
 
+    @available(*, deprecated, message: "type is now SocketType")
     public init(domain: Int32, type: Int32) throws {
         let descriptor = FileDescriptor(rawValue: Socket.socket(domain, type, 0))
         guard descriptor != .invalid else {
@@ -64,6 +81,10 @@ public struct Socket: Sendable, Hashable {
         self.file = descriptor
     }
 
+    public init(domain: Int32, type: SocketType) throws {
+        try self.init(domain: domain, type: type.rawValue)
+    }
+
     public var flags: Flags {
         get throws {
             let flags = Socket.fcntl(file.rawValue, F_GETFL)

FlyingSocks/Tests/AsyncSocketTests.swift

@@ -198,15 +198,15 @@ extension AsyncSocket {
     static func makeListening(pool: some AsyncSocketPool) throws -> AsyncSocket {
         let address = sockaddr_un.unix(path: #function)
         try? Socket.unlink(address)
-        let socket = try Socket(domain: AF_UNIX, type: Socket.stream)
+        let socket = try Socket(domain: AF_UNIX, type: .stream)
         try socket.setValue(true, for: .localAddressReuse)
         try socket.bind(to: address)
         try socket.listen()
         return try AsyncSocket(socket: socket, pool: pool)
     }
 
     static func make(pool: some AsyncSocketPool) throws -> AsyncSocket {
-        let socket = try Socket(domain: AF_UNIX, type: Socket.stream)
+        let socket = try Socket(domain: AF_UNIX, type: .stream)
         return try AsyncSocket(socket: socket, pool: pool)
     }
 

FlyingSocks/Tests/SocketPoolTests.swift

@@ -85,7 +85,7 @@ struct SocketPoolTests {
         try await pool.prepare()
 
         let task = Task {
-            let socket = try Socket(domain: AF_UNIX, type: Socket.stream)
+            let socket = try Socket(domain: AF_UNIX, type: .stream)
             try await pool.suspendSocket(socket, untilReadyFor: .read)
         }
 
@@ -125,7 +125,7 @@ struct SocketPoolTests {
 
         try? await task.value
 
-        let socket = try Socket(domain: AF_UNIX, type: Socket.stream)
+        let socket = try Socket(domain: AF_UNIX, type: .stream)
         await #expect(throws: (any Error).self) {
             try await pool.suspendSocket(socket, untilReadyFor: .read)
         }
@@ -138,7 +138,7 @@ struct SocketPoolTests {
         let task = Task { try await pool.run() }
         defer { task.cancel() }
 
-        let socket = try Socket(domain: AF_UNIX, type: Socket.stream)
+        let socket = try Socket(domain: AF_UNIX, type: .stream)
         let suspension = Task {
             try await pool.suspendSocket(socket, untilReadyFor: .read)
         }
@@ -160,7 +160,7 @@ struct SocketPoolTests {
         let task = Task { try await pool.run() }
         defer { task.cancel() }
 
-        let socket = try Socket(domain: AF_UNIX, type: Socket.stream)
+        let socket = try Socket(domain: AF_UNIX, type: .stream)
         let suspension = Task {
             try await pool.suspendSocket(socket, untilReadyFor: .read)
         }

FlyingSocks/Tests/SocketTests.swift

@@ -98,7 +98,7 @@ struct SocketTests {
 
     @Test
     func socketWrite_Throws_WhenSocketIsNotConnected() async throws {
-        let s1 = try Socket(domain: AF_UNIX, type: Socket.stream)
+        let s1 = try Socket(domain: AF_UNIX, type: .stream)
         let data = Data(repeating: 0x01, count: 100)
         #expect(throws: SocketError.self) {
             try s1.write(data, from: data.startIndex)
@@ -108,7 +108,7 @@ struct SocketTests {
 
     @Test
     func socket_Sets_And_Gets_ReceiveBufferSize() throws {
-        let socket = try Socket(domain: AF_UNIX, type: Socket.stream)
+        let socket = try Socket(domain: AF_UNIX, type: .stream)
 
         try socket.setValue(2048, for: .receiveBufferSize)
 #if canImport(Darwin)
@@ -121,7 +121,7 @@ struct SocketTests {
 
     @Test
     func socket_Sets_And_Gets_SendBufferSizeOption() throws {
-        let socket = try Socket(domain: AF_UNIX, type: Socket.stream)
+        let socket = try Socket(domain: AF_UNIX, type: .stream)
 
         try socket.setValue(2048, for: .sendBufferSize)
 #if canImport(Darwin)
@@ -134,7 +134,7 @@ struct SocketTests {
 
     @Test
     func socket_Sets_And_Gets_BoolOption() throws {
-        let socket = try Socket(domain: AF_UNIX, type: Socket.stream)
+        let socket = try Socket(domain: AF_UNIX, type: .stream)
 
         try socket.setValue(true, for: .localAddressReuse)
         #expect(try socket.getValue(for: .localAddressReuse))
@@ -145,20 +145,13 @@ struct SocketTests {
 
     @Test
     func socket_Sets_And_Gets_Flags() throws {
-        let socket = try Socket(domain: AF_UNIX, type: Socket.stream)
+        let socket = try Socket(domain: AF_UNIX, type: .stream)
         #expect(try socket.flags.contains(.append) == false)
 
         try socket.setFlags(.append)
         #expect(try socket.flags.contains(.append))
     }
 
-    @Test
-    func socketInit_ThrowsError_WhenInvalid() {
-        #expect(throws: SocketError.self) {
-            _ = try Socket(domain: -1, type: -1)
-        }
-    }
-
     @Test
     func socketAccept_ThrowsError_WhenInvalid() {
         let socket = Socket(file: -1)
@@ -193,7 +186,7 @@ struct SocketTests {
 
     @Test
     func socketBind_ToINET() throws {
-        let socket = try Socket(domain: AF_INET, type: Socket.stream)
+        let socket = try Socket(domain: AF_INET, type: .stream)
         try socket.setValue(true, for: .localAddressReuse)
         let address = Socket.makeAddressINET(port:5050)
         #expect(throws: Never.self) {