Back to Seed Clases

Gio

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gio.SocketControlMessage
Gio.UnixFDMessage

Class Gio.UnixFDMessage

Import line:	Gio = imports.gi.Gio;
GIR File:	Gio-2.0.gir
C documentation:	GUnixFDMessage
Class :	UnixFDMessage
Extends:	Gio.SocketControlMessage

This GSocketControlMessage contains a GUnixFDList.
It may be sent using g_socket_send_message() and received using
G_SOCKET_ADDRESS_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 g_unix_connection_send_fd() and
g_unix_connection_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 when using it.

Properties
Properties		Defined By
	fd_list : Gio.UnixFDList	Gio.UnixFDMessage
	parent_instance : Gio.SocketControlMessage read only	Gio.UnixFDMessage
	priv : Gio.UnixFDMessagePrivate read only	Gio.UnixFDMessage

Methods / Constructors
Method / Constructor		Defined By
	new Gio.UnixFDMessage (Object *properties) Create a new Gio.UnixFDMessage Create a new Gio.UnixFDMessage Parameters: Object properties*
	new Gio.UnixFDMessage.with_fd_list (UnixFDList *fd_list) : Gio.SocketControlMessage Create a new Gio.UnixFDMessage Create a new Gio.UnixFDMessage Parameters: Gio.UnixFDList fd_list* Required (not null) a GUnixFDList Returns: Gio.SocketControlMessage a new GUnixFDMessage
	append_fd (gint32 fd) : gboolean Adds a file descriptor to message. Adds a file descriptor to message. The file descriptor is duplicated using dup(). You keep your copy of the descriptor and the copy contained in message will be closed when message is finalized. A possible cause of failure is exceeding the per-process or system-wide file descriptor limit. Parameters: gint32 fd Required (not null) a valid open file descriptor Returns: gboolean TRUE in case of success, else FALSE (and error is set)	Gio.UnixFDMessage
	get_fd_list () : Gio.UnixFDList Gets the GUnixFDList contained in message. Gets the GUnixFDList contained in message. This function does not return a reference to the caller, but the returned list is valid for the lifetime of message. Returns: Gio.UnixFDList the GUnixFDList from message	Gio.UnixFDMessage
	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
	steal_fds (Object *out_values) : Array Returns the array of file descriptors that is contained in this object. Returns the array of file descriptors that is contained in this object. After this call, the descriptors are no longer contained in descriptors have been added). The return result of this function must be freed with g_free(). The caller is also responsible for closing all of the file descriptors. If length* is non-NULL then it is set to the number of file descriptors in the returned array. The returned array is also terminated with -1. This function never returns NULL. In case there are no file descriptors contained in message, an empty array is returned. descriptors Parameters: Object out_values gint32 length Returns: Array an array of file	Gio.UnixFDMessage

Events
None