:right-sidebar: True

UnixFDList
===================================================================

.. currentmodule:: gi.repository.Gio





.. class:: UnixFDList(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.GObject.Object`





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

It may be wrapped in a
```GUnixFDMessage`` <../gio-unix/class.UnixFDMessage.html>`_ and sent over a
:obj:`~gi.repository.Gio.Socket` in the ``G_SOCKET_FAMILY_UNIX`` family by using
:obj:`~gi.repository.Gio.Socket.send_message` and received using
:obj:`~gi.repository.Gio.Socket.receive_message`.

Before 2.74, ``<gio/gunixfdlist.h>`` belonged to the UNIX-specific GIO
interfaces, thus you had to use the ``gio-unix-2.0.pc`` pkg-config file when
using it.

Since 2.74, the API is available for Windows.



Constructors
------------

.. rst-class:: interim-class

.. class:: UnixFDList
   :no-index:


   .. classmethod:: new() -> ~gi.repository.Gio.UnixFDList

      Creates a new :obj:`~gi.repository.Gio.UnixFDList` containing no file descriptors.



      .. versionadded:: 2.24








   .. classmethod:: new_from_array(fds: ~typing.Sequence[int]) -> ~gi.repository.Gio.UnixFDList

      Creates a new :obj:`~gi.repository.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.



      .. versionadded:: 2.24





      :param fds: the initial list of file descriptors









Methods
-------

.. rst-class:: interim-class

.. class:: UnixFDList
   :no-index:


   .. method:: append(fd: int) -> int

      Adds a file descriptor to ``list``.

      The file descriptor is duplicated using dup(). You keep your copy
      of the descriptor and the copy contained in ``list`` will be closed
      when ``list`` 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 :func:`~gi.repository.Gio.UnixFDList.get` then you will receive back a
      duplicated copy of the same file descriptor.



      .. versionadded:: 2.24





      :param fd: a valid open file descriptor





   .. method:: get(index_: int) -> int

      Gets a file descriptor out of ``list``.

      @``index_`` specifies the index of the file descriptor to get.  It is a
      programmer error for @``index_`` to be out of range; see
      :func:`~gi.repository.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.



      .. versionadded:: 2.24





      :param index_: the index into the list





   .. method:: get_length() -> int

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



      .. versionadded:: 2.24








   .. method:: peek_fds() -> list[int]

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

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

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



      .. versionadded:: 2.24


















Fields
------

.. rst-class:: interim-class

.. class:: UnixFDList
   :no-index:
   

   .. attribute:: parent_instance

      






   .. attribute:: priv