gio/gbufferedoutputstream.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 #ifndef __G_BUFFERED_OUTPUT_STREAM_H__
  24 #define __G_BUFFERED_OUTPUT_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/gfilteroutputstream.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define G_TYPE_BUFFERED_OUTPUT_STREAM         (g_buffered_output_stream_get_type ())
  35 #define G_BUFFERED_OUTPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_BUFFERED_OUTPUT_STREAM, GBufferedOutputStream))
  36 #define G_BUFFERED_OUTPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_BUFFERED_OUTPUT_STREAM, GBufferedOutputStreamClass))
  37 #define G_IS_BUFFERED_OUTPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_BUFFERED_OUTPUT_STREAM))
  38 #define G_IS_BUFFERED_OUTPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_BUFFERED_OUTPUT_STREAM))
  39 #define G_BUFFERED_OUTPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_BUFFERED_OUTPUT_STREAM, GBufferedOutputStreamClass))
  40
  41 /**
  42  * GBufferedOutputStream:
  43  *
  44  * An implementation of #GFilterOutputStream with a sized buffer.
  45  **/
  46 typedef struct _GBufferedOutputStreamClass    GBufferedOutputStreamClass;
  47 typedef struct _GBufferedOutputStreamPrivate  GBufferedOutputStreamPrivate;
  48
  49 struct _GBufferedOutputStream
  50 {
  51   GFilterOutputStream parent_instance;
  52
  53   /*< protected >*/
  54   GBufferedOutputStreamPrivate *priv;
  55 };
  56
  57 struct _GBufferedOutputStreamClass
  58 {
  59   GFilterOutputStreamClass parent_class;
  60
  61   /*< private >*/
  62   /* Padding for future expansion */
  63   void (*_g_reserved1) (void);
  64   void (*_g_reserved2) (void);
  65 };
  66
  67
  68 GLIB_AVAILABLE_IN_ALL
  69 GType          g_buffered_output_stream_get_type        (void) G_GNUC_CONST;
  70 GLIB_AVAILABLE_IN_ALL
  71 GOutputStream* g_buffered_output_stream_new             (GOutputStream         *base_stream);
  72 GLIB_AVAILABLE_IN_ALL
  73 GOutputStream* g_buffered_output_stream_new_sized       (GOutputStream         *base_stream,
  74                                                          gsize                  size);
  75 GLIB_AVAILABLE_IN_ALL
  76 gsize          g_buffered_output_stream_get_buffer_size (GBufferedOutputStream *stream);
  77 GLIB_AVAILABLE_IN_ALL
  78 void           g_buffered_output_stream_set_buffer_size (GBufferedOutputStream *stream,
  79                                                          gsize                  size);
  80 GLIB_AVAILABLE_IN_ALL
  81 gboolean       g_buffered_output_stream_get_auto_grow   (GBufferedOutputStream *stream);
  82 GLIB_AVAILABLE_IN_ALL
  83 void           g_buffered_output_stream_set_auto_grow   (GBufferedOutputStream *stream,
  84                                                          gboolean               auto_grow);
  85
  86 G_END_DECLS
  87
  88 #endif /* __G_BUFFERED_OUTPUT_STREAM_H__ */