gio/gunixinputstream.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   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.1 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: Alexander Larsson <alexl@redhat.com>
  19  */
  20
  21 #ifndef __G_UNIX_INPUT_STREAM_H__
  22 #define __G_UNIX_INPUT_STREAM_H__
  23
  24 #include <gio/gio.h>
  25
  26 G_BEGIN_DECLS
  27
  28 #define G_TYPE_UNIX_INPUT_STREAM         (g_unix_input_stream_get_type ())
  29 #define G_UNIX_INPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_UNIX_INPUT_STREAM, GUnixInputStream))
  30 #define G_UNIX_INPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_UNIX_INPUT_STREAM, GUnixInputStreamClass))
  31 #define G_IS_UNIX_INPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_UNIX_INPUT_STREAM))
  32 #define G_IS_UNIX_INPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_UNIX_INPUT_STREAM))
  33 #define G_UNIX_INPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_UNIX_INPUT_STREAM, GUnixInputStreamClass))
  34
  35 /**
  36  * GUnixInputStream:
  37  *
  38  * Implements #GInputStream for reading from selectable unix file descriptors
  39  **/
  40 typedef struct _GUnixInputStream         GUnixInputStream;
  41 typedef struct _GUnixInputStreamClass    GUnixInputStreamClass;
  42 typedef struct _GUnixInputStreamPrivate  GUnixInputStreamPrivate;
  43
  44 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GUnixInputStream, g_object_unref)
  45
  46 struct _GUnixInputStream
  47 {
  48   GInputStream parent_instance;
  49
  50   /*< private >*/
  51   GUnixInputStreamPrivate *priv;
  52 };
  53
  54 struct _GUnixInputStreamClass
  55 {
  56   GInputStreamClass parent_class;
  57
  58   /*< private >*/
  59   /* Padding for future expansion */
  60   void (*_g_reserved1) (void);
  61   void (*_g_reserved2) (void);
  62   void (*_g_reserved3) (void);
  63   void (*_g_reserved4) (void);
  64   void (*_g_reserved5) (void);
  65 };
  66
  67 GLIB_AVAILABLE_IN_ALL
  68 GType          g_unix_input_stream_get_type     (void) G_GNUC_CONST;
  69
  70 GLIB_AVAILABLE_IN_ALL
  71 GInputStream * g_unix_input_stream_new          (gint              fd,
  72                                                  gboolean          close_fd);
  73 GLIB_AVAILABLE_IN_ALL
  74 void           g_unix_input_stream_set_close_fd (GUnixInputStream *stream,
  75                                                  gboolean          close_fd);
  76 GLIB_AVAILABLE_IN_ALL
  77 gboolean       g_unix_input_stream_get_close_fd (GUnixInputStream *stream);
  78 GLIB_AVAILABLE_IN_ALL
  79 gint           g_unix_input_stream_get_fd       (GUnixInputStream *stream);
  80
  81 G_END_DECLS
  82
  83 #endif /* __G_UNIX_INPUT_STREAM_H__ */