Skip to content

Gio.UnixConnection

class — extends SocketConnection

This is the subclass of SocketConnection that is created for UNIX domain sockets.

It contains functions to do some of the UNIX socket specific functionality like passing file descriptors.

Since GLib 2.72, GUnixConnection 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/gunixconnection.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.

Methods

receive_credentials

def receive_credentials(self, cancellable: Cancellable | None = ...) -> Credentials

Receives credentials from the sending end of the connection. The sending end has to call UnixConnection.send_credentials (or similar) for this to work.

As well as reading the credentials this also reads (and discards) a single byte from the stream, as this is required for credentials passing to work on some implementations.

This method can be expected to be available on the following platforms:

  • Linux since GLib 2.26
  • FreeBSD since GLib 2.26
  • GNU/kFreeBSD since GLib 2.36
  • Solaris, Illumos and OpenSolaris since GLib 2.40
  • GNU/Hurd since GLib 2.40

Other ways to exchange credentials with a foreign peer includes the UnixCredentialsMessage type and Socket.get_credentials function.

Parameters:

receive_credentials_async

def receive_credentials_async(self, cancellable: Cancellable | None = ..., callback: Callable[[UnixConnection | None, AsyncResult], None] | None = ...) -> None

Asynchronously receive credentials.

For more details, see UnixConnection.receive_credentials which is the synchronous version of this call.

When the operation is finished, callback will be called. You can then call UnixConnection.receive_credentials_finish to get the result of the operation.

Parameters:

  • cancellable — optional Cancellable object, None to ignore.
  • callback — a GAsyncReadyCallback to call when the request is satisfied

receive_credentials_finish

def receive_credentials_finish(self, result: AsyncResult) -> Credentials

Finishes an asynchronous receive credentials operation started with UnixConnection.receive_credentials_async.

Parameters:

receive_fd

def receive_fd(self, cancellable: Cancellable | None = ...) -> int

Receives a file descriptor from the sending end of the connection. The sending end has to call UnixConnection.send_fd for this to work.

As well as reading the fd this also reads a single byte from the stream, as this is required for fd passing to work on some implementations.

Parameters:

  • cancellable — optional Cancellable object, None to ignore

send_credentials

def send_credentials(self, cancellable: Cancellable | None = ...) -> bool

Passes the credentials of the current user the receiving side of the connection. The receiving end has to call UnixConnection.receive_credentials (or similar) to accept the credentials.

As well as sending the credentials this also writes a single NUL byte to the stream, as this is required for credentials passing to work on some implementations.

This method can be expected to be available on the following platforms:

  • Linux since GLib 2.26
  • FreeBSD since GLib 2.26
  • GNU/kFreeBSD since GLib 2.36
  • Solaris, Illumos and OpenSolaris since GLib 2.40
  • GNU/Hurd since GLib 2.40

Other ways to exchange credentials with a foreign peer includes the UnixCredentialsMessage type and Socket.get_credentials function.

Parameters:

send_credentials_async

def send_credentials_async(self, cancellable: Cancellable | None = ..., callback: Callable[[UnixConnection | None, AsyncResult], None] | None = ...) -> None

Asynchronously send credentials.

For more details, see UnixConnection.send_credentials which is the synchronous version of this call.

When the operation is finished, callback will be called. You can then call UnixConnection.send_credentials_finish to get the result of the operation.

Parameters:

  • cancellable — optional Cancellable object, None to ignore.
  • callback — a GAsyncReadyCallback to call when the request is satisfied

send_credentials_finish

def send_credentials_finish(self, result: AsyncResult) -> bool

Finishes an asynchronous send credentials operation started with UnixConnection.send_credentials_async.

Parameters:

send_fd

def send_fd(self, fd: int, cancellable: Cancellable | None = ...) -> bool

Passes a file descriptor to the receiving side of the connection. The receiving end has to call UnixConnection.receive_fd to accept the file descriptor.

As well as sending the fd this also writes a single byte to the stream, as this is required for fd passing to work on some implementations.

Parameters:

  • fd — a file descriptor
  • cancellable — optional Cancellable object, None to ignore.