Back to Seed Clases

Gio

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gio.SocketControlMessage

Class Gio.SocketControlMessage

Import line:	Gio = imports.gi.Gio;
GIR File:	Gio-2.0.gir
C documentation:	GSocketControlMessage
Class :	SocketControlMessage
Extends:	GObject.Object

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 description 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.

Properties
Properties		Defined By
	parent_instance : GObject.Object read only	Gio.SocketControlMessage
	priv : Gio.SocketControlMessagePrivate read only	Gio.SocketControlMessage

Methods / Constructors
Method / Constructor		Defined By
	new Gio.SocketControlMessage (Object *properties) Create a new Gio.SocketControlMessage Create a new Gio.SocketControlMessage Parameters: Object properties*
	Gio.SocketControlMessage.deserialize (gint32 *level, gint32 type, guint32 size, String data) : Gio.SocketControlMessage Tries to deserialize a socket control message of a given of GSocketControlMessage* if they can understand this kind of message and if so deserialize it into a GSocketControlMessage. Tries to deserialize a socket control message of a given of GSocketControlMessage if they can understand this kind of message and if so deserialize it into a GSocketControlMessage. If there is no implementation for this kind of control message, NULL will be returned. Parameters: gint32 level Required (not null) a socket level gint32 type Required (not null) a socket control message type for the given level guint32 size Required (not null) the size of the data in bytes String data Required (not null) pointer to the message data Returns: Gio.SocketControlMessage the deserialized message or NULL	Gio.SocketControlMessage
	get_level () : gint32 Returns the "level" (i.e. Returns the "level" (i.e. the originating protocol) of the control message. This is often SOL_SOCKET. Returns: gint32 an integer describing the level	Gio.SocketControlMessage
	get_msg_type () : gint32 Returns the protocol specific type of the control message. Returns the protocol specific type of the control message. For instance, for UNIX fd passing this would be SCM_RIGHTS. Returns: gint32 an integer describing the type of control message	Gio.SocketControlMessage
	get_size () : guint32 Returns the space required for the control message, not including headers or alignment. Returns the space required for the control message, not including headers or alignment. Returns: guint32 The number of bytes required.	Gio.SocketControlMessage
	serialize (void* *data) : none Converts the data in the message to bytes placed in the message. Converts the data in the message to bytes placed in the message. returned by g_socket_control_message_get_size() on this object. Parameters: void data Required (not null) A buffer to write data to Returns: none	Gio.SocketControlMessage

Events
None