Class UnixFDList

java.lang.Object
org.javagi.base.ProxyInstance
org.gnome.gobject.TypeInstance
org.gnome.gobject.GObject
org.gnome.gio.UnixFDList
All Implemented Interfaces:
Proxy
@Generated("org.javagi.JavaGI") public class UnixFDList extends GObject

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 and sent over a Socket in the G_SOCKET_FAMILY_UNIX family by using Socket.sendMessage(SocketAddress, OutputVector[], SocketControlMessage[], int, Cancellable) and received using Socket.receiveMessage(Out, InputVector[], Out, Out, Cancellable).

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.

  • Constructor Details

    • UnixFDList

      public UnixFDList(MemorySegment address)
      Create a UnixFDList instance for the provided memory address.
      Parameters:
      address - the memory address of the native object

    • UnixFDList

      public UnixFDList()
      Create a new UnixFDList.

  • Method Details

    • getType

      public static @Nullable Type getType()
      Get the GType of the UnixFDList class.
      Returns:
      the GType

    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      The memory layout of the native struct.
      Returns:
      the memory layout

    • asParent

      protected UnixFDList asParent()
      Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.
      Overrides:
      asParent in class GObject
      Returns:
      the instance as if it were its parent type

    • fromArray

      public static UnixFDList fromArray(@Nullable int @Nullable [] fds)

      Creates a new GUnixFDList 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 nFds is -1 then fds must be terminated with -1.

      Parameters:
      fds - the initial list of file descriptors
      Returns:
      a new GUnixFDList
      Since:
      2.24

    • append

      public int append(int fd) throws GErrorException

      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 this UnixFDList will be closed when this UnixFDList 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 - a valid open file descriptor
      Returns:
      the index of the appended fd in case of success, else -1 (and error is set)
      Throws:
      GErrorException - see GError
      Since:
      2.24

    • get

      public int get(int index) throws GErrorException

      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 - the index into the list
      Returns:
      the file descriptor, or -1 in case of error
      Throws:
      GErrorException - see GError
      Since:
      2.24

    • getLength

      public int getLength()
      Gets the length of this UnixFDList (ie: the number of file descriptors contained within).
      Returns:
      the length of this UnixFDList
      Since:
      2.24

    • peekFds

      public int[] peekFds()

      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 this UnixFDList is changed in any way.

      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 list, an empty array is returned.

      Returns:
      an array of file descriptors
      Since:
      2.24

    • stealFds

      public int[] stealFds()

      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-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 list, an empty array is returned.

      Returns:
      an array of file descriptors
      Since:
      2.24

    • builder

      public static UnixFDList.Builder<? extends UnixFDList.Builder> builder()
      A UnixFDList.Builder object constructs a UnixFDList with the specified properties. Use the various set...() methods to set properties, and finish construction with UnixFDList.Builder.build().
      Returns:
      the builder object