gio/org.gtkkn.bindings.gio/SocketControlMessage

SocketControlMessage

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

A #GSocketControlMessage is a special-purpose utility message that can be sent to or received from a #GSocket. These types of messages are often called "ancillary data".

The message can represent some sort of special instruction to or information from the socket or can represent a special kind of transfer to the peer (for example, sending a file descriptor over a UNIX socket).

These messages are sent with g_socket_send_message() and received with g_socket_receive_message().

To extend the set of control message that can be sent, subclass this class and override the get_size, get_level, get_type and serialize methods.

To extend the set of control messages that can be received, subclass this class and implement the deserialize method. Also, make sure your class is registered with the GType typesystem before calling g_socket_receive_message() to read such a message.

Skipped during bindings generation

parameter data: gpointer
parameter data: guint8

Since

2.22

Inheritors

UnixCredentialsMessage

UnixFDMessage

Constructors

SocketControlMessage

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

Types

Companion

object Companion

Properties

gioSocketControlMessagePointer

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

Functions

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.