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

UnixFdMessage

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

Companion

object Companion

Properties

fdList

open val fdList: UnixFdList

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

gioSocketControlMessagePointer

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

gioUnixFDMessagePointer

val gioUnixFDMessagePointer: <Error class: unknown class><<Error class: unknown class>>

Functions

appendFd

open fun appendFd(fd: <Error class: unknown class>): <Error class: unknown class><Boolean>

Adds a file descriptor to @message.

getLevel

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

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

getMsgType

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

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.

serialize

open fun serialize(data: <Error class: unknown class>)

Converts the data in the message to bytes placed in the message.