gio/gfiledescriptorbased.c

   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 #include "config.h"
  24 #include "gfiledescriptorbased.h"
  25 #include "glibintl.h"
  26
  27 #include "gioalias.h"
  28
  29 /**
  30  * SECTION:gfiledescriptorbased
  31  * @short_description: Interface for file descriptor based IO
  32  * @include: gio/gio.h
  33  * @see_also: #GInputStream, #GOutputStream
  34  *
  35  * #GFileDescriptorBased is implemented by streams (implementations of
  36  * #GInputStream or #GOutputStream) that are based on file descriptors.
  37  *
  38  * Since: 2.24
  39  *
  40  **/
  41
  42 typedef GFileDescriptorBasedIface GFileDescriptorBasedInterface;
  43 G_DEFINE_INTERFACE (GFileDescriptorBased, g_file_descriptor_based, G_TYPE_OBJECT)
  44
  45 static void
  46 g_file_descriptor_based_default_init (GFileDescriptorBasedInterface *iface)
  47 {
  48 }
  49
  50 /**
  51  * g_file_descriptor_based_get_fd:
  52  * @fd_based: a #GFileDescriptorBased.
  53  *
  54  * Gets the underlying file descriptor.
  55  *
  56  * Returns: The file descriptor
  57  *
  58  * Since: 2.24
  59  **/
  60 int
  61 g_file_descriptor_based_get_fd (GFileDescriptorBased *fd_based)
  62 {
  63   GFileDescriptorBasedIface *iface;
  64
  65   g_return_val_if_fail (G_IS_FILE_DESCRIPTOR_BASED (fd_based), 0);
  66
  67   iface = G_FILE_DESCRIPTOR_BASED_GET_IFACE (fd_based);
  68
  69   return (* iface->get_fd) (fd_based);
  70 }
  71
  72
  73 #define __G_FILE_DESCRIPTOR_BASED_C__
  74 #include "gioaliasdef.c"