1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
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.
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.
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/>.
18 * Author: Alexander Larsson <alexl@redhat.com>
25 #include "ginputstream.h"
26 #include "gioprivate.h"
27 #include "gseekable.h"
28 #include "gcancellable.h"
29 #include "gasyncresult.h"
31 #include "gpollableinputstream.h"
34 * SECTION:ginputstream
35 * @short_description: Base class for implementing streaming input
38 * #GInputStream has functions to read from a stream (g_input_stream_read()),
39 * to close a stream (g_input_stream_close()) and to skip some content
40 * (g_input_stream_skip()).
42 * To copy the content of an input stream to an output stream without
43 * manually handling the reads and writes, use g_output_stream_splice().
45 * All of these functions have async variants too.
48 struct _GInputStreamPrivate {
51 GAsyncReadyCallback outstanding_callback;
54 G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (GInputStream, g_input_stream, G_TYPE_OBJECT)
56 static gssize g_input_stream_real_skip (GInputStream *stream,
58 GCancellable *cancellable,
60 static void g_input_stream_real_read_async (GInputStream *stream,
64 GCancellable *cancellable,
65 GAsyncReadyCallback callback,
67 static gssize g_input_stream_real_read_finish (GInputStream *stream,
70 static void g_input_stream_real_skip_async (GInputStream *stream,
73 GCancellable *cancellable,
74 GAsyncReadyCallback callback,
76 static gssize g_input_stream_real_skip_finish (GInputStream *stream,
79 static void g_input_stream_real_close_async (GInputStream *stream,
81 GCancellable *cancellable,
82 GAsyncReadyCallback callback,
84 static gboolean g_input_stream_real_close_finish (GInputStream *stream,
89 g_input_stream_dispose (GObject *object)
93 stream = G_INPUT_STREAM (object);
95 if (!stream->priv->closed)
96 g_input_stream_close (stream, NULL, NULL);
98 G_OBJECT_CLASS (g_input_stream_parent_class)->dispose (object);
103 g_input_stream_class_init (GInputStreamClass *klass)
105 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
107 gobject_class->dispose = g_input_stream_dispose;
109 klass->skip = g_input_stream_real_skip;
110 klass->read_async = g_input_stream_real_read_async;
111 klass->read_finish = g_input_stream_real_read_finish;
112 klass->skip_async = g_input_stream_real_skip_async;
113 klass->skip_finish = g_input_stream_real_skip_finish;
114 klass->close_async = g_input_stream_real_close_async;
115 klass->close_finish = g_input_stream_real_close_finish;
119 g_input_stream_init (GInputStream *stream)
121 stream->priv = g_input_stream_get_instance_private (stream);
125 * g_input_stream_read:
126 * @stream: a #GInputStream.
127 * @buffer: (array length=count) (element-type guint8): a buffer to
128 * read data into (which should be at least count bytes long).
129 * @count: the number of bytes that will be read from the stream
130 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
131 * @error: location to store the error occurring, or %NULL to ignore
133 * Tries to read @count bytes from the stream into the buffer starting at
134 * @buffer. Will block during this read.
136 * If count is zero returns zero and does nothing. A value of @count
137 * larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
139 * On success, the number of bytes read into the buffer is returned.
140 * It is not an error if this is not the same as the requested size, as it
141 * can happen e.g. near the end of a file. Zero is returned on end of file
142 * (or if @count is zero), but never otherwise.
144 * If @cancellable is not %NULL, then the operation can be cancelled by
145 * triggering the cancellable object from another thread. If the operation
146 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
147 * operation was partially finished when the operation was cancelled the
148 * partial result will be returned, without an error.
150 * On error -1 is returned and @error is set accordingly.
152 * Returns: Number of bytes read, or -1 on error, or 0 on end of file.
155 g_input_stream_read (GInputStream *stream,
158 GCancellable *cancellable,
161 GInputStreamClass *class;
164 g_return_val_if_fail (G_IS_INPUT_STREAM (stream), -1);
165 g_return_val_if_fail (buffer != NULL, 0);
170 if (((gssize) count) < 0)
172 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
173 _("Too large count value passed to %s"), G_STRFUNC);
177 class = G_INPUT_STREAM_GET_CLASS (stream);
179 if (class->read_fn == NULL)
181 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
182 _("Input stream doesn't implement read"));
186 if (!g_input_stream_set_pending (stream, error))
190 g_cancellable_push_current (cancellable);
192 res = class->read_fn (stream, buffer, count, cancellable, error);
195 g_cancellable_pop_current (cancellable);
197 g_input_stream_clear_pending (stream);
203 * g_input_stream_read_all:
204 * @stream: a #GInputStream.
205 * @buffer: (array length=count) (element-type guint8): a buffer to
206 * read data into (which should be at least count bytes long).
207 * @count: the number of bytes that will be read from the stream
208 * @bytes_read: (out): location to store the number of bytes that was read from the stream
209 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
210 * @error: location to store the error occurring, or %NULL to ignore
212 * Tries to read @count bytes from the stream into the buffer starting at
213 * @buffer. Will block during this read.
215 * This function is similar to g_input_stream_read(), except it tries to
216 * read as many bytes as requested, only stopping on an error or end of stream.
218 * On a successful read of @count bytes, or if we reached the end of the
219 * stream, %TRUE is returned, and @bytes_read is set to the number of bytes
222 * If there is an error during the operation %FALSE is returned and @error
223 * is set to indicate the error status, @bytes_read is updated to contain
224 * the number of bytes read into @buffer before the error occurred.
226 * Returns: %TRUE on success, %FALSE if there was an error
229 g_input_stream_read_all (GInputStream *stream,
233 GCancellable *cancellable,
239 g_return_val_if_fail (G_IS_INPUT_STREAM (stream), FALSE);
240 g_return_val_if_fail (buffer != NULL, FALSE);
243 while (_bytes_read < count)
245 res = g_input_stream_read (stream, (char *)buffer + _bytes_read, count - _bytes_read,
250 *bytes_read = _bytes_read;
261 *bytes_read = _bytes_read;
266 * g_input_stream_read_bytes:
267 * @stream: a #GInputStream.
268 * @count: maximum number of bytes that will be read from the stream. Common
269 * values include 4096 and 8192.
270 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
271 * @error: location to store the error occurring, or %NULL to ignore
273 * Like g_input_stream_read(), this tries to read @count bytes from
274 * the stream in a blocking fashion. However, rather than reading into
275 * a user-supplied buffer, this will create a new #GBytes containing
276 * the data that was read. This may be easier to use from language
279 * If count is zero, returns a zero-length #GBytes and does nothing. A
280 * value of @count larger than %G_MAXSSIZE will cause a
281 * %G_IO_ERROR_INVALID_ARGUMENT error.
283 * On success, a new #GBytes is returned. It is not an error if the
284 * size of this object is not the same as the requested size, as it
285 * can happen e.g. near the end of a file. A zero-length #GBytes is
286 * returned on end of file (or if @count is zero), but never
289 * If @cancellable is not %NULL, then the operation can be cancelled by
290 * triggering the cancellable object from another thread. If the operation
291 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
292 * operation was partially finished when the operation was cancelled the
293 * partial result will be returned, without an error.
295 * On error %NULL is returned and @error is set accordingly.
297 * Returns: a new #GBytes, or %NULL on error
300 g_input_stream_read_bytes (GInputStream *stream,
302 GCancellable *cancellable,
308 buf = g_malloc (count);
309 nread = g_input_stream_read (stream, buf, count, cancellable, error);
318 return g_bytes_new_static ("", 0);
321 return g_bytes_new_take (buf, nread);
325 * g_input_stream_skip:
326 * @stream: a #GInputStream.
327 * @count: the number of bytes that will be skipped from the stream
328 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
329 * @error: location to store the error occurring, or %NULL to ignore
331 * Tries to skip @count bytes from the stream. Will block during the operation.
333 * This is identical to g_input_stream_read(), from a behaviour standpoint,
334 * but the bytes that are skipped are not returned to the user. Some
335 * streams have an implementation that is more efficient than reading the data.
337 * This function is optional for inherited classes, as the default implementation
338 * emulates it using read.
340 * If @cancellable is not %NULL, then the operation can be cancelled by
341 * triggering the cancellable object from another thread. If the operation
342 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
343 * operation was partially finished when the operation was cancelled the
344 * partial result will be returned, without an error.
346 * Returns: Number of bytes skipped, or -1 on error
349 g_input_stream_skip (GInputStream *stream,
351 GCancellable *cancellable,
354 GInputStreamClass *class;
357 g_return_val_if_fail (G_IS_INPUT_STREAM (stream), -1);
362 if (((gssize) count) < 0)
364 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
365 _("Too large count value passed to %s"), G_STRFUNC);
369 class = G_INPUT_STREAM_GET_CLASS (stream);
371 if (!g_input_stream_set_pending (stream, error))
375 g_cancellable_push_current (cancellable);
377 res = class->skip (stream, count, cancellable, error);
380 g_cancellable_pop_current (cancellable);
382 g_input_stream_clear_pending (stream);
388 g_input_stream_real_skip (GInputStream *stream,
390 GCancellable *cancellable,
393 GInputStreamClass *class;
394 gssize ret, read_bytes;
398 if (G_IS_SEEKABLE (stream) && g_seekable_can_seek (G_SEEKABLE (stream)))
400 if (g_seekable_seek (G_SEEKABLE (stream),
408 /* If not seekable, or seek failed, fall back to reading data: */
410 class = G_INPUT_STREAM_GET_CLASS (stream);
417 ret = class->read_fn (stream, buffer, MIN (sizeof (buffer), count),
418 cancellable, &my_error);
421 if (read_bytes > 0 &&
422 my_error->domain == G_IO_ERROR &&
423 my_error->code == G_IO_ERROR_CANCELLED)
425 g_error_free (my_error);
429 g_propagate_error (error, my_error);
436 if (ret == 0 || count == 0)
442 * g_input_stream_close:
443 * @stream: A #GInputStream.
444 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
445 * @error: location to store the error occurring, or %NULL to ignore
447 * Closes the stream, releasing resources related to it.
449 * Once the stream is closed, all other operations will return %G_IO_ERROR_CLOSED.
450 * Closing a stream multiple times will not return an error.
452 * Streams will be automatically closed when the last reference
453 * is dropped, but you might want to call this function to make sure
454 * resources are released as early as possible.
456 * Some streams might keep the backing store of the stream (e.g. a file descriptor)
457 * open after the stream is closed. See the documentation for the individual
458 * stream for details.
460 * On failure the first error that happened will be reported, but the close
461 * operation will finish as much as possible. A stream that failed to
462 * close will still return %G_IO_ERROR_CLOSED for all operations. Still, it
463 * is important to check and report the error to the user.
465 * If @cancellable is not %NULL, then the operation can be cancelled by
466 * triggering the cancellable object from another thread. If the operation
467 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
468 * Cancelling a close will still leave the stream closed, but some streams
469 * can use a faster close that doesn't block to e.g. check errors.
471 * Returns: %TRUE on success, %FALSE on failure
474 g_input_stream_close (GInputStream *stream,
475 GCancellable *cancellable,
478 GInputStreamClass *class;
481 g_return_val_if_fail (G_IS_INPUT_STREAM (stream), FALSE);
483 class = G_INPUT_STREAM_GET_CLASS (stream);
485 if (stream->priv->closed)
490 if (!g_input_stream_set_pending (stream, error))
494 g_cancellable_push_current (cancellable);
497 res = class->close_fn (stream, cancellable, error);
500 g_cancellable_pop_current (cancellable);
502 g_input_stream_clear_pending (stream);
504 stream->priv->closed = TRUE;
510 async_ready_callback_wrapper (GObject *source_object,
514 GInputStream *stream = G_INPUT_STREAM (source_object);
516 g_input_stream_clear_pending (stream);
517 if (stream->priv->outstanding_callback)
518 (*stream->priv->outstanding_callback) (source_object, res, user_data);
519 g_object_unref (stream);
523 async_ready_close_callback_wrapper (GObject *source_object,
527 GInputStream *stream = G_INPUT_STREAM (source_object);
529 g_input_stream_clear_pending (stream);
530 stream->priv->closed = TRUE;
531 if (stream->priv->outstanding_callback)
532 (*stream->priv->outstanding_callback) (source_object, res, user_data);
533 g_object_unref (stream);
537 * g_input_stream_read_async:
538 * @stream: A #GInputStream.
539 * @buffer: (array length=count) (element-type guint8): a buffer to
540 * read data into (which should be at least count bytes long).
541 * @count: the number of bytes that will be read from the stream
542 * @io_priority: the [I/O priority][io-priority]
544 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
545 * @callback: (scope async): callback to call when the request is satisfied
546 * @user_data: (closure): the data to pass to callback function
548 * Request an asynchronous read of @count bytes from the stream into the buffer
549 * starting at @buffer. When the operation is finished @callback will be called.
550 * You can then call g_input_stream_read_finish() to get the result of the
553 * During an async request no other sync and async calls are allowed on @stream, and will
554 * result in %G_IO_ERROR_PENDING errors.
556 * A value of @count larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
558 * On success, the number of bytes read into the buffer will be passed to the
559 * callback. It is not an error if this is not the same as the requested size, as it
560 * can happen e.g. near the end of a file, but generally we try to read
561 * as many bytes as requested. Zero is returned on end of file
562 * (or if @count is zero), but never otherwise.
564 * Any outstanding i/o request with higher priority (lower numerical value) will
565 * be executed before an outstanding request with lower priority. Default
566 * priority is %G_PRIORITY_DEFAULT.
568 * The asyncronous methods have a default fallback that uses threads to implement
569 * asynchronicity, so they are optional for inheriting classes. However, if you
570 * override one you must override all.
573 g_input_stream_read_async (GInputStream *stream,
577 GCancellable *cancellable,
578 GAsyncReadyCallback callback,
581 GInputStreamClass *class;
582 GError *error = NULL;
584 g_return_if_fail (G_IS_INPUT_STREAM (stream));
585 g_return_if_fail (buffer != NULL);
591 task = g_task_new (stream, cancellable, callback, user_data);
592 g_task_set_source_tag (task, g_input_stream_read_async);
593 g_task_return_int (task, 0);
594 g_object_unref (task);
598 if (((gssize) count) < 0)
600 g_task_report_new_error (stream, callback, user_data,
601 g_input_stream_read_async,
602 G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
603 _("Too large count value passed to %s"),
608 if (!g_input_stream_set_pending (stream, &error))
610 g_task_report_error (stream, callback, user_data,
611 g_input_stream_read_async,
616 class = G_INPUT_STREAM_GET_CLASS (stream);
617 stream->priv->outstanding_callback = callback;
618 g_object_ref (stream);
619 class->read_async (stream, buffer, count, io_priority, cancellable,
620 async_ready_callback_wrapper, user_data);
624 * g_input_stream_read_finish:
625 * @stream: a #GInputStream.
626 * @result: a #GAsyncResult.
627 * @error: a #GError location to store the error occurring, or %NULL to
630 * Finishes an asynchronous stream read operation.
632 * Returns: number of bytes read in, or -1 on error, or 0 on end of file.
635 g_input_stream_read_finish (GInputStream *stream,
636 GAsyncResult *result,
639 GInputStreamClass *class;
641 g_return_val_if_fail (G_IS_INPUT_STREAM (stream), -1);
642 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), -1);
644 if (g_async_result_legacy_propagate_error (result, error))
646 else if (g_async_result_is_tagged (result, g_input_stream_read_async))
647 return g_task_propagate_int (G_TASK (result), error);
649 class = G_INPUT_STREAM_GET_CLASS (stream);
650 return class->read_finish (stream, result, error);
654 read_bytes_callback (GObject *stream,
655 GAsyncResult *result,
658 GTask *task = user_data;
659 guchar *buf = g_task_get_task_data (task);
660 GError *error = NULL;
662 GBytes *bytes = NULL;
664 nread = g_input_stream_read_finish (G_INPUT_STREAM (stream),
669 g_task_return_error (task, error);
674 bytes = g_bytes_new_static ("", 0);
677 bytes = g_bytes_new_take (buf, nread);
680 g_task_return_pointer (task, bytes, (GDestroyNotify)g_bytes_unref);
682 g_object_unref (task);
686 * g_input_stream_read_bytes_async:
687 * @stream: A #GInputStream.
688 * @count: the number of bytes that will be read from the stream
689 * @io_priority: the [I/O priority][io-priority] of the request
690 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
691 * @callback: (scope async): callback to call when the request is satisfied
692 * @user_data: (closure): the data to pass to callback function
694 * Request an asynchronous read of @count bytes from the stream into a
695 * new #GBytes. When the operation is finished @callback will be
696 * called. You can then call g_input_stream_read_bytes_finish() to get the
697 * result of the operation.
699 * During an async request no other sync and async calls are allowed
700 * on @stream, and will result in %G_IO_ERROR_PENDING errors.
702 * A value of @count larger than %G_MAXSSIZE will cause a
703 * %G_IO_ERROR_INVALID_ARGUMENT error.
705 * On success, the new #GBytes will be passed to the callback. It is
706 * not an error if this is smaller than the requested size, as it can
707 * happen e.g. near the end of a file, but generally we try to read as
708 * many bytes as requested. Zero is returned on end of file (or if
709 * @count is zero), but never otherwise.
711 * Any outstanding I/O request with higher priority (lower numerical
712 * value) will be executed before an outstanding request with lower
713 * priority. Default priority is %G_PRIORITY_DEFAULT.
716 g_input_stream_read_bytes_async (GInputStream *stream,
719 GCancellable *cancellable,
720 GAsyncReadyCallback callback,
726 task = g_task_new (stream, cancellable, callback, user_data);
727 buf = g_malloc (count);
728 g_task_set_task_data (task, buf, NULL);
730 g_input_stream_read_async (stream, buf, count,
731 io_priority, cancellable,
732 read_bytes_callback, task);
736 * g_input_stream_read_bytes_finish:
737 * @stream: a #GInputStream.
738 * @result: a #GAsyncResult.
739 * @error: a #GError location to store the error occurring, or %NULL to
742 * Finishes an asynchronous stream read-into-#GBytes operation.
744 * Returns: the newly-allocated #GBytes, or %NULL on error
747 g_input_stream_read_bytes_finish (GInputStream *stream,
748 GAsyncResult *result,
751 g_return_val_if_fail (G_IS_INPUT_STREAM (stream), NULL);
752 g_return_val_if_fail (g_task_is_valid (result, stream), NULL);
754 return g_task_propagate_pointer (G_TASK (result), error);
758 * g_input_stream_skip_async:
759 * @stream: A #GInputStream.
760 * @count: the number of bytes that will be skipped from the stream
761 * @io_priority: the [I/O priority][io-priority] of the request
762 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
763 * @callback: (scope async): callback to call when the request is satisfied
764 * @user_data: (closure): the data to pass to callback function
766 * Request an asynchronous skip of @count bytes from the stream.
767 * When the operation is finished @callback will be called.
768 * You can then call g_input_stream_skip_finish() to get the result
771 * During an async request no other sync and async calls are allowed,
772 * and will result in %G_IO_ERROR_PENDING errors.
774 * A value of @count larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
776 * On success, the number of bytes skipped will be passed to the callback.
777 * It is not an error if this is not the same as the requested size, as it
778 * can happen e.g. near the end of a file, but generally we try to skip
779 * as many bytes as requested. Zero is returned on end of file
780 * (or if @count is zero), but never otherwise.
782 * Any outstanding i/o request with higher priority (lower numerical value)
783 * will be executed before an outstanding request with lower priority.
784 * Default priority is %G_PRIORITY_DEFAULT.
786 * The asynchronous methods have a default fallback that uses threads to
787 * implement asynchronicity, so they are optional for inheriting classes.
788 * However, if you override one, you must override all.
791 g_input_stream_skip_async (GInputStream *stream,
794 GCancellable *cancellable,
795 GAsyncReadyCallback callback,
798 GInputStreamClass *class;
799 GError *error = NULL;
801 g_return_if_fail (G_IS_INPUT_STREAM (stream));
807 task = g_task_new (stream, cancellable, callback, user_data);
808 g_task_set_source_tag (task, g_input_stream_skip_async);
809 g_task_return_int (task, 0);
810 g_object_unref (task);
814 if (((gssize) count) < 0)
816 g_task_report_new_error (stream, callback, user_data,
817 g_input_stream_skip_async,
818 G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
819 _("Too large count value passed to %s"),
824 if (!g_input_stream_set_pending (stream, &error))
826 g_task_report_error (stream, callback, user_data,
827 g_input_stream_skip_async,
832 class = G_INPUT_STREAM_GET_CLASS (stream);
833 stream->priv->outstanding_callback = callback;
834 g_object_ref (stream);
835 class->skip_async (stream, count, io_priority, cancellable,
836 async_ready_callback_wrapper, user_data);
840 * g_input_stream_skip_finish:
841 * @stream: a #GInputStream.
842 * @result: a #GAsyncResult.
843 * @error: a #GError location to store the error occurring, or %NULL to
846 * Finishes a stream skip operation.
848 * Returns: the size of the bytes skipped, or %-1 on error.
851 g_input_stream_skip_finish (GInputStream *stream,
852 GAsyncResult *result,
855 GInputStreamClass *class;
857 g_return_val_if_fail (G_IS_INPUT_STREAM (stream), -1);
858 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), -1);
860 if (g_async_result_legacy_propagate_error (result, error))
862 else if (g_async_result_is_tagged (result, g_input_stream_skip_async))
863 return g_task_propagate_int (G_TASK (result), error);
865 class = G_INPUT_STREAM_GET_CLASS (stream);
866 return class->skip_finish (stream, result, error);
870 * g_input_stream_close_async:
871 * @stream: A #GInputStream.
872 * @io_priority: the [I/O priority][io-priority] of the request
873 * @cancellable: (allow-none): optional cancellable object
874 * @callback: (scope async): callback to call when the request is satisfied
875 * @user_data: (closure): the data to pass to callback function
877 * Requests an asynchronous closes of the stream, releasing resources related to it.
878 * When the operation is finished @callback will be called.
879 * You can then call g_input_stream_close_finish() to get the result of the
882 * For behaviour details see g_input_stream_close().
884 * The asyncronous methods have a default fallback that uses threads to implement
885 * asynchronicity, so they are optional for inheriting classes. However, if you
886 * override one you must override all.
889 g_input_stream_close_async (GInputStream *stream,
891 GCancellable *cancellable,
892 GAsyncReadyCallback callback,
895 GInputStreamClass *class;
896 GError *error = NULL;
898 g_return_if_fail (G_IS_INPUT_STREAM (stream));
900 if (stream->priv->closed)
904 task = g_task_new (stream, cancellable, callback, user_data);
905 g_task_set_source_tag (task, g_input_stream_close_async);
906 g_task_return_boolean (task, TRUE);
907 g_object_unref (task);
911 if (!g_input_stream_set_pending (stream, &error))
913 g_task_report_error (stream, callback, user_data,
914 g_input_stream_close_async,
919 class = G_INPUT_STREAM_GET_CLASS (stream);
920 stream->priv->outstanding_callback = callback;
921 g_object_ref (stream);
922 class->close_async (stream, io_priority, cancellable,
923 async_ready_close_callback_wrapper, user_data);
927 * g_input_stream_close_finish:
928 * @stream: a #GInputStream.
929 * @result: a #GAsyncResult.
930 * @error: a #GError location to store the error occurring, or %NULL to
933 * Finishes closing a stream asynchronously, started from g_input_stream_close_async().
935 * Returns: %TRUE if the stream was closed successfully.
938 g_input_stream_close_finish (GInputStream *stream,
939 GAsyncResult *result,
942 GInputStreamClass *class;
944 g_return_val_if_fail (G_IS_INPUT_STREAM (stream), FALSE);
945 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
947 if (g_async_result_legacy_propagate_error (result, error))
949 else if (g_async_result_is_tagged (result, g_input_stream_close_async))
950 return g_task_propagate_boolean (G_TASK (result), error);
952 class = G_INPUT_STREAM_GET_CLASS (stream);
953 return class->close_finish (stream, result, error);
957 * g_input_stream_is_closed:
958 * @stream: input stream.
960 * Checks if an input stream is closed.
962 * Returns: %TRUE if the stream is closed.
965 g_input_stream_is_closed (GInputStream *stream)
967 g_return_val_if_fail (G_IS_INPUT_STREAM (stream), TRUE);
969 return stream->priv->closed;
973 * g_input_stream_has_pending:
974 * @stream: input stream.
976 * Checks if an input stream has pending actions.
978 * Returns: %TRUE if @stream has pending actions.
981 g_input_stream_has_pending (GInputStream *stream)
983 g_return_val_if_fail (G_IS_INPUT_STREAM (stream), TRUE);
985 return stream->priv->pending;
989 * g_input_stream_set_pending:
990 * @stream: input stream
991 * @error: a #GError location to store the error occurring, or %NULL to
994 * Sets @stream to have actions pending. If the pending flag is
995 * already set or @stream is closed, it will return %FALSE and set
998 * Returns: %TRUE if pending was previously unset and is now set.
1001 g_input_stream_set_pending (GInputStream *stream, GError **error)
1003 g_return_val_if_fail (G_IS_INPUT_STREAM (stream), FALSE);
1005 if (stream->priv->closed)
1007 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_CLOSED,
1008 _("Stream is already closed"));
1012 if (stream->priv->pending)
1014 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_PENDING,
1015 /* Translators: This is an error you get if there is already an
1016 * operation running against this stream when you try to start
1018 _("Stream has outstanding operation"));
1022 stream->priv->pending = TRUE;
1027 * g_input_stream_clear_pending:
1028 * @stream: input stream
1030 * Clears the pending flag on @stream.
1033 g_input_stream_clear_pending (GInputStream *stream)
1035 g_return_if_fail (G_IS_INPUT_STREAM (stream));
1037 stream->priv->pending = FALSE;
1041 * g_input_stream_async_read_is_via_threads:
1042 * @stream: input stream
1044 * Checks if an input stream's read_async function uses threads.
1046 * Returns: %TRUE if @stream's read_async function uses threads.
1049 g_input_stream_async_read_is_via_threads (GInputStream *stream)
1051 GInputStreamClass *class;
1053 g_return_val_if_fail (G_IS_INPUT_STREAM (stream), FALSE);
1055 class = G_INPUT_STREAM_GET_CLASS (stream);
1057 return (class->read_async == g_input_stream_real_read_async &&
1058 !(G_IS_POLLABLE_INPUT_STREAM (stream) &&
1059 g_pollable_input_stream_can_poll (G_POLLABLE_INPUT_STREAM (stream))));
1062 /********************************************
1063 * Default implementation of async ops *
1064 ********************************************/
1072 free_read_data (ReadData *op)
1074 g_slice_free (ReadData, op);
1078 read_async_thread (GTask *task,
1079 gpointer source_object,
1081 GCancellable *cancellable)
1083 GInputStream *stream = source_object;
1084 ReadData *op = task_data;
1085 GInputStreamClass *class;
1086 GError *error = NULL;
1089 class = G_INPUT_STREAM_GET_CLASS (stream);
1091 nread = class->read_fn (stream,
1092 op->buffer, op->count,
1093 g_task_get_cancellable (task),
1096 g_task_return_error (task, error);
1098 g_task_return_int (task, nread);
1101 static void read_async_pollable (GPollableInputStream *stream,
1105 read_async_pollable_ready (GPollableInputStream *stream,
1108 GTask *task = user_data;
1110 read_async_pollable (stream, task);
1115 read_async_pollable (GPollableInputStream *stream,
1118 ReadData *op = g_task_get_task_data (task);
1119 GError *error = NULL;
1122 if (g_task_return_error_if_cancelled (task))
1125 nread = G_POLLABLE_INPUT_STREAM_GET_INTERFACE (stream)->
1126 read_nonblocking (stream, op->buffer, op->count, &error);
1128 if (g_error_matches (error, G_IO_ERROR, G_IO_ERROR_WOULD_BLOCK))
1132 g_error_free (error);
1134 source = g_pollable_input_stream_create_source (stream,
1135 g_task_get_cancellable (task));
1136 g_task_attach_source (task, source,
1137 (GSourceFunc) read_async_pollable_ready);
1138 g_source_unref (source);
1143 g_task_return_error (task, error);
1145 g_task_return_int (task, nread);
1146 /* g_input_stream_real_read_async() unrefs task */
1151 g_input_stream_real_read_async (GInputStream *stream,
1155 GCancellable *cancellable,
1156 GAsyncReadyCallback callback,
1162 op = g_slice_new0 (ReadData);
1163 task = g_task_new (stream, cancellable, callback, user_data);
1164 g_task_set_task_data (task, op, (GDestroyNotify) free_read_data);
1165 g_task_set_priority (task, io_priority);
1166 op->buffer = buffer;
1169 if (!g_input_stream_async_read_is_via_threads (stream))
1170 read_async_pollable (G_POLLABLE_INPUT_STREAM (stream), task);
1172 g_task_run_in_thread (task, read_async_thread);
1173 g_object_unref (task);
1177 g_input_stream_real_read_finish (GInputStream *stream,
1178 GAsyncResult *result,
1181 g_return_val_if_fail (g_task_is_valid (result, stream), -1);
1183 return g_task_propagate_int (G_TASK (result), error);
1188 skip_async_thread (GTask *task,
1189 gpointer source_object,
1191 GCancellable *cancellable)
1193 GInputStream *stream = source_object;
1194 gsize count = GPOINTER_TO_SIZE (task_data);
1195 GInputStreamClass *class;
1196 GError *error = NULL;
1199 class = G_INPUT_STREAM_GET_CLASS (stream);
1200 ret = class->skip (stream, count,
1201 g_task_get_cancellable (task),
1204 g_task_return_error (task, error);
1206 g_task_return_int (task, ret);
1212 gsize count_skipped;
1213 } SkipFallbackAsyncData;
1216 skip_callback_wrapper (GObject *source_object,
1220 GInputStreamClass *class;
1221 GTask *task = user_data;
1222 SkipFallbackAsyncData *data = g_task_get_task_data (task);
1223 GError *error = NULL;
1226 ret = g_input_stream_read_finish (G_INPUT_STREAM (source_object), res, &error);
1231 data->count_skipped += ret;
1233 if (data->count > 0)
1235 class = G_INPUT_STREAM_GET_CLASS (source_object);
1236 class->read_async (G_INPUT_STREAM (source_object),
1237 data->buffer, MIN (8192, data->count),
1238 g_task_get_priority (task),
1239 g_task_get_cancellable (task),
1240 skip_callback_wrapper, task);
1246 g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED) &&
1247 data->count_skipped)
1249 /* No error, return partial read */
1250 g_clear_error (&error);
1254 g_task_return_error (task, error);
1256 g_task_return_int (task, data->count_skipped);
1257 g_object_unref (task);
1261 g_input_stream_real_skip_async (GInputStream *stream,
1264 GCancellable *cancellable,
1265 GAsyncReadyCallback callback,
1268 GInputStreamClass *class;
1269 SkipFallbackAsyncData *data;
1272 class = G_INPUT_STREAM_GET_CLASS (stream);
1274 task = g_task_new (stream, cancellable, callback, user_data);
1275 g_task_set_priority (task, io_priority);
1277 if (g_input_stream_async_read_is_via_threads (stream))
1279 /* Read is thread-using async fallback.
1280 * Make skip use threads too, so that we can use a possible sync skip
1281 * implementation. */
1282 g_task_set_task_data (task, GSIZE_TO_POINTER (count), NULL);
1284 g_task_run_in_thread (task, skip_async_thread);
1285 g_object_unref (task);
1289 /* TODO: Skip fallback uses too much memory, should do multiple read calls */
1291 /* There is a custom async read function, lets use that. */
1292 data = g_new (SkipFallbackAsyncData, 1);
1293 data->count = count;
1294 data->count_skipped = 0;
1295 g_task_set_task_data (task, data, g_free);
1296 g_task_set_check_cancellable (task, FALSE);
1297 class->read_async (stream, data->buffer, MIN (8192, count), io_priority, cancellable,
1298 skip_callback_wrapper, task);
1304 g_input_stream_real_skip_finish (GInputStream *stream,
1305 GAsyncResult *result,
1308 g_return_val_if_fail (g_task_is_valid (result, stream), -1);
1310 return g_task_propagate_int (G_TASK (result), error);
1314 close_async_thread (GTask *task,
1315 gpointer source_object,
1317 GCancellable *cancellable)
1319 GInputStream *stream = source_object;
1320 GInputStreamClass *class;
1321 GError *error = NULL;
1324 class = G_INPUT_STREAM_GET_CLASS (stream);
1325 if (class->close_fn)
1327 result = class->close_fn (stream,
1328 g_task_get_cancellable (task),
1332 g_task_return_error (task, error);
1337 g_task_return_boolean (task, TRUE);
1341 g_input_stream_real_close_async (GInputStream *stream,
1343 GCancellable *cancellable,
1344 GAsyncReadyCallback callback,
1349 task = g_task_new (stream, cancellable, callback, user_data);
1350 g_task_set_check_cancellable (task, FALSE);
1351 g_task_set_priority (task, io_priority);
1353 g_task_run_in_thread (task, close_async_thread);
1354 g_object_unref (task);
1358 g_input_stream_real_close_finish (GInputStream *stream,
1359 GAsyncResult *result,
1362 g_return_val_if_fail (g_task_is_valid (result, stream), FALSE);
1364 return g_task_propagate_boolean (G_TASK (result), error);