gio/gbufferedinputstream.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: Christian Kellner <gicmo@gnome.org>
  21  */
  22
  23 #ifndef __G_BUFFERED_INPUT_STREAM_H__
  24 #define __G_BUFFERED_INPUT_STREAM_H__
  25
  26 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  27 #error "Only <gio/gio.h> can be included directly."
  28 #endif
  29
  30 #include <gio/gfilterinputstream.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define G_TYPE_BUFFERED_INPUT_STREAM         (g_buffered_input_stream_get_type ())
  35 #define G_BUFFERED_INPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_BUFFERED_INPUT_STREAM, GBufferedInputStream))
  36 #define G_BUFFERED_INPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_BUFFERED_INPUT_STREAM, GBufferedInputStreamClass))
  37 #define G_IS_BUFFERED_INPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_BUFFERED_INPUT_STREAM))
  38 #define G_IS_BUFFERED_INPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_BUFFERED_INPUT_STREAM))
  39 #define G_BUFFERED_INPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_BUFFERED_INPUT_STREAM, GBufferedInputStreamClass))
  40
  41 /**
  42  * GBufferedInputStream:
  43  *
  44  * Implements #GFilterInputStream with a sized input buffer.
  45  **/
  46 typedef struct _GBufferedInputStreamClass    GBufferedInputStreamClass;
  47 typedef struct _GBufferedInputStreamPrivate  GBufferedInputStreamPrivate;
  48
  49 struct _GBufferedInputStream
  50 {
  51   GFilterInputStream parent_instance;
  52
  53   /*< private >*/
  54   GBufferedInputStreamPrivate *priv;
  55 };
  56
  57 struct _GBufferedInputStreamClass
  58 {
  59   GFilterInputStreamClass parent_class;
  60
  61   gssize   (* fill)        (GBufferedInputStream *stream,
  62                             gssize                count,
  63                             GCancellable         *cancellable,
  64                             GError              **error);
  65
  66   /* Async ops: (optional in derived classes) */
  67   void     (* fill_async)  (GBufferedInputStream *stream,
  68                             gssize                count,
  69                             int                   io_priority,
  70                             GCancellable         *cancellable,
  71                             GAsyncReadyCallback   callback,
  72                             gpointer              user_data);
  73   gssize   (* fill_finish) (GBufferedInputStream *stream,
  74                             GAsyncResult         *result,
  75                             GError              **error);
  76
  77   /*< private >*/
  78   /* Padding for future expansion */
  79   void (*_g_reserved1) (void);
  80   void (*_g_reserved2) (void);
  81   void (*_g_reserved3) (void);
  82   void (*_g_reserved4) (void);
  83   void (*_g_reserved5) (void);
  84 };
  85
  86
  87 GIO_AVAILABLE_IN_ALL
  88 GType         g_buffered_input_stream_get_type        (void) G_GNUC_CONST;
  89 GIO_AVAILABLE_IN_ALL
  90 GInputStream* g_buffered_input_stream_new             (GInputStream          *base_stream);
  91 GIO_AVAILABLE_IN_ALL
  92 GInputStream* g_buffered_input_stream_new_sized       (GInputStream          *base_stream,
  93                                                        gsize                  size);
  94
  95 GIO_AVAILABLE_IN_ALL
  96 gsize         g_buffered_input_stream_get_buffer_size (GBufferedInputStream  *stream);
  97 GIO_AVAILABLE_IN_ALL
  98 void          g_buffered_input_stream_set_buffer_size (GBufferedInputStream  *stream,
  99                                                        gsize                  size);
 100 GIO_AVAILABLE_IN_ALL
 101 gsize         g_buffered_input_stream_get_available   (GBufferedInputStream  *stream);
 102 GIO_AVAILABLE_IN_ALL
 103 gsize         g_buffered_input_stream_peek            (GBufferedInputStream  *stream,
 104                                                        void                  *buffer,
 105                                                        gsize                  offset,
 106                                                        gsize                  count);
 107 GIO_AVAILABLE_IN_ALL
 108 const void*   g_buffered_input_stream_peek_buffer     (GBufferedInputStream  *stream,
 109                                                        gsize                 *count);
 110
 111 GIO_AVAILABLE_IN_ALL
 112 gssize        g_buffered_input_stream_fill            (GBufferedInputStream  *stream,
 113                                                        gssize                 count,
 114                                                        GCancellable          *cancellable,
 115                                                        GError               **error);
 116 GIO_AVAILABLE_IN_ALL
 117 void          g_buffered_input_stream_fill_async      (GBufferedInputStream  *stream,
 118                                                        gssize                 count,
 119                                                        int                    io_priority,
 120                                                        GCancellable          *cancellable,
 121                                                        GAsyncReadyCallback    callback,
 122                                                        gpointer               user_data);
 123 GIO_AVAILABLE_IN_ALL
 124 gssize        g_buffered_input_stream_fill_finish     (GBufferedInputStream  *stream,
 125                                                        GAsyncResult          *result,
 126                                                        GError               **error);
 127
 128 GIO_AVAILABLE_IN_ALL
 129 int           g_buffered_input_stream_read_byte       (GBufferedInputStream  *stream,
 130                                                        GCancellable          *cancellable,
 131                                                        GError               **error);
 132
 133 G_END_DECLS
 134
 135 #endif /* __G_BUFFERED_INPUT_STREAM_H__ */