WIP: some name changes

Author: milseman

Sources/Samples/Connect.swift

@@ -82,7 +82,7 @@ struct Connect: ParsableCommand {
         try line.withUTF8 { buffer in
           var buffer = UnsafeRawBufferPointer(buffer)
           while !buffer.isEmpty {
-            let c = try socket.sendMessage(bytes: buffer, flags: flags)
+            let c = try socket.send(buffer, flags: flags)
             buffer = .init(rebasing: buffer[c...])
           }
         }

Sources/Samples/Listen.swift

@@ -43,7 +43,7 @@ struct Listen: ParsableCommand {
           info.protocol)
         do {
           try socket.bind(to: info.address)
-          if !info.type.isConnectionLess {
+          if !info.type.isConnectionless {
             try socket.listen(backlog: 10)
           }
           return (socket, info)
@@ -97,15 +97,15 @@ struct Listen: ParsableCommand {
     try socket.closeAfter {
       if udp {
         while true {
-          let (count, flags) = try socket.receiveMessage(into: buffer, sender: &client)
+          let (count, flags) = try socket.receive(into: buffer, sender: &client)
           print(prefix(client: client, flags: flags), terminator: "")
           try FileDescriptor.standardOutput.writeAll(buffer[..<count])
         }
       } else {
         let conn = try socket.accept(client: &client)
         complain("Connection from \(client.niceDescription)")
         while true {
-          let (count, flags) = try conn.receiveMessage(into: buffer, sender: &client)
+          let (count, flags) = try conn.receive(into: buffer, sender: &client)
           guard count > 0 else { break }
           print(prefix(client: client, flags: flags), terminator: "")
           try FileDescriptor.standardOutput.writeAll(buffer[..<count])

Sources/Samples/Util.swift

@@ -50,7 +50,7 @@ extension SocketAddress {
 }
 
 extension SocketDescriptor.ConnectionType {
-  var isConnectionLess: Bool {
+  var isConnectionless: Bool {
     self == .datagram || self == .reliablyDeliveredMessage
   }
 }

Sources/System/Sockets/SocketAddress+IPv4.swift

@@ -45,6 +45,12 @@ extension SocketAddress {
     guard let value = value else { return nil }
     return IPv4(rawValue: value)
   }
+
+  /// Construct a `SocketAddress` holding an IPv4 address and port
+  @_alwaysEmitIntoClient
+  public init(ipv4 address: IPv4.Address, port: Port) {
+    self.init(IPv4(address: address, port: port))
+  }
 }
 
 // @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)

Sources/System/Sockets/SocketAddress+IPv6.swift

@@ -46,6 +46,11 @@ extension SocketAddress {
     return IPv6(rawValue: value)
   }
 
+  /// Construct a `SocketAddress` holding an IPv4 address and port
+  @_alwaysEmitIntoClient
+  public init(ipv6 address: IPv6.Address, port: Port) {
+    self.init(IPv6(address: address, port: port))
+  }
 }
 
 // @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)

Sources/System/Sockets/SocketAddress.swift

@@ -144,7 +144,7 @@ extension SocketAddress {
       }
     }
     set {
-      assert(newValue < _capacity)
+      assert(newValue <= _capacity)
       switch _variant {
       case let .small(length: _, bytes: bytes):
         self._variant = .small(length: UInt8(newValue), bytes: bytes)

Sources/System/Sockets/SocketDescriptor+Messages.swift renamed to Sources/System/Sockets/SocketMessages.swift

@@ -391,26 +391,26 @@ extension SocketDescriptor {
   ///
   /// The corresponding C function is `sendmsg`.
   @_alwaysEmitIntoClient
-  public func sendMessage(
-    bytes: UnsafeRawBufferPointer,
-    recipient: SocketAddress? = nil,
+  public func send(
+    _ bytes: UnsafeRawBufferPointer,
+    to recipient: SocketAddress? = nil,
     ancillary: AncillaryMessageBuffer? = nil,
     flags: MessageFlags = [],
     retryOnInterrupt: Bool = true
   ) throws -> Int {
-    try _sendMessage(
-      bytes: bytes,
-      recipient: recipient,
+    try _send(
+      bytes,
+      to : recipient,
       ancillary: ancillary,
       flags: flags,
       retryOnInterrupt: retryOnInterrupt
     ).get()
   }
 
   @usableFromInline
-  internal func _sendMessage(
-    bytes: UnsafeRawBufferPointer,
-    recipient: SocketAddress?,
+  internal func _send(
+    _ bytes: UnsafeRawBufferPointer,
+    to recipient: SocketAddress?,
     ancillary: AncillaryMessageBuffer?,
     flags: MessageFlags,
     retryOnInterrupt: Bool
@@ -438,7 +438,7 @@ extension SocketDescriptor {
     }
   }
 
-  internal func _sendmsg(
+  private func _sendmsg(
     _ message: UnsafePointer<CInterop.MsgHdr>,
     _ flags: CInt,
     retryOnInterrupt: Bool
@@ -451,40 +451,19 @@ extension SocketDescriptor {
 
 // @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
 extension SocketDescriptor {
-
-  /// Receive a message from a socket.
-  ///
-  /// TODO: describe every parameter and option.
-  ///
-  /// The corresponding C function is `recvmsg`.
-  @_alwaysEmitIntoClient
-  public func receiveMessage(
-    into bytes: UnsafeMutableRawBufferPointer,
-    flags: MessageFlags = [],
-    retryOnInterrupt: Bool = true
-  ) throws -> (received: Int, flags: MessageFlags) {
-    return try _receiveMessage(
-      into: bytes,
-      sender: nil,
-      ancillary: nil,
-      flags: flags,
-      retryOnInterrupt: retryOnInterrupt
-    ).get()
-  }
-
   /// Receive a message from a socket.
   ///
   /// TODO: describe every parameter and option.
   ///
   /// The corresponding C function is `recvmsg`.
   @_alwaysEmitIntoClient
-  public func receiveMessage(
+  public func receive(
     into bytes: UnsafeMutableRawBufferPointer,
     sender: inout SocketAddress,
     flags: MessageFlags = [],
     retryOnInterrupt: Bool = true
   ) throws -> (received: Int, flags: MessageFlags) {
-    return try _receiveMessage(
+    return try _receive(
       into: bytes,
       sender: &sender,
       ancillary: nil,
@@ -499,13 +478,13 @@ extension SocketDescriptor {
   ///
   /// The corresponding C function is `recvmsg`.
   @_alwaysEmitIntoClient
-  public func receiveMessage(
+  public func receive(
     into bytes: UnsafeMutableRawBufferPointer,
     ancillary: inout AncillaryMessageBuffer,
     flags: MessageFlags = [],
     retryOnInterrupt: Bool = true
   ) throws -> (received: Int, flags: MessageFlags) {
-    return try _receiveMessage(
+    return try _receive(
       into: bytes,
       sender: nil,
       ancillary: &ancillary,
@@ -520,14 +499,14 @@ extension SocketDescriptor {
   ///
   /// The corresponding C function is `recvmsg`.
   @_alwaysEmitIntoClient
-  public func receiveMessage(
+  public func receive(
     into bytes: UnsafeMutableRawBufferPointer,
     sender: inout SocketAddress,
     ancillary: inout AncillaryMessageBuffer,
     flags: MessageFlags = [],
     retryOnInterrupt: Bool = true
   ) throws -> (received: Int, flags: MessageFlags) {
-    return try _receiveMessage(
+    return try _receive(
       into: bytes,
       sender: &sender,
       ancillary: &ancillary,
@@ -539,7 +518,7 @@ extension SocketDescriptor {
 
 extension SocketDescriptor {
   @usableFromInline
-  internal func _receiveMessage(
+  internal func _receive(
     into bytes: UnsafeMutableRawBufferPointer,
     sender: UnsafeMutablePointer<SocketAddress>?,
     ancillary: UnsafeMutablePointer<AncillaryMessageBuffer>?,

Tests/SystemTests/SocketTest.swift

@@ -61,17 +61,21 @@ final class SocketTest: XCTestCase {
         name: "recvmsg", rawSocket, Wildcard(), 42,
         interruptable: true
       ) { retryOnInterrupt in
-        _ = try socket.receiveMessage(into: rawBuf,
-                                      flags: .init(rawValue: 42),
-                                      retryOnInterrupt: retryOnInterrupt)
+        var sender = SocketAddress()
+        _ = try socket.receive(into: rawBuf,
+                               sender: &sender,
+                               flags: .init(rawValue: 42),
+                               retryOnInterrupt: retryOnInterrupt)
       },
       MockTestCase(
         name: "sendmsg", rawSocket, Wildcard(), 42,
         interruptable: true
       ) { retryOnInterrupt in
-        _ = try socket.sendMessage(bytes: UnsafeRawBufferPointer(rawBuf),
-                                   flags: .init(rawValue: 42),
-                                   retryOnInterrupt: retryOnInterrupt)
+        let recipient = SocketAddress(ipv4: .loopback, port: 123)
+        _ = try socket.send(UnsafeRawBufferPointer(rawBuf),
+                            to: recipient,
+                            flags: .init(rawValue: 42),
+                            retryOnInterrupt: retryOnInterrupt)
       },
     ]