Interface SocketAddress

All Superinterfaces:
Address
public interface SocketAddress extends Address
The address of a socket, an inet socket address or a domain socket address.

Use inetSocketAddress(int, String) to create an inet socket address and domainSocketAddress(String) to create a domain socket address

Author:
Tim Fox

  • Method Details

    • fromJson

      static SocketAddress fromJson(JsonObject json)

    • sharedRandomPort

      static SocketAddress sharedRandomPort(int id, String host)
      Create an inet socket address that binds to a shared random port identified by id.
      The host string can be a host name or a host address.
      No name resolution will be attempted.
      Parameters:
      id - the shared random port id
      host - the host
      Returns:
      the created socket address

    • inetSocketAddress

      static SocketAddress inetSocketAddress(int port, String host)
      Create an inet socket address, host must be non null and port must be between 0 and 65536.
      The host string can be a host name or a host address.
      No name resolution will be attempted.
      Parameters:
      port - the port
      host - the host
      Returns:
      the created socket address

    • domainSocketAddress

      static SocketAddress domainSocketAddress(String path)
      Create a domain socket address from a path.
      Parameters:
      path - the address path
      Returns:
      the created socket address

    • inetSocketAddress

      static SocketAddress inetSocketAddress(InetSocketAddress address)
      Create a inet socket address from a Java InetSocketAddress.
      No name resolution will be attempted.
      Parameters:
      address - the address
      Returns:
      the created socket address

    • host

      String host()
      Returns the host name when available or the IP address in string representation.
      Domain socket address returns null.
      Returns:
      the host address

    • hostName

      String hostName()
      Returns the host name when available or null
      Domain socket address returns null.
      Returns:
      the host name

    • hostAddress

      String hostAddress()
      Returns the host IP address when available or null as a String.
      Domain socket address returns null.
      Returns:
      the host address

    • port

      int port()
      Returns:
      the address port or -1 for a domain socket

    • path

      String path()
      Returns:
      the domain socket path or null for inet socket address, empty path represents unnamed domain socket addresses.

    • isInetSocket

      boolean isInetSocket()
      Returns:
      true for an inet socket address

    • isDomainSocket

      boolean isDomainSocket()
      Returns:
      true for an domain socket address

    • toJson

      default JsonObject toJson()