Class: Gio::UnixFDList

Inherits:
Object
  • Object
show all
Defined in:
(unknown)

Instance Method Summary collapse

Constructor Details

#initialize(fds, n_fds) ⇒ Gio::UnixFDList

Creates a new GUnix::FDList 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.

Parameters:

  • fds (Array<Integer>) —

    the initial list of file descriptors

  • n_fds (Integer) —

    the length of #fds, or -1

Instance Method Details

#append(fd) ⇒ Integer

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 g_unix_fd_list_get() then you will receive back a
duplicated copy of the same file descriptor.

Parameters:

  • fd (Integer) —

    a valid open file descriptor

Returns:

  • (Integer) —

    the index of the appended fd in case of success, else -1
    (and error is set)

#get(index_) ⇒ Integer

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

Parameters:

  • index_ (Integer) —

    the index into the list

Returns:

  • (Integer) —

    the file descriptor, or -1 in case of error

#length ⇒ Integer

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

Returns:

  • (Integer) —

    the length of list

#peek_fds(length) ⇒ Array<Integer>

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-nil 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 nil. In case there are no file
descriptors contained in list, an empty array is returned.

Parameters:

  • length (Integer) —

    pointer to the length of the returned
    array, or nil

Returns:

  • (Array<Integer>) —

    an array of file
    descriptors

#steal_fds(length) ⇒ Array<Integer>

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

After this call, the descriptors are no longer contained in
list. Further calls will return an empty list (unless more
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. The file descriptors in the array are set to
close-on-exec.

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

Parameters:

  • length (Integer) —

    pointer to the length of the returned
    array, or nil

Returns:

  • (Array<Integer>) —

    an array of file
    descriptors