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_MESSAGE_H__
22 #define __G_UNIX_FD_MESSAGE_H__
23 
24 #include <gio/gio.h>
25 #include <gio/gunixfdlist.h>
26 
27 G_BEGIN_DECLS
28 
29 #define G_TYPE_UNIX_FD_MESSAGE                              (g_unix_fd_message_get_type ())
30 #define G_UNIX_FD_MESSAGE(inst)                             (G_TYPE_CHECK_INSTANCE_CAST ((inst),                     \
31                                                              G_TYPE_UNIX_FD_MESSAGE, GUnixFDMessage))
32 #define G_UNIX_FD_MESSAGE_CLASS(class)                      (G_TYPE_CHECK_CLASS_CAST ((class),                       \
33                                                              G_TYPE_UNIX_FD_MESSAGE, GUnixFDMessageClass))
34 #define G_IS_UNIX_FD_MESSAGE(inst)                          (G_TYPE_CHECK_INSTANCE_TYPE ((inst),                     \
35                                                              G_TYPE_UNIX_FD_MESSAGE))
36 #define G_IS_UNIX_FD_MESSAGE_CLASS(class)                   (G_TYPE_CHECK_CLASS_TYPE ((class),                       \
37                                                              G_TYPE_UNIX_FD_MESSAGE))
38 #define G_UNIX_FD_MESSAGE_GET_CLASS(inst)                   (G_TYPE_INSTANCE_GET_CLASS ((inst),                      \
39                                                              G_TYPE_UNIX_FD_MESSAGE, GUnixFDMessageClass))
40 
41 typedef struct _GUnixFDMessagePrivate                       GUnixFDMessagePrivate;
42 typedef struct _GUnixFDMessageClass                         GUnixFDMessageClass;
43 typedef struct _GUnixFDMessage                              GUnixFDMessage;
44 
45 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GUnixFDMessage, g_object_unref)
46 
47 struct _GUnixFDMessageClass
48 {
49   GSocketControlMessageClass parent_class;
50 
51   /*< private >*/
52 
53   /* Padding for future expansion */
54   void (*_g_reserved1) (void);
55   void (*_g_reserved2) (void);
56 };
57 
58 struct _GUnixFDMessage
59 {
60   GSocketControlMessage parent_instance;
61   GUnixFDMessagePrivate *priv;
62 };
63 
64 GLIB_AVAILABLE_IN_ALL
65 GType                   g_unix_fd_message_get_type                      (void) G_GNUC_CONST;
66 GLIB_AVAILABLE_IN_ALL
67 GSocketControlMessage * g_unix_fd_message_new_with_fd_list              (GUnixFDList     *fd_list);
68 GLIB_AVAILABLE_IN_ALL
69 GSocketControlMessage * g_unix_fd_message_new                           (void);
70 
71 GLIB_AVAILABLE_IN_ALL
72 GUnixFDList *           g_unix_fd_message_get_fd_list                   (GUnixFDMessage  *message);
73 
74 GLIB_AVAILABLE_IN_ALL
75 gint *                  g_unix_fd_message_steal_fds                     (GUnixFDMessage  *message,
76                                                                          gint            *length);
77 GLIB_AVAILABLE_IN_ALL
78 gboolean                g_unix_fd_message_append_fd                     (GUnixFDMessage  *message,
79                                                                          gint             fd,
80                                                                          GError         **error);
81 
82 G_END_DECLS
83 
84 #endif /* __G_UNIX_FD_MESSAGE_H__ */
85