Merge pull request #648 from Comcast/topic/unix

Add UnixSocketAddress and GenSocketAddress, add Wildcard aliases for …

Author: mpilquist

build.sbt

@@ -76,7 +76,9 @@ lazy val core = crossProject(JVMPlatform, JSPlatform, NativePlatform)
       if (tlIsScala3.value) Nil
       else List("org.scala-lang" % "scala-reflect" % scalaVersion.value % "provided")
     },
-    scalacOptions := scalacOptions.value.filterNot(_ == "-source:3.0-migration")
+    scalacOptions := scalacOptions.value.filterNot(_ == "-source:3.0-migration"),
+    Compile / doc / scalacOptions ++= (if (scalaVersion.value.startsWith("2.")) Seq("-nowarn")
+                                       else Nil)
   )
   .settings(
     libraryDependencies ++= Seq(

shared/src/main/scala/com/comcast/ip4s/GenSocketAddress.scala

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2018 Comcast Cable Communications Management, LLC
+ *
+ * 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 com.comcast.ip4s
+
+/** Supertype for types that specify address information for opening a socket.
+  *
+  * There are two built-in subtypes:
+  *  - [[SocketAddress]] - which specifies address and port info for IPv4/IPv6 sockets
+  *  - [[UnixSocketAddress]] - which specifies the path to a unix domain socket
+  *
+  * This trait is left open for extension, allowing other address types to be defined.
+  * When using this trait, pattern match on the supported subtypes.
+  */
+abstract class GenSocketAddress private[ip4s] () {
+
+  /** Downcasts this address to a `SocketAddress[IpAddress]`.
+    *
+    * @throws UnsupportedOperationException if this address is not a `SocketAddress[IpAddress]`
+    */
+  def asIpUnsafe: SocketAddress[IpAddress] = this match {
+    case addr @ SocketAddress(_: IpAddress, _) => addr.asInstanceOf[SocketAddress[IpAddress]]
+    case other =>
+      throw new UnsupportedOperationException(s"asIpUnsafe only supported on SocketAddress[IpAddress]: $other")
+  }
+}

shared/src/main/scala/com/comcast/ip4s/Host.scala

@@ -196,6 +196,10 @@ sealed abstract class IpAddress extends IpAddressPlatform with Host with Seriali
   /** Maps a type-preserving function across this IP address. */
   def transform(v4: Ipv4Address => Ipv4Address, v6: Ipv6Address => Ipv6Address): this.type
 
+  /** Returns true if this address is either 0.0.0.0 or ::. */
+  def isWildcard: Boolean =
+    fold(_ == Ipv4Address.Wildcard, _ == Ipv6Address.Wildcard)
+
   /** Returns true if this address is in the multicast range. */
   def isMulticast: Boolean
 
@@ -425,6 +429,9 @@ final class Ipv4Address private (protected val bytes: Array[Byte]) extends IpAdd
 
 object Ipv4Address extends Ipv4AddressCompanionPlatform {
 
+  /** Wildcard IPv4 address - 0.0.0.0 */
+  val Wildcard: Ipv4Address = fromBytes(0, 0, 0, 0)
+
   /** First IP address in the IPv4 multicast range. */
   val MulticastRangeStart: Ipv4Address = fromBytes(224, 0, 0, 0)
 
@@ -699,6 +706,10 @@ final class Ipv6Address private (protected val bytes: Array[Byte]) extends IpAdd
 
 object Ipv6Address extends Ipv6AddressCompanionPlatform {
 
+  /** Wildcard IPv6 address - 0.0.0.0 */
+  val Wildcard: Ipv6Address =
+    fromBytes(0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)
+
   /** First IP address in the IPv6 multicast range. */
   val MulticastRangeStart: Ipv6Address =
     fromBytes(255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)

shared/src/main/scala/com/comcast/ip4s/Port.scala

@@ -42,6 +42,8 @@ object Port {
   final val MinValue = 0
   final val MaxValue = 65535
 
+  final val Wildcard: Port = new Port(0)
+
   def fromInt(value: Int): Option[Port] =
     if (value >= MinValue && value <= MaxValue) Some(new Port(value)) else None
 

shared/src/main/scala/com/comcast/ip4s/SocketAddress.scala

@@ -21,7 +21,7 @@ import cats.syntax.all._
 
 /** An IP address of the specified type and a port number. Used to describe the source or destination of a socket.
   */
-final case class SocketAddress[+A <: Host](host: A, port: Port) extends SocketAddressPlatform[A] {
+final case class SocketAddress[+A <: Host](host: A, port: Port) extends GenSocketAddress with SocketAddressPlatform[A] {
   override def toString: String =
     host match {
       case _: Ipv6Address => s"[$host]:$port"
@@ -34,6 +34,13 @@ final case class SocketAddress[+A <: Host](host: A, port: Port) extends SocketAd
 }
 
 object SocketAddress extends SocketAddressCompanionPlatform {
+
+  /** Alias for 0.0.0.0:0. */
+  val Wildcard: SocketAddress[Host] = SocketAddress(Ipv4Address.Wildcard, Port.Wildcard)
+
+  /** Alias for 0.0.0.0:port. */
+  def port(port: Port): SocketAddress[Host] = SocketAddress(Ipv4Address.Wildcard, port)
+
   def fromString(value: String): Option[SocketAddress[Host]] =
     fromStringIp(value) orElse fromStringHostname(value) orElse fromStringIDN(value)
 

shared/src/main/scala/com/comcast/ip4s/UnixSocketAddress.scala

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2018 Comcast Cable Communications Management, LLC
+ *
+ * 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 com.comcast.ip4s
+
+import cats.{Order, Show}
+
+final case class UnixSocketAddress(path: String) extends GenSocketAddress with Ordered[UnixSocketAddress] {
+  override def toString: String = path
+  override def compare(that: UnixSocketAddress): Int = path.compare(that.path)
+}
+
+object UnixSocketAddress {
+  implicit val order: Order[UnixSocketAddress] = Order.fromComparable[UnixSocketAddress]
+  implicit val show: Show[UnixSocketAddress] = Show.fromToString[UnixSocketAddress]
+}