gio/org.gtkkn.bindings.gio/UnixFDMessage

UnixFDMessage

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

This class@Gio.SocketControlMessage contains a class@Gio.UnixFDList. It may be sent using method@Gio.Socket.send_message and received using method@Gio.Socket.receive_message over UNIX sockets (ie: sockets in the G_SOCKET_FAMILY_UNIX family). The file descriptors are copied between processes by the kernel.

For an easier way to send and receive file descriptors over stream-oriented UNIX sockets, see method@Gio.UnixConnection.send_fd and method@Gio.UnixConnection.receive_fd.

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

Skipped during bindings generation

  • parameter length: length: Out parameter is not supported

Constructors

Link copied to clipboard
constructor()

Creates a new #GUnixFDMessage containing an empty file descriptor list.

constructor(fdList: UnixFDList)

Creates a new #GUnixFDMessage containing @list.

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

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
open val fdList: UnixFDList

The class@Gio.UnixFDList object to send with the message.

Link copied to clipboard
val gioSocketControlMessagePointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
val gioUnixFDMessagePointer: <Error class: unknown class><<Error class: unknown class>>

Functions

Link copied to clipboard
open fun appendFd(fd: Int): <Error class: unknown class><Boolean>

Adds a file descriptor to @message.

Link copied to clipboard
open fun getFdList(): UnixFDList

Gets the #GUnixFDList contained in @message. This function does not return a reference to the caller, but the returned list is valid for the lifetime of @message.

Link copied to clipboard
open fun getLevel(): Int

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

Link copied to clipboard
open fun getMsgType(): Int

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

Link copied to clipboard
open fun getSize(): <Error class: unknown class>

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