Home | History | Annotate | Download | only in gio 
      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 (at) 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 <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 GType         g_buffered_input_stream_get_type        (void) G_GNUC_CONST;
     88 GInputStream* g_buffered_input_stream_new             (GInputStream          *base_stream);
     89 GInputStream* g_buffered_input_stream_new_sized       (GInputStream          *base_stream,
     90 						       gsize                  size);
     91 
     92 gsize         g_buffered_input_stream_get_buffer_size (GBufferedInputStream  *stream);
     93 void          g_buffered_input_stream_set_buffer_size (GBufferedInputStream  *stream,
     94 						       gsize                  size);
     95 gsize         g_buffered_input_stream_get_available   (GBufferedInputStream  *stream);
     96 gsize         g_buffered_input_stream_peek            (GBufferedInputStream  *stream,
     97 						       void                  *buffer,
     98 						       gsize                  offset,
     99 						       gsize                  count);
    100 const void*   g_buffered_input_stream_peek_buffer     (GBufferedInputStream  *stream,
    101 						       gsize                 *count);
    102 
    103 gssize        g_buffered_input_stream_fill            (GBufferedInputStream  *stream,
    104 						       gssize                 count,
    105 						       GCancellable          *cancellable,
    106 						       GError               **error);
    107 void          g_buffered_input_stream_fill_async      (GBufferedInputStream  *stream,
    108 						       gssize                 count,
    109 						       int                    io_priority,
    110 						       GCancellable          *cancellable,
    111 						       GAsyncReadyCallback    callback,
    112 						       gpointer               user_data);
    113 gssize        g_buffered_input_stream_fill_finish     (GBufferedInputStream  *stream,
    114 						       GAsyncResult          *result,
    115 						       GError               **error);
    116 
    117 int           g_buffered_input_stream_read_byte       (GBufferedInputStream  *stream,
    118 						       GCancellable          *cancellable,
    119 						       GError               **error);
    120 
    121 G_END_DECLS
    122 
    123 #endif /* __G_BUFFERED_INPUT_STREAM_H__ */
    124