Gio.UnixFDList

g GObject.Object GObject.Object Gio.UnixFDList Gio.UnixFDList GObject.Object->Gio.UnixFDList

Subclasses:None

Methods

Inherited:GObject.Object (37)
Structs:GObject.ObjectClass (5)
class new ()
class new_from_array (fds)
  append (fd)
  get (index_)
  get_length ()
  peek_fds ()
  steal_fds ()

Virtual Methods

Inherited:GObject.Object (7)

Properties

None

Signals

Inherited:GObject.Object (1)

Fields

Inherited:GObject.Object (1)
Name Type Access Description
parent_instance GObject.Object r  

Class Details

class Gio.UnixFDList(**kwargs)
Bases:GObject.Object
Abstract:No
Structure:Gio.UnixFDListClass

A Gio.UnixFDList contains a list of file descriptors. It owns the file descriptors that it contains, closing them when finalized.

It may be wrapped in a Gio.UnixFDMessage and sent over a Gio.Socket in the Gio.SocketFamily.UNIX family by using Gio.Socket.send_message() and received using Gio.Socket.receive_message().

Note that <gio/gunixfdlist.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.

classmethod new()[source]
Returns:a new Gio.UnixFDList
Return type:Gio.UnixFDList

Creates a new Gio.UnixFDList containing no file descriptors.

New in version 2.24.

classmethod new_from_array(fds)[source]
Parameters:fds ([int]) – the initial list of file descriptors
Returns:a new Gio.UnixFDList
Return type:Gio.UnixFDList

Creates a new Gio.UnixFDList containing the file descriptors given in fds. The file descriptors become the property of the new list and may no longer be used by the caller. The array itself is owned by the caller.

Each file descriptor in the array should be set to close-on-exec.

If n_fds is -1 then fds must be terminated with -1.

New in version 2.24.

append(fd)[source]
Parameters:fd (int) – a valid open file descriptor
Raises:GLib.Error
Returns:the index of the appended fd in case of success, else -1 (and error is set)
Return type:int

Adds a file descriptor to self.

The file descriptor is duplicated using dup(). You keep your copy of the descriptor and the copy contained in self will be closed when self is finalized.

A possible cause of failure is exceeding the per-process or system-wide file descriptor limit.

The index of the file descriptor in the list is returned. If you use this index with Gio.UnixFDList.get() then you will receive back a duplicated copy of the same file descriptor.

New in version 2.24.

get(index_)[source]
Parameters:index (int) – the index into the list
Raises:GLib.Error
Returns:the file descriptor, or -1 in case of error
Return type:int

Gets a file descriptor out of self.

index_ specifies the index of the file descriptor to get. It is a programmer error for index_ to be out of range; see Gio.UnixFDList.get_length().

The file descriptor is duplicated using dup() and set as close-on-exec before being returned. You must call close() on it when you are done.

A possible cause of failure is exceeding the per-process or system-wide file descriptor limit.

New in version 2.24.

get_length()[source]
Returns:the length of self
Return type:int

Gets the length of self (ie: the number of file descriptors contained within).

New in version 2.24.

peek_fds()[source]
Returns:an array of file descriptors
Return type:[int]

Returns the array of file descriptors that is contained in this object.

After this call, the descriptors remain the property of self. The caller must not close them and must not free the array. The array is valid only until self is changed in any way.

If length is non-None 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 None. In case there are no file descriptors contained in self, an empty array is returned.

New in version 2.24.

steal_fds()[source]
Returns:an array of file descriptors
Return type:[int]

Returns the array of file descriptors that is contained in this object.

After this call, the descriptors are no longer contained in self. Further calls will return an empty list (unless more descriptors have been added).

The return result of this function must be freed with GLib.free(). The caller is also responsible for closing all of the file descriptors. The file descriptors in the array are set to close-on-exec.

If length is non-None 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 None. In case there are no file descriptors contained in self, an empty array is returned.

New in version 2.24.