Documentation and coding style fixups
[platform/upstream/glib.git] / gio / gunixfdmessage.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_MESSAGE_H__
24 #define __G_UNIX_FD_MESSAGE_H__
25
26 #include <gio/gsocketcontrolmessage.h>
27
28 G_BEGIN_DECLS
29
30 #define G_TYPE_UNIX_FD_MESSAGE                              (g_unix_fd_message_get_type ())
31 #define G_UNIX_FD_MESSAGE(inst)                             (G_TYPE_CHECK_INSTANCE_CAST ((inst),                     \
32                                                              G_TYPE_UNIX_FD_MESSAGE, GUnixFDMessage))
33 #define G_UNIX_FD_MESSAGE_CLASS(class)                      (G_TYPE_CHECK_CLASS_CAST ((class),                       \
34                                                              G_TYPE_UNIX_FD_MESSAGE, GUnixFDMessageClass))
35 #define G_IS_UNIX_FD_MESSAGE(inst)                          (G_TYPE_CHECK_INSTANCE_TYPE ((inst),                     \
36                                                              G_TYPE_UNIX_FD_MESSAGE))
37 #define G_IS_UNIX_FD_MESSAGE_CLASS(class)                   (G_TYPE_CHECK_CLASS_TYPE ((class),                       \
38                                                              G_TYPE_UNIX_FD_MESSAGE))
39 #define G_UNIX_FD_MESSAGE_GET_CLASS(inst)                   (G_TYPE_INSTANCE_GET_CLASS ((inst),                      \
40                                                              G_TYPE_UNIX_FD_MESSAGE, GUnixFDMessageClass))
41
42 typedef struct _GUnixFDMessagePrivate                       GUnixFDMessagePrivate;
43 typedef struct _GUnixFDMessageClass                         GUnixFDMessageClass;
44 typedef struct _GUnixFDMessage                              GUnixFDMessage;
45
46 struct _GUnixFDMessageClass
47 {
48   GSocketControlMessageClass parent_class;
49
50   /*< private >*/
51
52   /* Padding for future expansion */
53   void (*_g_reserved1) (void);
54   void (*_g_reserved2) (void);
55 };
56
57 struct _GUnixFDMessage
58 {
59   GSocketControlMessage parent_instance;
60   GUnixFDMessagePrivate *priv;
61 };
62
63 GType                   g_unix_fd_message_get_type                      (void) G_GNUC_CONST;
64 GSocketControlMessage * g_unix_fd_message_new                           (void);
65 gint *                  g_unix_fd_message_steal_fds                     (GUnixFDMessage  *message,
66                                                                          gint            *length);
67 gboolean                g_unix_fd_message_append_fd                     (GUnixFDMessage  *message,
68                                                                          gint             fd,
69                                                                          GError         **error);
70
71 G_END_DECLS
72
73 #endif /* __G_UNIX_FD_MESSAGE_H__ */