gio/org.gtkkn.bindings.gio/UnixCredentialsMessage

UnixCredentialsMessage

open class UnixCredentialsMessage(pointer: <Error class: unknown class><<Error class: unknown class>>) : SocketControlMessage

This #GSocketControlMessage contains a #GCredentials instance. It may be sent using g_socket_send_message() and received using g_socket_receive_message() over UNIX sockets (ie: sockets in the %G_SOCKET_FAMILY_UNIX family).

For an easier way to send and receive credentials over stream-oriented UNIX sockets, see g_unix_connection_send_credentials() and g_unix_connection_receive_credentials(). To receive credentials of a foreign process connected to a socket, use g_socket_get_credentials().

Since GLib 2.72, #GUnixCredentialMessage 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/gunixcredentialsmessage.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.

Since

2.26

Constructors

UnixCredentialsMessage

constructor()

Creates a new #GUnixCredentialsMessage with credentials matching the current processes.

constructor(credentials: Credentials)

Creates a new #GUnixCredentialsMessage holding @credentials.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

credentials

open val credentials: Credentials

The credentials stored in the message.

gioSocketControlMessagePointer

val gioSocketControlMessagePointer: <Error class: unknown class><<Error class: unknown class>>

gioUnixCredentialsMessagePointer

val gioUnixCredentialsMessagePointer: <Error class: unknown class><<Error class: unknown class>>

Functions

getCredentials

open fun getCredentials(): Credentials

Gets the credentials stored in @message.

getLevel

open fun getLevel(): Int

Returns the "level" (i.e. the originating protocol) of the control message. This is often SOL_SOCKET.

getMsgType

open fun getMsgType(): Int

Returns the protocol specific type of the control message. For instance, for UNIX fd passing this would be SCM_RIGHTS.

getSize

open fun getSize(): <Error class: unknown class>

Returns the space required for the control message, not including headers or alignment.