1 /* GIO - GLib Input, Output and Streaming Library
2 *
3 * Copyright (C) 2010 Christian Kellner
4 *
5 * SPDX-License-Identifier: LGPL-2.1-or-later
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General
18 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
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 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GFileDescriptorBased, g_object_unref)
35
36 typedef struct _GFileDescriptorBasedIface GFileDescriptorBasedIface;
37
38 /**
39 * GFileDescriptorBasedIface:
40 * @g_iface: The parent interface.
41 * @get_fd: Gets the underlying file descriptor.
42 *
43 * An interface for file descriptor based io objects.
44 **/
45 struct _GFileDescriptorBasedIface
46 {
47 GTypeInterface g_iface;
48
49 /* Virtual Table */
50 int (*get_fd) (GFileDescriptorBased *fd_based);
51 };
52
53 GIO_AVAILABLE_IN_ALL
54 GType g_file_descriptor_based_get_type (void) G_GNUC_CONST;
55
56 GIO_AVAILABLE_IN_ALL
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__ */