gio/ docs/reference/gio Merged gio-standalone into glib.
[platform/upstream/glib.git] / 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 #include <glib-object.h>
27 #include <gio/gfilteroutputstream.h>
28
29 G_BEGIN_DECLS
30
31 #define G_TYPE_BUFFERED_OUTPUT_STREAM         (g_buffered_output_stream_get_type ())
32 #define G_BUFFERED_OUTPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_BUFFERED_OUTPUT_STREAM, GBufferedOutputStream))
33 #define G_BUFFERED_OUTPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_BUFFERED_OUTPUT_STREAM, GBufferedOutputStreamClass))
34 #define G_IS_BUFFERED_OUTPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_BUFFERED_OUTPUT_STREAM))
35 #define G_IS_BUFFERED_OUTPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_BUFFERED_OUTPUT_STREAM))
36 #define G_BUFFERED_OUTPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_BUFFERED_OUTPUT_STREAM, GBufferedOutputStreamClass))
37
38 typedef struct _GBufferedOutputStream         GBufferedOutputStream;
39 typedef struct _GBufferedOutputStreamClass    GBufferedOutputStreamClass;
40 typedef struct _GBufferedOutputStreamPrivate  GBufferedOutputStreamPrivate;
41
42 struct _GBufferedOutputStream
43 {
44   GFilterOutputStream parent;
45
46   /*< protected >*/
47   GBufferedOutputStreamPrivate *priv;
48 };
49
50 struct _GBufferedOutputStreamClass
51 {
52  GOutputStreamClass parent_class;
53
54   /* Padding for future expansion */
55   void (*_g_reserved1) (void);
56   void (*_g_reserved2) (void);
57   void (*_g_reserved3) (void);
58   void (*_g_reserved4) (void);
59   void (*_g_reserved5) (void);
60 };
61
62
63 GType           g_buffered_output_stream_get_type  (void) G_GNUC_CONST;
64 GOutputStream* g_buffered_output_stream_new             (GOutputStream         *base_stream);
65 GOutputStream* g_buffered_output_stream_new_sized       (GOutputStream         *base_stream,
66                                                          guint                  size);
67 gsize          g_buffered_output_stream_get_buffer_size (GBufferedOutputStream *stream);
68 void           g_buffered_output_stream_set_buffer_size (GBufferedOutputStream *stream,
69                                                          gsize                  size);
70 gboolean       g_buffered_output_stream_get_auto_grow   (GBufferedOutputStream *stream);
71 void           g_buffered_output_stream_set_auto_grow   (GBufferedOutputStream *stream,
72                                                          gboolean               auto_grow);
73
74 G_END_DECLS
75
76 #endif /* __G_BUFFERED_OUTPUT_STREAM_H__ */