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, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Author: Christian Kellner <gicmo@gnome.org>
  19  */
  20
  21 #ifndef __G_FILE_DESCRIPTOR_BASED_H__
  22 #define __G_FILE_DESCRIPTOR_BASED_H__
  23
  24 #include <gio/gio.h>
  25
  26 G_BEGIN_DECLS
  27
  28 #define G_TYPE_FILE_DESCRIPTOR_BASED            (g_file_descriptor_based_get_type ())
  29 #define G_FILE_DESCRIPTOR_BASED(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_FILE_DESCRIPTOR_BASED, GFileDescriptorBased))
  30 #define G_IS_FILE_DESCRIPTOR_BASED(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_FILE_DESCRIPTOR_BASED))
  31 #define G_FILE_DESCRIPTOR_BASED_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_FILE_DESCRIPTOR_BASED, GFileDescriptorBasedIface))
  32 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GFileDescriptorBased, g_object_unref)
  33
  34 /**
  35  * GFileDescriptorBased:
  36  *
  37  * An interface for file descriptor based io objects.
  38  **/
  39 typedef struct _GFileDescriptorBasedIface   GFileDescriptorBasedIface;
  40
  41 /**
  42  * GFileDescriptorBasedIface:
  43  * @g_iface: The parent interface.
  44  * @get_fd: Gets the underlying file descriptor.
  45  *
  46  * An interface for file descriptor based io objects.
  47  **/
  48 struct _GFileDescriptorBasedIface
  49 {
  50   GTypeInterface g_iface;
  51
  52   /* Virtual Table */
  53   int (*get_fd) (GFileDescriptorBased *fd_based);
  54 };
  55
  56 GLIB_AVAILABLE_IN_ALL
  57 GType    g_file_descriptor_based_get_type     (void) G_GNUC_CONST;
  58
  59 GLIB_AVAILABLE_IN_ALL
  60 int      g_file_descriptor_based_get_fd       (GFileDescriptorBased *fd_based);
  61
  62 G_END_DECLS
  63
  64
  65 #endif /* __G_FILE_DESCRIPTOR_BASED_H__ */
  66