GLib.SocketControlMessage – gio-2.0 – Vala Binding Reference

Description:

[ CCode ( type_id = "g_socket_control_message_get_type ()" ) ]
[ Version ( since = "2.22" ) ]
public abstract class SocketControlMessage : Object

A SocketControlMessage is a special-purpose utility message that can be sent to or received from a Socket.

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 send_message and received with 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 receive_message to read such a message.

Namespace: GLib

Package: gio-2.0

Content:

Static methods:

public static SocketControlMessage deserialize (int level, int type, uint8[] data)

Tries to deserialize a socket control message of a given

level

and type.

Creation methods:

Methods:

public virtual int get_level ()

Returns the "level" (i.

public int get_msg_type ()

Returns the protocol specific type of the control message.

public virtual size_t get_size ()

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

public virtual int get_type ()

public virtual void serialize (uint8[] data)

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

Inherited Members:

All known members inherited from class GLib.Object

@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data

get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer

replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref