gio/gunixinputstream.h

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