W Wrapl, The Programming Language




Inherits from:

A T is a special-purpose utility message that can be sent to or received from a Gtk.Gio.GSocket.T. 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 description over a UNIX socket).

These messages are sent with Gtk.Gio.GSocket.SendMessage and received with Gtk.Gio.GSocket.ReceiveMessage.

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 Gtk.Gio.GSocket.ReceiveMessage to read such a message.


Nil : T


Deserialize(level @ Std.Integer.SmallT, type @ Std.Integer.SmallT, size @ Std.Integer.SmallT, data @ Std.Address.T) : Gtk.Gio.GSocketControlMessage.T

Tries to deserialize a socket control message of a given level and type. This will ask all known (to GType) subclasses of T if they can understand this kind of message and if so deserialize it into a T.

If there is no implementation for this kind of control message, NULL will be returned.

level a socket level
type a socket control message type for the given level
size the size of the data in bytes
data pointer to the message data. [array length=size][element-type guint8]
Returns the deserialized message or NULL. [transfer full]

GetType() : Gtk.GObject.Type.T


:GetLevel(self @ T) : Std.Integer.SmallT

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

message a T
Returns an integer describing the level

:GetMsgType(self @ T) : Std.Integer.SmallT

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

message a T
Returns an integer describing the type of control message

:GetSize(self @ T) : Std.Integer.SmallT

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

message a T
Returns The number of bytes required.

:Priv(self @ T) : Std.Object.T

:Serialize(self @ T, data @ Std.Address.T) : Std.Object.T

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

data is guaranteed to have enough space to fit the size returned by GetSize on this object.

message a T
data A buffer to write data to

:setPriv(self @ T, value @ Std.Object.T) : Std.Object.T