UnixSocketAddress

Support for UNIX-domain (also known as local) sockets.

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 g_unix_socket_address_abstract_names_supported() to see if abstract names are supported.

Note that <gio/gunixsocketaddress.h> belongs to the UNIX-specific GIO interfaces, thus you have to use the gio-unix-2.0.pc pkg-config file when using it.

class UnixSocketAddress : SocketAddress {

protected

GUnixSocketAddress* gUnixSocketAddress;

GUnixSocketAddress* getUnixSocketAddressStruct();

void* getStruct();

this(GUnixSocketAddress* gUnixSocketAddress);

void setStruct(GObject* obj);

this(string path);

this(string path, int pathLen);

this(string path, GUnixSocketAddressType type);

int getIsAbstract();

GUnixSocketAddressType getAddressType();

string getPath();

gsize getPathLen();

static int abstractNamesSupported();

}

Constructors

this this(GUnixSocketAddress* gUnixSocketAddress): Sets our main struct and passes it to the parent class
this this(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(). Since 2.22
this this(string path, int pathLen): Warning g_unix_socket_address_new_abstract is deprecated and should not be used in newly-written code. Use g_unix_socket_address_new_with_type(). Creates a new G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED GUnixSocketAddress for path.
this this(string path, GUnixSocketAddressType type): Creates a new GUnixSocketAddress of type type with name path. If type is G_UNIX_SOCKET_ADDRESS_PATH, this is equivalent to calling g_unix_socket_address_new(). If path_type is G_UNIX_SOCKET_ADDRESS_ABSTRACT, then path_len bytes of path will be copied to the socket's path, and only those bytes will be considered part of the name. (If path_len 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 path_type is G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED, then path_len 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 path_len 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. G_UNIX_SOCKET_ADDRESS_ABSTRACT is preferred over G_UNIX_SOCKET_ADDRESS_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. Since 2.26

Members

Functions

getAddressType GUnixSocketAddressType getAddressType(): Gets address's type. Since 2.26
getIsAbstract int getIsAbstract(): Warning g_unix_socket_address_get_is_abstract is deprecated and should not be used in newly-written code. Use g_unix_socket_address_get_address_type() Tests if address is abstract. Since 2.22
getPath 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. Since 2.22
getPathLen gsize getPathLen(): Gets the length of address's path. For details, see g_unix_socket_address_get_path(). Since 2.22
getStruct void* getStruct(): the main Gtk struct as a void*
getUnixSocketAddressStruct GUnixSocketAddress* getUnixSocketAddressStruct(): Get the main Gtk struct
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

abstractNamesSupported int abstractNamesSupported(): Checks if abstract UNIX domain socket names are supported. Since 2.22

Variables

gUnixSocketAddress GUnixSocketAddress* gUnixSocketAddress;: the main Gtk struct

Inherited Members

From SocketAddress

gSocketAddress GSocketAddress* gSocketAddress;: the main Gtk struct
getSocketAddressStruct GSocketAddress* getSocketAddressStruct(): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.
__anonymous mixin SocketConnectableT!(GSocketAddress): Undocumented in source.
getFamily GSocketFamily getFamily(): Gets the socket family type of address. Since 2.22
toNative int toNative(void* dest, gsize destlen): Converts a GSocketAddress to a native struct sockaddr, which can be passed to low-level functions like connect() or bind(). If not enough space is available, a G_IO_ERROR_NO_SPACE error is returned. If the address type is not known on the system then a G_IO_ERROR_NOT_SUPPORTED error is returned. Since 2.22
getNativeSize gssize getNativeSize(): Gets the size of address's native struct sockaddr. You can use this to allocate memory to pass to g_socket_address_to_native(). Since 2.22