Class NetworkAddress

java.lang.Object
org.javagi.base.ProxyInstance
org.gnome.gobject.TypeInstance
org.gnome.gobject.GObject
org.gnome.gio.NetworkAddress
All Implemented Interfaces:
SocketConnectable, Proxy
@Generated("org.javagi.JavaGI") public class NetworkAddress extends GObject implements SocketConnectable

GNetworkAddress provides an easy way to resolve a hostname and then attempt to connect to that host, handling the possibility of multiple IP addresses and multiple address families.

The enumeration results of resolved addresses may be cached as long as this object is kept alive which may have unexpected results if alive for too long.

See SocketConnectable for an example of using the connectable interface.

  • Constructor Details

    • NetworkAddress

      public NetworkAddress(MemorySegment address)
      Create a NetworkAddress instance for the provided memory address.
      Parameters:
      address - the memory address of the native object

    • NetworkAddress

      public NetworkAddress(String hostname, short port)

      Creates a new GSocketConnectable for connecting to the given hostname and port.

      Note that depending on the configuration of the machine, a hostname of localhost may refer to the IPv4 loopback address only, or to both IPv4 and IPv6; use g_network_address_new_loopback() to create a GNetworkAddress that is guaranteed to resolve to both addresses.

      Parameters:
      hostname - the hostname
      port - the port
      Since:
      2.22

    • NetworkAddress

      public NetworkAddress()
      Create a new NetworkAddress.

  • Method Details

    • getType

      public static @Nullable Type getType()
      Get the GType of the NetworkAddress class.
      Returns:
      the GType

    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      The memory layout of the native struct.
      Returns:
      the memory layout

    • asParent

      protected NetworkAddress asParent()
      Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.
      Overrides:
      asParent in class GObject
      Returns:
      the instance as if it were its parent type

    • loopback

      public static NetworkAddress loopback(short port)

      Creates a new GSocketConnectable for connecting to the local host over a loopback connection to the given port. This is intended for use in connecting to local services which may be running on IPv4 or IPv6.

      The connectable will return IPv4 and IPv6 loopback addresses, regardless of how the host resolves localhost. By contrast, g_network_address_new() will often only return an IPv4 address when resolving localhost, and an IPv6 address for localhost6.

      g_network_address_get_hostname() will always return localhost for a GNetworkAddress created with this constructor.

      Parameters:
      port - the port
      Returns:
      the new GNetworkAddress
      Since:
      2.44

    • parse

      public static NetworkAddress parse(String hostAndPort, short defaultPort) throws GErrorException

      Creates a new GSocketConnectable for connecting to the given hostname and port. May fail and return null in case parsing hostAndPort fails.

      hostAndPort may be in any of a number of recognised formats; an IPv6 address, an IPv4 address, or a domain name (in which case a DNS lookup is performed). Quoting with [] is supported for all address types. A port override may be specified in the usual way with a colon.

      If no port is specified in hostAndPort then defaultPort will be used as the port number to connect to.

      In general, hostAndPort is expected to be provided by the user (allowing them to give the hostname, and a port override if necessary) and defaultPort is expected to be provided by the application.

      (The port component of hostAndPort can also be specified as a service name rather than as a numeric port, but this functionality is deprecated, because it depends on the contents of /etc/services, which is generally quite sparse on platforms other than Linux.)

      Parameters:
      hostAndPort - the hostname and optionally a port
      defaultPort - the default port if not in hostAndPort
      Returns:
      the new GNetworkAddress, or null on error
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • parseUri

      public static NetworkAddress parseUri(String uri, short defaultPort) throws GErrorException

      Creates a new GSocketConnectable for connecting to the given uri. May fail and return null in case parsing uri fails.

      Using this rather than g_network_address_new() or g_network_address_parse() allows GSocketClient to determine when to use application-specific proxy protocols.

      Parameters:
      uri - the hostname and optionally a port
      defaultPort - The default port if none is found in the URI
      Returns:
      the new GNetworkAddress, or null on error
      Throws:
      GErrorException - see GError
      Since:
      2.26

    • getHostname

      public String getHostname()
      Gets addr's hostname. This might be either UTF-8 or ASCII-encoded, depending on what this NetworkAddress was created with.
      Returns:
      addr's hostname
      Since:
      2.22

    • getPort

      public short getPort()
      Gets addr's port number
      Returns:
      addr's port (which may be 0)
      Since:
      2.22

    • getScheme

      public @Nullable String getScheme()
      Gets addr's scheme
      Returns:
      addr's scheme (null if not built from URI)
      Since:
      2.26

    • builder

      public static NetworkAddress.Builder<? extends NetworkAddress.Builder> builder()
      A NetworkAddress.Builder object constructs a NetworkAddress with the specified properties. Use the various set...() methods to set properties, and finish construction with NetworkAddress.Builder.build().
      Returns:
      the builder object