1 /* GIO - GLib Input, Output and Streaming Library
2  *
3  * Copyright © 2009 Codethink Limited
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at 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 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GUnixFDList, g_object_unref)
40 
41 typedef struct _GUnixFDListPrivate                       GUnixFDListPrivate;
42 typedef struct _GUnixFDListClass                         GUnixFDListClass;
43 
44 struct _GUnixFDListClass
45 {
46   GObjectClass parent_class;
47 
48   /*< private >*/
49 
50   /* Padding for future expansion */
51   void (*_g_reserved1) (void);
52   void (*_g_reserved2) (void);
53   void (*_g_reserved3) (void);
54   void (*_g_reserved4) (void);
55   void (*_g_reserved5) (void);
56 };
57 
58 struct _GUnixFDList
59 {
60   GObject parent_instance;
61   GUnixFDListPrivate *priv;
62 };
63 
64 GLIB_AVAILABLE_IN_ALL
65 GType                   g_unix_fd_list_get_type                         (void) G_GNUC_CONST;
66 GLIB_AVAILABLE_IN_ALL
67 GUnixFDList *           g_unix_fd_list_new                              (void);
68 GLIB_AVAILABLE_IN_ALL
69 GUnixFDList *           g_unix_fd_list_new_from_array                   (const gint   *fds,
70                                                                          gint          n_fds);
71 
72 GLIB_AVAILABLE_IN_ALL
73 gint                    g_unix_fd_list_append                           (GUnixFDList  *list,
74                                                                          gint          fd,
75                                                                          GError      **error);
76 
77 GLIB_AVAILABLE_IN_ALL
78 gint                    g_unix_fd_list_get_length                       (GUnixFDList  *list);
79 
80 GLIB_AVAILABLE_IN_ALL
81 gint                    g_unix_fd_list_get                              (GUnixFDList  *list,
82                                                                          gint          index_,
83                                                                          GError      **error);
84 
85 GLIB_AVAILABLE_IN_ALL
86 const gint *            g_unix_fd_list_peek_fds                         (GUnixFDList  *list,
87                                                                          gint         *length);
88 
89 GLIB_AVAILABLE_IN_ALL
90 gint *                  g_unix_fd_list_steal_fds                        (GUnixFDList  *list,
91                                                                          gint         *length);
92 
93 G_END_DECLS
94 
95 #endif /* __G_UNIX_FD_LIST_H__ */
96