Package org.gnome.gio

Class UnixSocketAddress

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.SocketAddress

org.gnome.gio.UnixSocketAddress

All Implemented Interfaces:

SocketConnectable, Proxy

@Generated("io.github.jwharm.JavaGI")
public class UnixSocketAddress
extends SocketAddress
implements SocketConnectable

Support for UNIX-domain (also known as local) sockets, corresponding to struct sockaddr_un.

UNIX domain sockets are generally visible in the filesystem. However, some systems support abstract socket names which are not visible in the filesystem and not affected by the filesystem permissions, visibility, etc. Currently this is only supported under Linux. If you attempt to use abstract sockets on other systems, function calls may return G_IO_ERROR_NOT_SUPPORTED errors. You can use abstractNamesSupported() to see if abstract names are supported.

Since GLib 2.72, GUnixSocketAddress is available on all platforms. It requires underlying system support (such as Windows 10 with AF_UNIX) at run time.

Before GLib 2.72, <gio/gunixsocketaddress.h> belonged to the UNIX-specific GIO interfaces, thus you had to use the gio-unix-2.0.pc pkg-config file when using it. This is no longer necessary since GLib 2.72.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.gnome.gio.SocketAddress

SocketAddress.SocketAddress$Impl, SocketAddress.SocketAddressClass

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.SocketConnectable$Impl, SocketConnectable.SocketConnectableIface

Constructor Summary

Constructors

Constructor	Description
UnixSocketAddress()	Creates a new UnixSocketAddress.
UnixSocketAddress(MemorySegment address)	Create a UnixSocketAddress proxy instance for the provided memory address.
UnixSocketAddress(String path)	Creates a new GUnixSocketAddress for path.

Method Summary

Modifier and Type	Method	Description
static SocketAddress	abstract_(@org.jspecify.annotations.Nullable byte @Nullable [] path)	Deprecated. Use g_unix_socket_address_new_with_type().
static boolean	abstractNamesSupported()	Checks if abstract UNIX domain socket names are supported.
protected UnixSocketAddress	asParent()	Returns this instance as if it were its parent type.
static UnixSocketAddress.Builder<? extends UnixSocketAddress.Builder>	builder()	A UnixSocketAddress.Builder object constructs a UnixSocketAddress with the specified properties.
UnixSocketAddressType	getAddressType()	Gets address's type.
boolean	getIsAbstract()	Deprecated. Use g_unix_socket_address_get_address_type()
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
String	getPath()	Gets address's path, or for abstract sockets the "name".
long	getPathLen()	Gets the length of address's path.
static @Nullable Type	getType()	Get the GType of the UnixSocketAddress class
static SocketAddress	withType(@org.jspecify.annotations.Nullable byte @Nullable [] path, UnixSocketAddressType type)	Creates a new GUnixSocketAddress of type type with name path.

Methods inherited from class org.gnome.gio.SocketAddress

fromNative, getFamily, getNativeSize, toNative

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, 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, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.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 org.javagi.base.Proxy

handle

Methods inherited from interface org.gnome.gio.SocketConnectable

enumerate, formatAsString, proxyEnumerate

Constructor Details

UnixSocketAddress

public UnixSocketAddress(MemorySegment address)

Create a UnixSocketAddress proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

UnixSocketAddress

public UnixSocketAddress(String path)

Creates a new GUnixSocketAddress for path.

To create abstract socket addresses, on systems that support that, use g_unix_socket_address_new_abstract().

Parameters:

path - the socket path

Since:

2.22

UnixSocketAddress

public UnixSocketAddress()

Creates a new UnixSocketAddress.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the UnixSocketAddress class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected UnixSocketAddress 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 SocketAddress

abstract_

@Deprecated
public static SocketAddress abstract_(@org.jspecify.annotations.Nullable byte @Nullable [] path)

Deprecated.

Use g_unix_socket_address_new_with_type().

Creates a new UnixSocketAddressType.ABSTRACT_PADDED GUnixSocketAddress for path.

Parameters:

path - the abstract name

Returns:

a new GUnixSocketAddress

withType

public static SocketAddress withType(@org.jspecify.annotations.Nullable byte @Nullable [] path,
 UnixSocketAddressType type)

Creates a new GUnixSocketAddress of type type with name path.

If type is UnixSocketAddressType.PATH, this is equivalent to calling g_unix_socket_address_new().

If type is UnixSocketAddressType.ANONYMOUS, path and pathLen will be ignored.

If pathType is UnixSocketAddressType.ABSTRACT, then pathLen bytes of path will be copied to the socket's path, and only those bytes will be considered part of the name. (If pathLen is -1, then path is assumed to be NUL-terminated.) For example, if path was "test", then calling g_socket_address_get_native_size() on the returned socket would return 7 (2 bytes of overhead, 1 byte for the abstract-socket indicator byte, and 4 bytes for the name "test").

If pathType is UnixSocketAddressType.ABSTRACT_PADDED, then pathLen bytes of path will be copied to the socket's path, the rest of the path will be padded with 0 bytes, and the entire zero-padded buffer will be considered the name. (As above, if pathLen is -1, then path is assumed to be NUL-terminated.) In this case, g_socket_address_get_native_size() will always return the full size of a struct sockaddr_un, although g_unix_socket_address_get_path_len() will still return just the length of path.

UnixSocketAddressType.ABSTRACT is preferred over UnixSocketAddressType.ABSTRACT_PADDED for new programs. Of course, when connecting to a server created by another process, you must use the appropriate type corresponding to how that process created its listening socket.

Parameters:

path - the name

type - a GUnixSocketAddressType

Returns:

a new GUnixSocketAddress

Since:

2.26

abstractNamesSupported

public static boolean abstractNamesSupported()

Checks if abstract UNIX domain socket names are supported.

Returns:

true if supported, false otherwise

Since:

2.22

getAddressType

public UnixSocketAddressType getAddressType()

Gets address's type.

Returns:

a GUnixSocketAddressType

Since:

2.26

getIsAbstract

@Deprecated
public boolean getIsAbstract()

Deprecated.

Use g_unix_socket_address_get_address_type()

Tests if this UnixSocketAddress is abstract.

Returns:

true if the address is abstract, false otherwise

Since:

2.22

getPath

public String getPath()

Gets address's path, or for abstract sockets the "name".

Guaranteed to be zero-terminated, but an abstract socket may contain embedded zeros, and thus you should use g_unix_socket_address_get_path_len() to get the true length of this string.

Returns:

the path for this UnixSocketAddress

Since:

2.22

getPathLen

public long getPathLen()

Gets the length of address's path.

For details, see g_unix_socket_address_get_path().

Returns:

the length of the path

Since:

2.22

builder

public static UnixSocketAddress.Builder<? extends UnixSocketAddress.Builder> builder()

A UnixSocketAddress.Builder object constructs a UnixSocketAddress with the specified properties. Use the various set...() methods to set properties, and finish construction with UnixSocketAddress.Builder.build().

Returns:

the builder object