1 /* GIO - GLib Input, Output and Streaming Library
2 *
3 * Copyright (C) 2006-2007 Red Hat, Inc.
4 *
5 * SPDX-License-Identifier: LGPL-2.1-or-later
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General
18 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
19 *
20 * Author: Christian Kellner <gicmo@gnome.org>
21 */
22
23 #ifndef __G_BUFFERED_INPUT_STREAM_H__
24 #define __G_BUFFERED_INPUT_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/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 typedef struct _GBufferedInputStreamClass GBufferedInputStreamClass;
42 typedef struct _GBufferedInputStreamPrivate GBufferedInputStreamPrivate;
43
44 struct _GBufferedInputStream
45 {
46 GFilterInputStream parent_instance;
47
48 /*< private >*/
49 GBufferedInputStreamPrivate *priv;
50 };
51
52 struct _GBufferedInputStreamClass
53 {
54 GFilterInputStreamClass parent_class;
55
56 gssize (* fill) (GBufferedInputStream *stream,
57 gssize count,
58 GCancellable *cancellable,
59 GError **error);
60
61 /* Async ops: (optional in derived classes) */
62 void (* fill_async) (GBufferedInputStream *stream,
63 gssize count,
64 int io_priority,
65 GCancellable *cancellable,
66 GAsyncReadyCallback callback,
67 gpointer user_data);
68 gssize (* fill_finish) (GBufferedInputStream *stream,
69 GAsyncResult *result,
70 GError **error);
71
72 /*< private >*/
73 /* Padding for future expansion */
74 void (*_g_reserved1) (void);
75 void (*_g_reserved2) (void);
76 void (*_g_reserved3) (void);
77 void (*_g_reserved4) (void);
78 void (*_g_reserved5) (void);
79 };
80
81
82 GIO_AVAILABLE_IN_ALL
83 GType g_buffered_input_stream_get_type (void) G_GNUC_CONST;
84 GIO_AVAILABLE_IN_ALL
85 GInputStream* g_buffered_input_stream_new (GInputStream *base_stream);
86 GIO_AVAILABLE_IN_ALL
87 GInputStream* g_buffered_input_stream_new_sized (GInputStream *base_stream,
88 gsize size);
89
90 GIO_AVAILABLE_IN_ALL
91 gsize g_buffered_input_stream_get_buffer_size (GBufferedInputStream *stream);
92 GIO_AVAILABLE_IN_ALL
93 void g_buffered_input_stream_set_buffer_size (GBufferedInputStream *stream,
94 gsize size);
95 GIO_AVAILABLE_IN_ALL
96 gsize g_buffered_input_stream_get_available (GBufferedInputStream *stream);
97 GIO_AVAILABLE_IN_ALL
98 gsize g_buffered_input_stream_peek (GBufferedInputStream *stream,
99 void *buffer,
100 gsize offset,
101 gsize count);
102 GIO_AVAILABLE_IN_ALL
103 const void* g_buffered_input_stream_peek_buffer (GBufferedInputStream *stream,
104 gsize *count);
105
106 GIO_AVAILABLE_IN_ALL
107 gssize g_buffered_input_stream_fill (GBufferedInputStream *stream,
108 gssize count,
109 GCancellable *cancellable,
110 GError **error);
111 GIO_AVAILABLE_IN_ALL
112 void g_buffered_input_stream_fill_async (GBufferedInputStream *stream,
113 gssize count,
114 int io_priority,
115 GCancellable *cancellable,
116 GAsyncReadyCallback callback,
117 gpointer user_data);
118 GIO_AVAILABLE_IN_ALL
119 gssize g_buffered_input_stream_fill_finish (GBufferedInputStream *stream,
120 GAsyncResult *result,
121 GError **error);
122
123 GIO_AVAILABLE_IN_ALL
124 int g_buffered_input_stream_read_byte (GBufferedInputStream *stream,
125 GCancellable *cancellable,
126 GError **error);
127
128 G_END_DECLS
129
130 #endif /* __G_BUFFERED_INPUT_STREAM_H__ */