Package org.gnome.gio

Class NetworkAddress

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.NetworkAddress

All Implemented Interfaces:

Proxy, SocketConnectable

@Generated("io.github.jwharm.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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NetworkAddress.Builder<B extends NetworkAddress.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	NetworkAddress.NetworkAddressClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gio.SocketConnectable

SocketConnectable.SocketConnectableIface, SocketConnectable.SocketConnectableImpl

Constructor Summary

Constructors

Constructor	Description
NetworkAddress(MemorySegment address)	Create a NetworkAddress proxy instance for the provided memory address.
NetworkAddress(String hostname, short port)	Creates a new GSocketConnectable for connecting to the given hostname and port.

Method Summary

Modifier and Type	Method	Description
protected NetworkAddress	asParent()	Returns this instance as if it were its parent type.
static NetworkAddress.Builder<? extends NetworkAddress.Builder>	builder()	A NetworkAddress.Builder object constructs a NetworkAddress with the specified properties.
String	getHostname()	Gets this NetworkAddress's hostname.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
short	getPort()	Gets this NetworkAddress's port number
String	getScheme()	Gets this NetworkAddress's scheme
static Type	getType()	Get the GType of the NetworkAddress class
static NetworkAddress	loopback(short port)	Creates a new GSocketConnectable for connecting to the local host over a loopback connection to the given port.
static NetworkAddress	parse(String hostAndPort, short defaultPort)	Creates a new GSocketConnectable for connecting to the given hostname and port.
static NetworkAddress	parseUri(String uri, short defaultPort)	Creates a new GSocketConnectable for connecting to the given uri.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newInstance, newInstance, newv, notify_, notify_, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.github.jwharm.javagi.base.Proxy

handle

Methods inherited from interface org.gnome.gio.SocketConnectable

enumerate, proxyEnumerate, toString_

Constructor Details

NetworkAddress

public NetworkAddress(MemorySegment address)

Create a NetworkAddress proxy 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

Method Details

getType

public static 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()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

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

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

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

getHostname

public String getHostname()

Gets this NetworkAddress's hostname. This might be either UTF-8 or ASCII-encoded, depending on what this NetworkAddress was created with.

Returns:

this NetworkAddress's hostname

getPort

public short getPort()

Gets this NetworkAddress's port number

Returns:

this NetworkAddress's port (which may be 0)

getScheme

public String getScheme()

Gets this NetworkAddress's scheme

Returns:

this NetworkAddress's scheme (null if not built from URI)

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().