Initial commit
[platform/upstream/glib2.0.git] / gio / gfiledescriptorbased.h
1 /* GIO - GLib Input, Output and Streaming Library
2  *
3  * Copyright (C) 2010 Christian Kellner
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 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, write to the
17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18  * Boston, MA 02111-1307, USA.
19  *
20  * Author: Christian Kellner <gicmo@gnome.org>
21  */
22
23 #ifndef __G_FILE_DESCRIPTOR_BASED_H__
24 #define __G_FILE_DESCRIPTOR_BASED_H__
25
26 #include <gio/gio.h>
27
28 G_BEGIN_DECLS
29
30 #define G_TYPE_FILE_DESCRIPTOR_BASED            (g_file_descriptor_based_get_type ())
31 #define G_FILE_DESCRIPTOR_BASED(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_FILE_DESCRIPTOR_BASED, GFileDescriptorBased))
32 #define G_IS_FILE_DESCRIPTOR_BASED(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_FILE_DESCRIPTOR_BASED))
33 #define G_FILE_DESCRIPTOR_BASED_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_FILE_DESCRIPTOR_BASED, GFileDescriptorBasedIface))
34
35 /**
36  * GFileDescriptorBased:
37  *
38  * An interface for file descriptor based io objects.
39  **/
40 typedef struct _GFileDescriptorBasedIface   GFileDescriptorBasedIface;
41
42 /**
43  * GFileDescriptorBasedIface:
44  * @g_iface: The parent interface.
45  *
46  **/
47 struct _GFileDescriptorBasedIface
48 {
49   GTypeInterface g_iface;
50
51   /* Virtual Table */
52   int (*get_fd) (GFileDescriptorBased *fd_based);
53 };
54
55 GType    g_file_descriptor_based_get_type     (void) G_GNUC_CONST;
56
57 int      g_file_descriptor_based_get_fd       (GFileDescriptorBased *fd_based);
58
59 G_END_DECLS
60
61
62 #endif /* __G_FILE_DESCRIPTOR_BASED_H__ */
63