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