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: Alexander Larsson <alexl (at) redhat.com> 21 */ 22 23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION) 24 #error "Only <gio/gio.h> can be included directly." 25 #endif 26 27 #ifndef __G_INPUT_STREAM_H__ 28 #define __G_INPUT_STREAM_H__ 29 30 #include <gio/giotypes.h> 31 32 G_BEGIN_DECLS 33 34 #define G_TYPE_INPUT_STREAM (g_input_stream_get_type ()) 35 #define G_INPUT_STREAM(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_INPUT_STREAM, GInputStream)) 36 #define G_INPUT_STREAM_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_INPUT_STREAM, GInputStreamClass)) 37 #define G_IS_INPUT_STREAM(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_INPUT_STREAM)) 38 #define G_IS_INPUT_STREAM_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_INPUT_STREAM)) 39 #define G_INPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_INPUT_STREAM, GInputStreamClass)) 40 41 /** 42 * GInputStream: 43 * 44 * Base class for streaming input operations. 45 **/ 46 typedef struct _GInputStreamClass GInputStreamClass; 47 typedef struct _GInputStreamPrivate GInputStreamPrivate; 48 49 struct _GInputStream 50 { 51 GObject parent_instance; 52 53 /*< private >*/ 54 GInputStreamPrivate *priv; 55 }; 56 57 struct _GInputStreamClass 58 { 59 GObjectClass parent_class; 60 61 /* Sync ops: */ 62 63 gssize (* read_fn) (GInputStream *stream, 64 void *buffer, 65 gsize count, 66 GCancellable *cancellable, 67 GError **error); 68 gssize (* skip) (GInputStream *stream, 69 gsize count, 70 GCancellable *cancellable, 71 GError **error); 72 gboolean (* close_fn) (GInputStream *stream, 73 GCancellable *cancellable, 74 GError **error); 75 76 /* Async ops: (optional in derived classes) */ 77 void (* read_async) (GInputStream *stream, 78 void *buffer, 79 gsize count, 80 int io_priority, 81 GCancellable *cancellable, 82 GAsyncReadyCallback callback, 83 gpointer user_data); 84 gssize (* read_finish) (GInputStream *stream, 85 GAsyncResult *result, 86 GError **error); 87 void (* skip_async) (GInputStream *stream, 88 gsize count, 89 int io_priority, 90 GCancellable *cancellable, 91 GAsyncReadyCallback callback, 92 gpointer user_data); 93 gssize (* skip_finish) (GInputStream *stream, 94 GAsyncResult *result, 95 GError **error); 96 void (* close_async) (GInputStream *stream, 97 int io_priority, 98 GCancellable *cancellable, 99 GAsyncReadyCallback callback, 100 gpointer user_data); 101 gboolean (* close_finish) (GInputStream *stream, 102 GAsyncResult *result, 103 GError **error); 104 105 /*< private >*/ 106 /* Padding for future expansion */ 107 void (*_g_reserved1) (void); 108 void (*_g_reserved2) (void); 109 void (*_g_reserved3) (void); 110 void (*_g_reserved4) (void); 111 void (*_g_reserved5) (void); 112 }; 113 114 GType g_input_stream_get_type (void) G_GNUC_CONST; 115 116 gssize g_input_stream_read (GInputStream *stream, 117 void *buffer, 118 gsize count, 119 GCancellable *cancellable, 120 GError **error); 121 gboolean g_input_stream_read_all (GInputStream *stream, 122 void *buffer, 123 gsize count, 124 gsize *bytes_read, 125 GCancellable *cancellable, 126 GError **error); 127 gssize g_input_stream_skip (GInputStream *stream, 128 gsize count, 129 GCancellable *cancellable, 130 GError **error); 131 gboolean g_input_stream_close (GInputStream *stream, 132 GCancellable *cancellable, 133 GError **error); 134 void g_input_stream_read_async (GInputStream *stream, 135 void *buffer, 136 gsize count, 137 int io_priority, 138 GCancellable *cancellable, 139 GAsyncReadyCallback callback, 140 gpointer user_data); 141 gssize g_input_stream_read_finish (GInputStream *stream, 142 GAsyncResult *result, 143 GError **error); 144 void g_input_stream_skip_async (GInputStream *stream, 145 gsize count, 146 int io_priority, 147 GCancellable *cancellable, 148 GAsyncReadyCallback callback, 149 gpointer user_data); 150 gssize g_input_stream_skip_finish (GInputStream *stream, 151 GAsyncResult *result, 152 GError **error); 153 void g_input_stream_close_async (GInputStream *stream, 154 int io_priority, 155 GCancellable *cancellable, 156 GAsyncReadyCallback callback, 157 gpointer user_data); 158 gboolean g_input_stream_close_finish (GInputStream *stream, 159 GAsyncResult *result, 160 GError **error); 161 162 /* For implementations: */ 163 164 gboolean g_input_stream_is_closed (GInputStream *stream); 165 gboolean g_input_stream_has_pending (GInputStream *stream); 166 gboolean g_input_stream_set_pending (GInputStream *stream, 167 GError **error); 168 void g_input_stream_clear_pending (GInputStream *stream); 169 170 G_END_DECLS 171 172 #endif /* __G_INPUT_STREAM_H__ */ 173
