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, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Authors: Ryan Lortie <desrt@desrt.ca>
  21  */
  22
  23 #ifndef __G_UNIX_FD_LIST_H__
  24 #define __G_UNIX_FD_LIST_H__
  25
  26 #include <gio/gio.h>
  27
  28 G_BEGIN_DECLS
  29
  30 #define G_TYPE_UNIX_FD_LIST                                 (g_unix_fd_list_get_type ())
  31 #define G_UNIX_FD_LIST(inst)                                (G_TYPE_CHECK_INSTANCE_CAST ((inst),                     \
  32                                                              G_TYPE_UNIX_FD_LIST, GUnixFDList))
  33 #define G_UNIX_FD_LIST_CLASS(class)                         (G_TYPE_CHECK_CLASS_CAST ((class),                       \
  34                                                              G_TYPE_UNIX_FD_LIST, GUnixFDListClass))
  35 #define G_IS_UNIX_FD_LIST(inst)                             (G_TYPE_CHECK_INSTANCE_TYPE ((inst),                     \
  36                                                              G_TYPE_UNIX_FD_LIST))
  37 #define G_IS_UNIX_FD_LIST_CLASS(class)                      (G_TYPE_CHECK_CLASS_TYPE ((class),                       \
  38                                                              G_TYPE_UNIX_FD_LIST))
  39 #define G_UNIX_FD_LIST_GET_CLASS(inst)                      (G_TYPE_INSTANCE_GET_CLASS ((inst),                      \
  40                                                              G_TYPE_UNIX_FD_LIST, GUnixFDListClass))
  41
  42 typedef struct _GUnixFDListPrivate                       GUnixFDListPrivate;
  43 typedef struct _GUnixFDListClass                         GUnixFDListClass;
  44
  45 struct _GUnixFDListClass
  46 {
  47   GObjectClass parent_class;
  48
  49   /*< private >*/
  50
  51   /* Padding for future expansion */
  52   void (*_g_reserved1) (void);
  53   void (*_g_reserved2) (void);
  54   void (*_g_reserved3) (void);
  55   void (*_g_reserved4) (void);
  56   void (*_g_reserved5) (void);
  57 };
  58
  59 struct _GUnixFDList
  60 {
  61   GObject parent_instance;
  62   GUnixFDListPrivate *priv;
  63 };
  64
  65 GLIB_AVAILABLE_IN_ALL
  66 GType                   g_unix_fd_list_get_type                         (void) G_GNUC_CONST;
  67 GLIB_AVAILABLE_IN_ALL
  68 GUnixFDList *           g_unix_fd_list_new                              (void);
  69 GLIB_AVAILABLE_IN_ALL
  70 GUnixFDList *           g_unix_fd_list_new_from_array                   (const gint   *fds,
  71                                                                          gint          n_fds);
  72
  73 GLIB_AVAILABLE_IN_ALL
  74 gint                    g_unix_fd_list_append                           (GUnixFDList  *list,
  75                                                                          gint          fd,
  76                                                                          GError      **error);
  77
  78 GLIB_AVAILABLE_IN_ALL
  79 gint                    g_unix_fd_list_get_length                       (GUnixFDList  *list);
  80
  81 GLIB_AVAILABLE_IN_ALL
  82 gint                    g_unix_fd_list_get                              (GUnixFDList  *list,
  83                                                                          gint          index_,
  84                                                                          GError      **error);
  85
  86 GLIB_AVAILABLE_IN_ALL
  87 const gint *            g_unix_fd_list_peek_fds                         (GUnixFDList  *list,
  88                                                                          gint         *length);
  89
  90 GLIB_AVAILABLE_IN_ALL
  91 gint *                  g_unix_fd_list_steal_fds                        (GUnixFDList  *list,
  92                                                                          gint         *length);
  93
  94 G_END_DECLS
  95
  96 #endif /* __G_UNIX_FD_LIST_H__ */