gio/gunixfdlist.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright © 2009 Codethink Limited
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU Lesser General Public License as published
   7  * by the Free Software Foundation; either version 2 of the licence or (at
   8  * your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Authors: Ryan Lortie <desrt@desrt.ca>
  19  */
  20
  21 #ifndef __G_UNIX_FD_LIST_H__
  22 #define __G_UNIX_FD_LIST_H__
  23
  24 #include <gio/gio.h>
  25
  26 G_BEGIN_DECLS
  27
  28 #define G_TYPE_UNIX_FD_LIST                                 (g_unix_fd_list_get_type ())
  29 #define G_UNIX_FD_LIST(inst)                                (G_TYPE_CHECK_INSTANCE_CAST ((inst),                     \
  30                                                              G_TYPE_UNIX_FD_LIST, GUnixFDList))
  31 #define G_UNIX_FD_LIST_CLASS(class)                         (G_TYPE_CHECK_CLASS_CAST ((class),                       \
  32                                                              G_TYPE_UNIX_FD_LIST, GUnixFDListClass))
  33 #define G_IS_UNIX_FD_LIST(inst)                             (G_TYPE_CHECK_INSTANCE_TYPE ((inst),                     \
  34                                                              G_TYPE_UNIX_FD_LIST))
  35 #define G_IS_UNIX_FD_LIST_CLASS(class)                      (G_TYPE_CHECK_CLASS_TYPE ((class),                       \
  36                                                              G_TYPE_UNIX_FD_LIST))
  37 #define G_UNIX_FD_LIST_GET_CLASS(inst)                      (G_TYPE_INSTANCE_GET_CLASS ((inst),                      \
  38                                                              G_TYPE_UNIX_FD_LIST, GUnixFDListClass))
  39
  40 typedef struct _GUnixFDListPrivate                       GUnixFDListPrivate;
  41 typedef struct _GUnixFDListClass                         GUnixFDListClass;
  42
  43 struct _GUnixFDListClass
  44 {
  45   GObjectClass parent_class;
  46
  47   /*< private >*/
  48
  49   /* Padding for future expansion */
  50   void (*_g_reserved1) (void);
  51   void (*_g_reserved2) (void);
  52   void (*_g_reserved3) (void);
  53   void (*_g_reserved4) (void);
  54   void (*_g_reserved5) (void);
  55 };
  56
  57 struct _GUnixFDList
  58 {
  59   GObject parent_instance;
  60   GUnixFDListPrivate *priv;
  61 };
  62
  63 GLIB_AVAILABLE_IN_ALL
  64 GType                   g_unix_fd_list_get_type                         (void) G_GNUC_CONST;
  65 GLIB_AVAILABLE_IN_ALL
  66 GUnixFDList *           g_unix_fd_list_new                              (void);
  67 GLIB_AVAILABLE_IN_ALL
  68 GUnixFDList *           g_unix_fd_list_new_from_array                   (const gint   *fds,
  69                                                                          gint          n_fds);
  70
  71 GLIB_AVAILABLE_IN_2_44
  72 void                    g_unix_fd_list_lock                             (GUnixFDList  *list);
  73
  74 GLIB_AVAILABLE_IN_ALL
  75 gint                    g_unix_fd_list_append                           (GUnixFDList  *list,
  76                                                                          gint          fd,
  77                                                                          GError      **error);
  78
  79 GLIB_AVAILABLE_IN_ALL
  80 gint                    g_unix_fd_list_get_length                       (GUnixFDList  *list);
  81
  82 GLIB_AVAILABLE_IN_ALL
  83 gint                    g_unix_fd_list_get                              (GUnixFDList  *list,
  84                                                                          gint          index_,
  85                                                                          GError      **error);
  86
  87 GLIB_AVAILABLE_IN_ALL
  88 const gint *            g_unix_fd_list_peek_fds                         (GUnixFDList  *list,
  89                                                                          gint         *length);
  90
  91 GLIB_AVAILABLE_IN_ALL
  92 gint *                  g_unix_fd_list_steal_fds                        (GUnixFDList  *list,
  93                                                                          gint         *length);
  94
  95 G_END_DECLS
  96
  97 #endif /* __G_UNIX_FD_LIST_H__ */