struct GUnixSocketAddress

struct GUnixSocketAddress;

A UNIX-domain (local) socket address, corresponding to a struct sockaddr_un.

enum GUnixSocketAddressType

typedef enum {
  G_UNIX_SOCKET_ADDRESS_INVALID,
  G_UNIX_SOCKET_ADDRESS_ANONYMOUS,
  G_UNIX_SOCKET_ADDRESS_PATH,
  G_UNIX_SOCKET_ADDRESS_ABSTRACT,
  G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED
} GUnixSocketAddressType;

The type of name used by a GUnixSocketAddress. G_UNIX_SOCKET_ADDRESS_PATH indicates a traditional unix domain socket bound to a filesystem path. G_UNIX_SOCKET_ADDRESS_ANONYMOUS indicates a socket not bound to any name (eg, a client-side socket, or a socket created with socketpair()).

For abstract sockets, there are two incompatible ways of naming them; the man pages suggest using the entire struct sockaddr_un as the name, padding the unused parts of the sun_path field with zeroes; this corresponds to G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED. However, many programs instead just use a portion of sun_path, and pass an appropriate smaller length to bind() or connect(). This is G_UNIX_SOCKET_ADDRESS_ABSTRACT.

Since 2.26

g_unix_socket_address_new ()

GSocketAddress *    g_unix_socket_address_new           (const gchar *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

g_unix_socket_address_new_abstract ()

GSocketAddress *    g_unix_socket_address_new_abstract  (const gchar *path,
                                                         gint path_len);

Creates a new G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED GUnixSocketAddress for path.

g_unix_socket_address_new_with_type ()

GSocketAddress *    g_unix_socket_address_new_with_type (const gchar *path,
                                                         gint path_len,
                                                         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

g_unix_socket_address_get_is_abstract ()

gboolean            g_unix_socket_address_get_is_abstract
                                                        (GUnixSocketAddress *address);

Tests if address is abstract.

Since 2.22

g_unix_socket_address_get_address_type ()

GUnixSocketAddressType  g_unix_socket_address_get_address_type
                                                        (GUnixSocketAddress *address);

Gets address's type.

Since 2.26

g_unix_socket_address_get_path ()

const char *        g_unix_socket_address_get_path      (GUnixSocketAddress *address);

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

g_unix_socket_address_get_path_len ()

gsize               g_unix_socket_address_get_path_len  (GUnixSocketAddress *address);

Gets the length of address's path.

For details, see g_unix_socket_address_get_path().

Since 2.22

g_unix_socket_address_abstract_names_supported ()

gboolean            g_unix_socket_address_abstract_names_supported
                                                        (void);

Checks if abstract unix domain socket names are supported.

Since 2.22

The "abstract" property

  "abstract"                 gboolean              : Read / Write / Construct Only

Whether or not this is an abstract address

Default value: FALSE

The "address-type" property

  "address-type"             GUnixSocketAddressType  : Read / Write / Construct Only

The type of UNIX socket address.

Default value: G_UNIX_SOCKET_ADDRESS_PATH

The "path" property

  "path"                     gchar*                : Read / Write / Construct Only

UNIX socket path.

Default value: NULL

The "path-as-array" property

  "path-as-array"            GByteArray*           : Read / Write / Construct Only

UNIX socket path, as byte array.