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, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: Alexander Larsson <alexl@redhat.com>
24 #include "goutputstream.h"
25 #include "gsimpleasyncresult.h"
31 * SECTION:goutputstream
32 * @short_description: Base class for implementing streaming output
38 G_DEFINE_TYPE (GOutputStream, g_output_stream, G_TYPE_OBJECT);
40 struct _GOutputStreamPrivate {
44 GAsyncReadyCallback outstanding_callback;
47 static gssize g_output_stream_real_splice (GOutputStream *stream,
49 GOutputStreamSpliceFlags flags,
50 GCancellable *cancellable,
52 static void g_output_stream_real_write_async (GOutputStream *stream,
56 GCancellable *cancellable,
57 GAsyncReadyCallback callback,
59 static gssize g_output_stream_real_write_finish (GOutputStream *stream,
62 static void g_output_stream_real_splice_async (GOutputStream *stream,
64 GOutputStreamSpliceFlags flags,
66 GCancellable *cancellable,
67 GAsyncReadyCallback callback,
69 static gssize g_output_stream_real_splice_finish (GOutputStream *stream,
72 static void g_output_stream_real_flush_async (GOutputStream *stream,
74 GCancellable *cancellable,
75 GAsyncReadyCallback callback,
77 static gboolean g_output_stream_real_flush_finish (GOutputStream *stream,
80 static void g_output_stream_real_close_async (GOutputStream *stream,
82 GCancellable *cancellable,
83 GAsyncReadyCallback callback,
85 static gboolean g_output_stream_real_close_finish (GOutputStream *stream,
90 g_output_stream_finalize (GObject *object)
92 GOutputStream *stream;
94 stream = G_OUTPUT_STREAM (object);
96 if (G_OBJECT_CLASS (g_output_stream_parent_class)->finalize)
97 (*G_OBJECT_CLASS (g_output_stream_parent_class)->finalize) (object);
101 g_output_stream_dispose (GObject *object)
103 GOutputStream *stream;
105 stream = G_OUTPUT_STREAM (object);
107 if (!stream->priv->closed)
108 g_output_stream_close (stream, NULL, NULL);
110 if (G_OBJECT_CLASS (g_output_stream_parent_class)->dispose)
111 (*G_OBJECT_CLASS (g_output_stream_parent_class)->dispose) (object);
115 g_output_stream_class_init (GOutputStreamClass *klass)
117 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
119 g_type_class_add_private (klass, sizeof (GOutputStreamPrivate));
121 gobject_class->finalize = g_output_stream_finalize;
122 gobject_class->dispose = g_output_stream_dispose;
124 klass->splice = g_output_stream_real_splice;
126 klass->write_async = g_output_stream_real_write_async;
127 klass->write_finish = g_output_stream_real_write_finish;
128 klass->splice_async = g_output_stream_real_splice_async;
129 klass->splice_finish = g_output_stream_real_splice_finish;
130 klass->flush_async = g_output_stream_real_flush_async;
131 klass->flush_finish = g_output_stream_real_flush_finish;
132 klass->close_async = g_output_stream_real_close_async;
133 klass->close_finish = g_output_stream_real_close_finish;
137 g_output_stream_init (GOutputStream *stream)
139 stream->priv = G_TYPE_INSTANCE_GET_PRIVATE (stream,
140 G_TYPE_OUTPUT_STREAM,
141 GOutputStreamPrivate);
145 * g_output_stream_write:
146 * @stream: a #GOutputStream.
147 * @buffer: the buffer containing the data to write.
148 * @count: the number of bytes to write
149 * @cancellable: optional cancellable object
150 * @error: location to store the error occuring, or %NULL to ignore
152 * Tries to write @count bytes from @buffer into the stream. Will block
153 * during the operation.
155 * If count is zero returns zero and does nothing. A value of @count
156 * larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
158 * On success, the number of bytes written to the stream is returned.
159 * It is not an error if this is not the same as the requested size, as it
160 * can happen e.g. on a partial i/o error, or if the there is not enough
161 * storage in the stream. All writes either block until at least one byte
162 * is written, so zero is never returned (unless @count is zero).
164 * If @cancellable is not NULL, then the operation can be cancelled by
165 * triggering the cancellable object from another thread. If the operation
166 * was cancelled, the error G_IO_ERROR_CANCELLED will be returned. If an
167 * operation was partially finished when the operation was cancelled the
168 * partial result will be returned, without an error.
170 * On error -1 is returned and @error is set accordingly.
172 * Return value: Number of bytes written, or -1 on error
175 g_output_stream_write (GOutputStream *stream,
178 GCancellable *cancellable,
181 GOutputStreamClass *class;
184 g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), -1);
185 g_return_val_if_fail (buffer != NULL, 0);
190 if (((gssize) count) < 0)
192 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
193 _("Too large count value passed to g_output_stream_write"));
197 class = G_OUTPUT_STREAM_GET_CLASS (stream);
199 if (class->write_fn == NULL)
201 g_set_error (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
202 _("Output stream doesn't implement write"));
206 if (!g_output_stream_set_pending (stream, error))
210 g_cancellable_push_current (cancellable);
212 res = class->write_fn (stream, buffer, count, cancellable, error);
215 g_cancellable_pop_current (cancellable);
217 g_output_stream_clear_pending (stream);
223 * g_output_stream_write_all:
224 * @stream: a #GOutputStream.
225 * @buffer: the buffer containing the data to write.
226 * @count: the number of bytes to write
227 * @bytes_written: location to store the number of bytes that was
228 * written to the stream
229 * @cancellable: optional #GCancellable object, %NULL to ignore.
230 * @error: location to store the error occuring, or %NULL to ignore
232 * Tries to write @count bytes from @buffer into the stream. Will block
233 * during the operation.
235 * This function is similar to g_output_stream_write(), except it tries to
236 * write as many bytes as requested, only stopping on an error.
238 * On a successful write of @count bytes, %TRUE is returned, and @bytes_written
241 * If there is an error during the operation FALSE is returned and @error
242 * is set to indicate the error status, @bytes_written is updated to contain
243 * the number of bytes written into the stream before the error occurred.
245 * Return value: %TRUE on success, %FALSE if there was an error
248 g_output_stream_write_all (GOutputStream *stream,
251 gsize *bytes_written,
252 GCancellable *cancellable,
255 gsize _bytes_written;
258 g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), FALSE);
259 g_return_val_if_fail (buffer != NULL, FALSE);
262 while (_bytes_written < count)
264 res = g_output_stream_write (stream, (char *)buffer + _bytes_written, count - _bytes_written,
269 *bytes_written = _bytes_written;
274 g_warning ("Write returned zero without error");
276 _bytes_written += res;
280 *bytes_written = _bytes_written;
286 * g_output_stream_flush:
287 * @stream: a #GOutputStream.
288 * @cancellable: optional cancellable object
289 * @error: location to store the error occuring, or %NULL to ignore
291 * Flushed any outstanding buffers in the stream. Will block during
292 * the operation. Closing the stream will implicitly cause a flush.
294 * This function is optional for inherited classes.
296 * If @cancellable is not %NULL, then the operation can be cancelled by
297 * triggering the cancellable object from another thread. If the operation
298 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
300 * Return value: %TRUE on success, %FALSE on error
303 g_output_stream_flush (GOutputStream *stream,
304 GCancellable *cancellable,
307 GOutputStreamClass *class;
310 g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), FALSE);
312 if (!g_output_stream_set_pending (stream, error))
315 class = G_OUTPUT_STREAM_GET_CLASS (stream);
321 g_cancellable_push_current (cancellable);
323 res = class->flush (stream, cancellable, error);
326 g_cancellable_pop_current (cancellable);
329 g_output_stream_clear_pending (stream);
335 * g_output_stream_splice:
336 * @stream: a #GOutputStream.
337 * @source: a #GInputStream.
338 * @flags: a set of #GOutputStreamSpliceFlags.
339 * @cancellable: optional #GCancellable object, %NULL to ignore.
340 * @error: a #GError location to store the error occuring, or %NULL to
343 * Splices an input stream into an output stream.
345 * Returns: a #gssize containig the size of the data spliced.
348 g_output_stream_splice (GOutputStream *stream,
349 GInputStream *source,
350 GOutputStreamSpliceFlags flags,
351 GCancellable *cancellable,
354 GOutputStreamClass *class;
357 g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), -1);
358 g_return_val_if_fail (G_IS_INPUT_STREAM (source), -1);
360 if (g_input_stream_is_closed (source))
362 g_set_error (error, G_IO_ERROR, G_IO_ERROR_CLOSED,
363 _("Source stream is already closed"));
367 if (!g_output_stream_set_pending (stream, error))
370 class = G_OUTPUT_STREAM_GET_CLASS (stream);
374 g_cancellable_push_current (cancellable);
376 res = class->splice (stream, source, flags, cancellable, error);
379 g_cancellable_pop_current (cancellable);
381 g_output_stream_clear_pending (stream);
387 g_output_stream_real_splice (GOutputStream *stream,
388 GInputStream *source,
389 GOutputStreamSpliceFlags flags,
390 GCancellable *cancellable,
393 GOutputStreamClass *class = G_OUTPUT_STREAM_GET_CLASS (stream);
394 gssize n_read, n_written;
396 char buffer[8192], *p;
400 if (class->write_fn == NULL)
402 g_set_error (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
403 _("Output stream doesn't implement write"));
411 n_read = g_input_stream_read (source, buffer, sizeof (buffer), cancellable, error);
424 n_written = class->write_fn (stream, p, n_read, cancellable, error);
433 bytes_copied += n_written;
440 error = NULL; /* Ignore further errors */
442 if (flags & G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE)
444 /* Don't care about errors in source here */
445 g_input_stream_close (source, cancellable, NULL);
448 if (flags & G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET)
450 /* But write errors on close are bad! */
451 if (!class->close_fn (stream, cancellable, error))
463 * g_output_stream_close:
464 * @stream: A #GOutputStream.
465 * @cancellable: optional cancellable object
466 * @error: location to store the error occuring, or %NULL to ignore
468 * Closes the stream, releasing resources related to it.
470 * Once the stream is closed, all other operations will return %G_IO_ERROR_CLOSED.
471 * Closing a stream multiple times will not return an error.
473 * Closing a stream will automatically flush any outstanding buffers in the
476 * Streams will be automatically closed when the last reference
477 * is dropped, but you might want to call make sure resources
478 * are released as early as possible.
480 * Some streams might keep the backing store of the stream (e.g. a file descriptor)
481 * open after the stream is closed. See the documentation for the individual
482 * stream for details.
484 * On failure the first error that happened will be reported, but the close
485 * operation will finish as much as possible. A stream that failed to
486 * close will still return %G_IO_ERROR_CLOSED all operations. Still, it
487 * is important to check and report the error to the user, otherwise
488 * there might be a loss of data as all data might not be written.
490 * If @cancellable is not NULL, then the operation can be cancelled by
491 * triggering the cancellable object from another thread. If the operation
492 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
493 * Cancelling a close will still leave the stream closed, but there some streams
494 * can use a faster close that doesn't block to e.g. check errors. On
495 * cancellation (as with any error) there is no guarantee that all written
496 * data will reach the target.
498 * Return value: %TRUE on success, %FALSE on failure
501 g_output_stream_close (GOutputStream *stream,
502 GCancellable *cancellable,
505 GOutputStreamClass *class;
508 g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), FALSE);
510 class = G_OUTPUT_STREAM_GET_CLASS (stream);
512 if (stream->priv->closed)
515 if (!g_output_stream_set_pending (stream, error))
519 g_cancellable_push_current (cancellable);
522 res = class->flush (stream, cancellable, error);
528 /* flushing caused the error that we want to return,
529 * but we still want to close the underlying stream if possible
532 class->close_fn (stream, cancellable, NULL);
538 res = class->close_fn (stream, cancellable, error);
542 g_cancellable_pop_current (cancellable);
544 stream->priv->closed = TRUE;
545 g_output_stream_clear_pending (stream);
551 async_ready_callback_wrapper (GObject *source_object,
555 GOutputStream *stream = G_OUTPUT_STREAM (source_object);
557 g_output_stream_clear_pending (stream);
558 if (stream->priv->outstanding_callback)
559 (*stream->priv->outstanding_callback) (source_object, res, user_data);
560 g_object_unref (stream);
564 async_ready_close_callback_wrapper (GObject *source_object,
568 GOutputStream *stream = G_OUTPUT_STREAM (source_object);
570 stream->priv->closed = TRUE;
571 g_output_stream_clear_pending (stream);
572 if (stream->priv->outstanding_callback)
573 (*stream->priv->outstanding_callback) (source_object, res, user_data);
574 g_object_unref (stream);
578 * g_output_stream_write_async:
579 * @stream: A #GOutputStream.
580 * @buffer: the buffer containing the data to write.
581 * @count: the number of bytes to write
582 * @io_priority: the io priority of the request.
583 * @cancellable: optional #GCancellable object, %NULL to ignore.
584 * @callback: callback to call when the request is satisfied
585 * @user_data: the data to pass to callback function
587 * Request an asynchronous write of @count bytes from @buffer into
588 * the stream. When the operation is finished @callback will be called,
589 * giving the results.
591 * During an async request no other sync and async calls are allowed,
592 * and will result in %G_IO_ERROR_PENDING errors.
594 * A value of @count larger than %G_MAXSSIZE will cause a
595 * %G_IO_ERROR_INVALID_ARGUMENT error.
597 * On success, the number of bytes written will be passed to the
598 * @callback. It is not an error if this is not the same as the
599 * requested size, as it can happen e.g. on a partial I/O error,
600 * but generally we try to write as many bytes as requested.
602 * Any outstanding I/O request with higher priority (lower numerical
603 * value) will be executed before an outstanding request with lower
604 * priority. Default priority is %G_PRIORITY_DEFAULT.
606 * The asyncronous methods have a default fallback that uses threads
607 * to implement asynchronicity, so they are optional for inheriting
608 * classes. However, if you override one you must override all.
610 * For the synchronous, blocking version of this function, see
611 * g_output_stream_write().
614 g_output_stream_write_async (GOutputStream *stream,
618 GCancellable *cancellable,
619 GAsyncReadyCallback callback,
622 GOutputStreamClass *class;
623 GSimpleAsyncResult *simple;
624 GError *error = NULL;
626 g_return_if_fail (G_IS_OUTPUT_STREAM (stream));
627 g_return_if_fail (buffer != NULL);
631 simple = g_simple_async_result_new (G_OBJECT (stream),
634 g_output_stream_write_async);
635 g_simple_async_result_complete_in_idle (simple);
636 g_object_unref (simple);
640 if (((gssize) count) < 0)
642 g_simple_async_report_error_in_idle (G_OBJECT (stream),
645 G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
646 _("Too large count value passed to g_output_stream_write_async"));
650 if (!g_output_stream_set_pending (stream, &error))
652 g_simple_async_report_gerror_in_idle (G_OBJECT (stream),
656 g_error_free (error);
660 class = G_OUTPUT_STREAM_GET_CLASS (stream);
662 stream->priv->outstanding_callback = callback;
663 g_object_ref (stream);
664 class->write_async (stream, buffer, count, io_priority, cancellable,
665 async_ready_callback_wrapper, user_data);
669 * g_output_stream_write_finish:
670 * @stream: a #GOutputStream.
671 * @result: a #GAsyncResult.
672 * @error: a #GError location to store the error occuring, or %NULL to
675 * Finishes a stream write operation.
677 * Returns: a #gssize containing the number of bytes written to the stream.
680 g_output_stream_write_finish (GOutputStream *stream,
681 GAsyncResult *result,
684 GSimpleAsyncResult *simple;
685 GOutputStreamClass *class;
687 g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), -1);
688 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), -1);
690 if (G_IS_SIMPLE_ASYNC_RESULT (result))
692 simple = G_SIMPLE_ASYNC_RESULT (result);
693 if (g_simple_async_result_propagate_error (simple, error))
696 /* Special case writes of 0 bytes */
697 if (g_simple_async_result_get_source_tag (simple) == g_output_stream_write_async)
701 class = G_OUTPUT_STREAM_GET_CLASS (stream);
702 return class->write_finish (stream, result, error);
706 GInputStream *source;
708 GAsyncReadyCallback callback;
712 async_ready_splice_callback_wrapper (GObject *source_object,
716 GOutputStream *stream = G_OUTPUT_STREAM (source_object);
717 SpliceUserData *data = _data;
719 g_output_stream_clear_pending (stream);
722 (*data->callback) (source_object, res, data->user_data);
724 g_object_unref (stream);
725 g_object_unref (data->source);
730 * g_output_stream_splice_async:
731 * @stream: a #GOutputStream.
732 * @source: a #GInputStream.
733 * @flags: a set of #GOutputStreamSpliceFlags.
734 * @io_priority: the io priority of the request.
735 * @cancellable: optional #GCancellable object, %NULL to ignore.
736 * @callback: a #GAsyncReadyCallback.
737 * @user_data: user data passed to @callback.
739 * Splices a stream asynchronously.
743 g_output_stream_splice_async (GOutputStream *stream,
744 GInputStream *source,
745 GOutputStreamSpliceFlags flags,
747 GCancellable *cancellable,
748 GAsyncReadyCallback callback,
751 GOutputStreamClass *class;
752 SpliceUserData *data;
753 GError *error = NULL;
755 g_return_if_fail (G_IS_OUTPUT_STREAM (stream));
756 g_return_if_fail (G_IS_INPUT_STREAM (source));
758 if (g_input_stream_is_closed (source))
760 g_simple_async_report_error_in_idle (G_OBJECT (stream),
763 G_IO_ERROR, G_IO_ERROR_CLOSED,
764 _("Source stream is already closed"));
768 if (!g_output_stream_set_pending (stream, &error))
770 g_simple_async_report_gerror_in_idle (G_OBJECT (stream),
774 g_error_free (error);
778 class = G_OUTPUT_STREAM_GET_CLASS (stream);
780 data = g_new0 (SpliceUserData, 1);
781 data->callback = callback;
782 data->user_data = user_data;
783 data->source = g_object_ref (source);
785 g_object_ref (stream);
786 class->splice_async (stream, source, flags, io_priority, cancellable,
787 async_ready_splice_callback_wrapper, data);
791 * g_output_stream_splice_finish:
792 * @stream: a #GOutputStream.
793 * @result: a #GAsyncResult.
794 * @error: a #GError location to store the error occuring, or %NULL to
797 * Finishes an asynchronous stream splice operation.
799 * Returns: a #gssize of the number of bytes spliced.
802 g_output_stream_splice_finish (GOutputStream *stream,
803 GAsyncResult *result,
806 GSimpleAsyncResult *simple;
807 GOutputStreamClass *class;
809 g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), -1);
810 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), -1);
812 if (G_IS_SIMPLE_ASYNC_RESULT (result))
814 simple = G_SIMPLE_ASYNC_RESULT (result);
815 if (g_simple_async_result_propagate_error (simple, error))
819 class = G_OUTPUT_STREAM_GET_CLASS (stream);
820 return class->splice_finish (stream, result, error);
824 * g_output_stream_flush_async:
825 * @stream: a #GOutputStream.
826 * @io_priority: the io priority of the request.
827 * @cancellable: optional #GCancellable object, %NULL to ignore.
828 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
829 * @user_data: the data to pass to callback function
831 * Flushes a stream asynchronously.
835 g_output_stream_flush_async (GOutputStream *stream,
837 GCancellable *cancellable,
838 GAsyncReadyCallback callback,
841 GOutputStreamClass *class;
842 GSimpleAsyncResult *simple;
843 GError *error = NULL;
845 g_return_if_fail (G_IS_OUTPUT_STREAM (stream));
847 if (!g_output_stream_set_pending (stream, &error))
849 g_simple_async_report_gerror_in_idle (G_OBJECT (stream),
853 g_error_free (error);
857 stream->priv->outstanding_callback = callback;
858 g_object_ref (stream);
860 class = G_OUTPUT_STREAM_GET_CLASS (stream);
862 if (class->flush_async == NULL)
864 simple = g_simple_async_result_new (G_OBJECT (stream),
865 async_ready_callback_wrapper,
867 g_output_stream_flush_async);
868 g_simple_async_result_complete_in_idle (simple);
869 g_object_unref (simple);
873 class->flush_async (stream, io_priority, cancellable,
874 async_ready_callback_wrapper, user_data);
878 * g_output_stream_flush_finish:
879 * @stream: a #GOutputStream.
880 * @result: a GAsyncResult.
881 * @error: a #GError location to store the error occuring, or %NULL to
884 * Finishes flushing an output stream.
886 * Returns: %TRUE if flush operation suceeded, %FALSE otherwise.
889 g_output_stream_flush_finish (GOutputStream *stream,
890 GAsyncResult *result,
893 GSimpleAsyncResult *simple;
894 GOutputStreamClass *klass;
896 g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), FALSE);
897 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
899 if (G_IS_SIMPLE_ASYNC_RESULT (result))
901 simple = G_SIMPLE_ASYNC_RESULT (result);
902 if (g_simple_async_result_propagate_error (simple, error))
905 /* Special case default implementation */
906 if (g_simple_async_result_get_source_tag (simple) == g_output_stream_flush_async)
910 klass = G_OUTPUT_STREAM_GET_CLASS (stream);
911 return klass->flush_finish (stream, result, error);
916 * g_output_stream_close_async:
917 * @stream: A #GOutputStream.
918 * @io_priority: the io priority of the request.
919 * @callback: callback to call when the request is satisfied
920 * @user_data: the data to pass to callback function
921 * @cancellable: optional cancellable object
923 * Requests an asynchronous close of the stream, releasing resources
924 * related to it. When the operation is finished @callback will be
925 * called, giving the results.
927 * For behaviour details see g_output_stream_close().
929 * The asyncronous methods have a default fallback that uses threads
930 * to implement asynchronicity, so they are optional for inheriting
931 * classes. However, if you override one you must override all.
934 g_output_stream_close_async (GOutputStream *stream,
936 GCancellable *cancellable,
937 GAsyncReadyCallback callback,
940 GOutputStreamClass *class;
941 GSimpleAsyncResult *simple;
942 GError *error = NULL;
944 g_return_if_fail (G_IS_OUTPUT_STREAM (stream));
946 if (stream->priv->closed)
948 simple = g_simple_async_result_new (G_OBJECT (stream),
951 g_output_stream_close_async);
952 g_simple_async_result_complete_in_idle (simple);
953 g_object_unref (simple);
957 if (!g_output_stream_set_pending (stream, &error))
959 g_simple_async_report_gerror_in_idle (G_OBJECT (stream),
963 g_error_free (error);
967 class = G_OUTPUT_STREAM_GET_CLASS (stream);
968 stream->priv->outstanding_callback = callback;
969 g_object_ref (stream);
970 class->close_async (stream, io_priority, cancellable,
971 async_ready_close_callback_wrapper, user_data);
975 * g_output_stream_close_finish:
976 * @stream: a #GOutputStream.
977 * @result: a #GAsyncResult.
978 * @error: a #GError location to store the error occuring, or %NULL to
981 * Closes an output stream.
983 * Returns: %TRUE if stream was successfully closed, %FALSE otherwise.
986 g_output_stream_close_finish (GOutputStream *stream,
987 GAsyncResult *result,
990 GSimpleAsyncResult *simple;
991 GOutputStreamClass *class;
993 g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), FALSE);
994 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
996 if (G_IS_SIMPLE_ASYNC_RESULT (result))
998 simple = G_SIMPLE_ASYNC_RESULT (result);
999 if (g_simple_async_result_propagate_error (simple, error))
1002 /* Special case already closed */
1003 if (g_simple_async_result_get_source_tag (simple) == g_output_stream_close_async)
1007 class = G_OUTPUT_STREAM_GET_CLASS (stream);
1008 return class->close_finish (stream, result, error);
1012 * g_output_stream_is_closed:
1013 * @stream: a #GOutputStream.
1015 * Checks if an output stream has already been closed.
1017 * Returns: %TRUE if @stream is closed. %FALSE otherwise.
1020 g_output_stream_is_closed (GOutputStream *stream)
1022 g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), TRUE);
1024 return stream->priv->closed;
1028 * g_output_stream_has_pending:
1029 * @stream: a #GOutputStream.
1031 * Checks if an ouput stream has pending actions.
1033 * Returns: %TRUE if @stream has pending actions.
1036 g_output_stream_has_pending (GOutputStream *stream)
1038 g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), FALSE);
1040 return stream->priv->pending;
1044 * g_output_stream_set_pending:
1045 * @stream: a #GOutputStream.
1046 * @error: a #GError location to store the error occuring, or %NULL to
1049 * Sets @stream to have actions pending. If the pending flag is
1050 * already set or @stream is closed, it will return %FALSE and set
1053 * Return value: %TRUE if pending was previously unset and is now set.
1056 g_output_stream_set_pending (GOutputStream *stream,
1059 g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), FALSE);
1061 if (stream->priv->closed)
1063 g_set_error (error, G_IO_ERROR, G_IO_ERROR_CLOSED,
1064 _("Stream is already closed"));
1068 if (stream->priv->pending)
1070 g_set_error (error, G_IO_ERROR, G_IO_ERROR_PENDING,
1071 _("Stream has outstanding operation"));
1075 stream->priv->pending = TRUE;
1080 * g_output_stream_clear_pending:
1081 * @stream: output stream
1083 * Clears the pending flag on @stream.
1086 g_output_stream_clear_pending (GOutputStream *stream)
1088 g_return_if_fail (G_IS_OUTPUT_STREAM (stream));
1090 stream->priv->pending = FALSE;
1094 /********************************************
1095 * Default implementation of async ops *
1096 ********************************************/
1100 gsize count_requested;
1101 gssize count_written;
1105 write_async_thread (GSimpleAsyncResult *res,
1107 GCancellable *cancellable)
1110 GOutputStreamClass *class;
1111 GError *error = NULL;
1113 class = G_OUTPUT_STREAM_GET_CLASS (object);
1114 op = g_simple_async_result_get_op_res_gpointer (res);
1115 op->count_written = class->write_fn (G_OUTPUT_STREAM (object), op->buffer, op->count_requested,
1116 cancellable, &error);
1117 if (op->count_written == -1)
1119 g_simple_async_result_set_from_error (res, error);
1120 g_error_free (error);
1125 g_output_stream_real_write_async (GOutputStream *stream,
1129 GCancellable *cancellable,
1130 GAsyncReadyCallback callback,
1133 GSimpleAsyncResult *res;
1136 op = g_new0 (WriteData, 1);
1137 res = g_simple_async_result_new (G_OBJECT (stream), callback, user_data, g_output_stream_real_write_async);
1138 g_simple_async_result_set_op_res_gpointer (res, op, g_free);
1139 op->buffer = buffer;
1140 op->count_requested = count;
1142 g_simple_async_result_run_in_thread (res, write_async_thread, io_priority, cancellable);
1143 g_object_unref (res);
1147 g_output_stream_real_write_finish (GOutputStream *stream,
1148 GAsyncResult *result,
1151 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
1154 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_output_stream_real_write_async);
1155 op = g_simple_async_result_get_op_res_gpointer (simple);
1156 return op->count_written;
1160 GInputStream *source;
1161 GOutputStreamSpliceFlags flags;
1162 gssize bytes_copied;
1166 splice_async_thread (GSimpleAsyncResult *result,
1168 GCancellable *cancellable)
1171 GOutputStreamClass *class;
1172 GError *error = NULL;
1173 GOutputStream *stream;
1175 stream = G_OUTPUT_STREAM (object);
1176 class = G_OUTPUT_STREAM_GET_CLASS (object);
1177 op = g_simple_async_result_get_op_res_gpointer (result);
1179 op->bytes_copied = class->splice (stream,
1184 if (op->bytes_copied == -1)
1186 g_simple_async_result_set_from_error (result, error);
1187 g_error_free (error);
1192 g_output_stream_real_splice_async (GOutputStream *stream,
1193 GInputStream *source,
1194 GOutputStreamSpliceFlags flags,
1196 GCancellable *cancellable,
1197 GAsyncReadyCallback callback,
1200 GSimpleAsyncResult *res;
1203 op = g_new0 (SpliceData, 1);
1204 res = g_simple_async_result_new (G_OBJECT (stream), callback, user_data, g_output_stream_real_splice_async);
1205 g_simple_async_result_set_op_res_gpointer (res, op, g_free);
1207 op->source = source;
1209 /* TODO: In the case where both source and destintion have
1210 non-threadbased async calls we can use a true async copy here */
1212 g_simple_async_result_run_in_thread (res, splice_async_thread, io_priority, cancellable);
1213 g_object_unref (res);
1217 g_output_stream_real_splice_finish (GOutputStream *stream,
1218 GAsyncResult *result,
1221 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
1224 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_output_stream_real_splice_async);
1225 op = g_simple_async_result_get_op_res_gpointer (simple);
1226 return op->bytes_copied;
1231 flush_async_thread (GSimpleAsyncResult *res,
1233 GCancellable *cancellable)
1235 GOutputStreamClass *class;
1237 GError *error = NULL;
1239 class = G_OUTPUT_STREAM_GET_CLASS (object);
1242 result = class->flush (G_OUTPUT_STREAM (object), cancellable, &error);
1246 g_simple_async_result_set_from_error (res, error);
1247 g_error_free (error);
1252 g_output_stream_real_flush_async (GOutputStream *stream,
1254 GCancellable *cancellable,
1255 GAsyncReadyCallback callback,
1258 GSimpleAsyncResult *res;
1260 res = g_simple_async_result_new (G_OBJECT (stream), callback, user_data, g_output_stream_real_write_async);
1262 g_simple_async_result_run_in_thread (res, flush_async_thread, io_priority, cancellable);
1263 g_object_unref (res);
1267 g_output_stream_real_flush_finish (GOutputStream *stream,
1268 GAsyncResult *result,
1275 close_async_thread (GSimpleAsyncResult *res,
1277 GCancellable *cancellable)
1279 GOutputStreamClass *class;
1280 GError *error = NULL;
1283 /* Auto handling of cancelation disabled, and ignore
1284 cancellation, since we want to close things anyway, although
1285 possibly in a quick-n-dirty way. At least we never want to leak
1288 class = G_OUTPUT_STREAM_GET_CLASS (object);
1289 result = class->close_fn (G_OUTPUT_STREAM (object), cancellable, &error);
1292 g_simple_async_result_set_from_error (res, error);
1293 g_error_free (error);
1298 g_output_stream_real_close_async (GOutputStream *stream,
1300 GCancellable *cancellable,
1301 GAsyncReadyCallback callback,
1304 GSimpleAsyncResult *res;
1306 res = g_simple_async_result_new (G_OBJECT (stream), callback, user_data, g_output_stream_real_close_async);
1308 g_simple_async_result_set_handle_cancellation (res, FALSE);
1310 g_simple_async_result_run_in_thread (res, close_async_thread, io_priority, cancellable);
1311 g_object_unref (res);
1315 g_output_stream_real_close_finish (GOutputStream *stream,
1316 GAsyncResult *result,
1319 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
1320 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_output_stream_real_close_async);
1324 #define __G_OUTPUT_STREAM_C__
1325 #include "gioaliasdef.c"