UnixSocketAddress#
Superclasses: SocketAddress
, Object
Implemented Interfaces: 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 abstract_names_supported
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.
Constructors#
- class UnixSocketAddress
- classmethod new(path: str) SocketAddress #
Creates a new
UnixSocketAddress
forpath
.To create abstract socket addresses, on systems that support that, use
new_abstract()
.Added in version 2.22.
- Parameters:
path – the socket path
- classmethod new_abstract(path: Sequence[int]) SocketAddress #
Creates a new
ABSTRACT_PADDED
UnixSocketAddress
forpath
.Deprecated since version Unknown: Use
new_with_type()
.- Parameters:
path – the abstract name
- classmethod new_with_type(path: Sequence[int], type: UnixSocketAddressType) SocketAddress #
Creates a new
UnixSocketAddress
of typetype
with namepath
.If
type
isPATH
, this is equivalent to callingnew()
.If
type
isANONYMOUS
,path
andpath_len
will be ignored.If
path_type
isABSTRACT
, thenpath_len
bytes ofpath
will be copied to the socket’s path, and only those bytes will be considered part of the name. (Ifpath_len
is -1, thenpath
is assumed to be NUL-terminated.) For example, ifpath
was “test”, then callingget_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
isABSTRACT_PADDED
, thenpath_len
bytes ofpath
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, ifpath_len
is -1, thenpath
is assumed to be NUL-terminated.) In this case,get_native_size()
will always return the full size of astruct sockaddr_un
, althoughget_path_len()
will still return just the length ofpath
.ABSTRACT
is preferred overABSTRACT_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.Added in version 2.26.
- Parameters:
path – the name
type – a
UnixSocketAddressType
Methods#
- class UnixSocketAddress
- abstract_names_supported() bool #
Checks if abstract UNIX domain socket names are supported.
Added in version 2.22.
- get_address_type() UnixSocketAddressType #
Gets
address
’s type.Added in version 2.26.
- get_is_abstract() bool #
Tests if
address
is abstract.Added in version 2.22.
Deprecated since version Unknown: Use
get_address_type()
- get_path() str #
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
get_path_len()
to get the true length of this string.Added in version 2.22.
- get_path_len() int #
Gets the length of
address
’s path.For details, see
get_path()
.Added in version 2.22.
Properties#
- class UnixSocketAddress
- props.abstract: bool#
The type of the None singleton.
Deprecated since version Unknown: Use
UnixSocketAddress
:address-type, which distinguishes between zero-padded and non-zero-padded abstract addresses.
- props.address_type: UnixSocketAddressType#
The type of the None singleton.
Added in version 2.22.