mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-12-25 15:06:14 +01:00
08990badb6
Move the contents to the struct docs. Helps: #3037
131 lines
5.0 KiB
C
131 lines
5.0 KiB
C
/* GIO - GLib Input, Output and Streaming Library
|
|
*
|
|
* Copyright (C) 2006-2007 Red Hat, Inc.
|
|
*
|
|
* SPDX-License-Identifier: LGPL-2.1-or-later
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General
|
|
* Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
* Author: Christian Kellner <gicmo@gnome.org>
|
|
*/
|
|
|
|
#ifndef __G_BUFFERED_INPUT_STREAM_H__
|
|
#define __G_BUFFERED_INPUT_STREAM_H__
|
|
|
|
#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
|
|
#error "Only <gio/gio.h> can be included directly."
|
|
#endif
|
|
|
|
#include <gio/gfilterinputstream.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
#define G_TYPE_BUFFERED_INPUT_STREAM (g_buffered_input_stream_get_type ())
|
|
#define G_BUFFERED_INPUT_STREAM(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_BUFFERED_INPUT_STREAM, GBufferedInputStream))
|
|
#define G_BUFFERED_INPUT_STREAM_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_BUFFERED_INPUT_STREAM, GBufferedInputStreamClass))
|
|
#define G_IS_BUFFERED_INPUT_STREAM(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_BUFFERED_INPUT_STREAM))
|
|
#define G_IS_BUFFERED_INPUT_STREAM_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_BUFFERED_INPUT_STREAM))
|
|
#define G_BUFFERED_INPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_BUFFERED_INPUT_STREAM, GBufferedInputStreamClass))
|
|
|
|
typedef struct _GBufferedInputStreamClass GBufferedInputStreamClass;
|
|
typedef struct _GBufferedInputStreamPrivate GBufferedInputStreamPrivate;
|
|
|
|
struct _GBufferedInputStream
|
|
{
|
|
GFilterInputStream parent_instance;
|
|
|
|
/*< private >*/
|
|
GBufferedInputStreamPrivate *priv;
|
|
};
|
|
|
|
struct _GBufferedInputStreamClass
|
|
{
|
|
GFilterInputStreamClass parent_class;
|
|
|
|
gssize (* fill) (GBufferedInputStream *stream,
|
|
gssize count,
|
|
GCancellable *cancellable,
|
|
GError **error);
|
|
|
|
/* Async ops: (optional in derived classes) */
|
|
void (* fill_async) (GBufferedInputStream *stream,
|
|
gssize count,
|
|
int io_priority,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gssize (* fill_finish) (GBufferedInputStream *stream,
|
|
GAsyncResult *result,
|
|
GError **error);
|
|
|
|
/*< private >*/
|
|
/* Padding for future expansion */
|
|
void (*_g_reserved1) (void);
|
|
void (*_g_reserved2) (void);
|
|
void (*_g_reserved3) (void);
|
|
void (*_g_reserved4) (void);
|
|
void (*_g_reserved5) (void);
|
|
};
|
|
|
|
|
|
GIO_AVAILABLE_IN_ALL
|
|
GType g_buffered_input_stream_get_type (void) G_GNUC_CONST;
|
|
GIO_AVAILABLE_IN_ALL
|
|
GInputStream* g_buffered_input_stream_new (GInputStream *base_stream);
|
|
GIO_AVAILABLE_IN_ALL
|
|
GInputStream* g_buffered_input_stream_new_sized (GInputStream *base_stream,
|
|
gsize size);
|
|
|
|
GIO_AVAILABLE_IN_ALL
|
|
gsize g_buffered_input_stream_get_buffer_size (GBufferedInputStream *stream);
|
|
GIO_AVAILABLE_IN_ALL
|
|
void g_buffered_input_stream_set_buffer_size (GBufferedInputStream *stream,
|
|
gsize size);
|
|
GIO_AVAILABLE_IN_ALL
|
|
gsize g_buffered_input_stream_get_available (GBufferedInputStream *stream);
|
|
GIO_AVAILABLE_IN_ALL
|
|
gsize g_buffered_input_stream_peek (GBufferedInputStream *stream,
|
|
void *buffer,
|
|
gsize offset,
|
|
gsize count);
|
|
GIO_AVAILABLE_IN_ALL
|
|
const void* g_buffered_input_stream_peek_buffer (GBufferedInputStream *stream,
|
|
gsize *count);
|
|
|
|
GIO_AVAILABLE_IN_ALL
|
|
gssize g_buffered_input_stream_fill (GBufferedInputStream *stream,
|
|
gssize count,
|
|
GCancellable *cancellable,
|
|
GError **error);
|
|
GIO_AVAILABLE_IN_ALL
|
|
void g_buffered_input_stream_fill_async (GBufferedInputStream *stream,
|
|
gssize count,
|
|
int io_priority,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
GIO_AVAILABLE_IN_ALL
|
|
gssize g_buffered_input_stream_fill_finish (GBufferedInputStream *stream,
|
|
GAsyncResult *result,
|
|
GError **error);
|
|
|
|
GIO_AVAILABLE_IN_ALL
|
|
int g_buffered_input_stream_read_byte (GBufferedInputStream *stream,
|
|
GCancellable *cancellable,
|
|
GError **error);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __G_BUFFERED_INPUT_STREAM_H__ */
|