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