gio/goutputstream.c

   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@redhat.com>
  21  */
  22
  23 #include "config.h"
  24 #include "goutputstream.h"
  25 #include "gcancellable.h"
  26 #include "gasyncresult.h"
  27 #include "gsimpleasyncresult.h"
  28 #include "ginputstream.h"
  29 #include "gioerror.h"
  30 #include "glibintl.h"
  31
  32
  33 /**
  34  * SECTION:goutputstream
  35  * @short_description: Base class for implementing streaming output
  36  * @include: gio/gio.h
  37  *
  38  * GOutputStream has functions to write to a stream (g_output_stream_write()),
  39  * to close a stream (g_output_stream_close()) and to flush pending writes
  40  * (g_output_stream_flush()).
  41  *
  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().
  44  *
  45  * All of these functions have async variants too.
  46  **/
  47
  48 G_DEFINE_ABSTRACT_TYPE (GOutputStream, g_output_stream, G_TYPE_OBJECT);
  49
  50 struct _GOutputStreamPrivate {
  51   guint closed : 1;
  52   guint pending : 1;
  53   guint closing : 1;
  54   GAsyncReadyCallback outstanding_callback;
  55 };
  56
  57 static gssize   g_output_stream_real_splice        (GOutputStream             *stream,
  58                                                     GInputStream              *source,
  59                                                     GOutputStreamSpliceFlags   flags,
  60                                                     GCancellable              *cancellable,
  61                                                     GError                   **error);
  62 static void     g_output_stream_real_write_async   (GOutputStream             *stream,
  63                                                     const void                *buffer,
  64                                                     gsize                      count,
  65                                                     int                        io_priority,
  66                                                     GCancellable              *cancellable,
  67                                                     GAsyncReadyCallback        callback,
  68                                                     gpointer                   data);
  69 static gssize   g_output_stream_real_write_finish  (GOutputStream             *stream,
  70                                                     GAsyncResult              *result,
  71                                                     GError                   **error);
  72 static void     g_output_stream_real_splice_async  (GOutputStream             *stream,
  73                                                     GInputStream              *source,
  74                                                     GOutputStreamSpliceFlags   flags,
  75                                                     int                        io_priority,
  76                                                     GCancellable              *cancellable,
  77                                                     GAsyncReadyCallback        callback,
  78                                                     gpointer                   data);
  79 static gssize   g_output_stream_real_splice_finish (GOutputStream             *stream,
  80                                                     GAsyncResult              *result,
  81                                                     GError                   **error);
  82 static void     g_output_stream_real_flush_async   (GOutputStream             *stream,
  83                                                     int                        io_priority,
  84                                                     GCancellable              *cancellable,
  85                                                     GAsyncReadyCallback        callback,
  86                                                     gpointer                   data);
  87 static gboolean g_output_stream_real_flush_finish  (GOutputStream             *stream,
  88                                                     GAsyncResult              *result,
  89                                                     GError                   **error);
  90 static void     g_output_stream_real_close_async   (GOutputStream             *stream,
  91                                                     int                        io_priority,
  92                                                     GCancellable              *cancellable,
  93                                                     GAsyncReadyCallback        callback,
  94                                                     gpointer                   data);
  95 static gboolean g_output_stream_real_close_finish  (GOutputStream             *stream,
  96                                                     GAsyncResult              *result,
  97                                                     GError                   **error);
  98
  99 static void
 100 g_output_stream_finalize (GObject *object)
 101 {
 102   G_OBJECT_CLASS (g_output_stream_parent_class)->finalize (object);
 103 }
 104
 105 static void
 106 g_output_stream_dispose (GObject *object)
 107 {
 108   GOutputStream *stream;
 109
 110   stream = G_OUTPUT_STREAM (object);
 111
 112   if (!stream->priv->closed)
 113     g_output_stream_close (stream, NULL, NULL);
 114
 115   G_OBJECT_CLASS (g_output_stream_parent_class)->dispose (object);
 116 }
 117
 118 static void
 119 g_output_stream_class_init (GOutputStreamClass *klass)
 120 {
 121   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 122
 123   g_type_class_add_private (klass, sizeof (GOutputStreamPrivate));
 124
 125   gobject_class->finalize = g_output_stream_finalize;
 126   gobject_class->dispose = g_output_stream_dispose;
 127
 128   klass->splice = g_output_stream_real_splice;
 129
 130   klass->write_async = g_output_stream_real_write_async;
 131   klass->write_finish = g_output_stream_real_write_finish;
 132   klass->splice_async = g_output_stream_real_splice_async;
 133   klass->splice_finish = g_output_stream_real_splice_finish;
 134   klass->flush_async = g_output_stream_real_flush_async;
 135   klass->flush_finish = g_output_stream_real_flush_finish;
 136   klass->close_async = g_output_stream_real_close_async;
 137   klass->close_finish = g_output_stream_real_close_finish;
 138 }
 139
 140 static void
 141 g_output_stream_init (GOutputStream *stream)
 142 {
 143   stream->priv = G_TYPE_INSTANCE_GET_PRIVATE (stream,
 144                                               G_TYPE_OUTPUT_STREAM,
 145                                               GOutputStreamPrivate);
 146 }
 147
 148 /**
 149  * g_output_stream_write:
 150  * @stream: a #GOutputStream.
 151  * @buffer: (array length=count) (element-type uint8): the buffer containing the data to write.
 152  * @count: the number of bytes to write
 153  * @cancellable: optional cancellable object
 154  * @error: location to store the error occuring, or %NULL to ignore
 155  *
 156  * Tries to write @count bytes from @buffer into the stream. Will block
 157  * during the operation.
 158  *
 159  * If count is zero returns zero and does nothing. A value of @count
 160  * larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
 161  *
 162  * On success, the number of bytes written to the stream is returned.
 163  * It is not an error if this is not the same as the requested size, as it
 164  * can happen e.g. on a partial i/o error, or if there is not enough
 165  * storage in the stream. All writes either block until at least one byte
 166  * is written, so zero is never returned (unless @count is zero).
 167  *
 168  * If @cancellable is not NULL, then the operation can be cancelled by
 169  * triggering the cancellable object from another thread. If the operation
 170  * was cancelled, the error G_IO_ERROR_CANCELLED will be returned. If an
 171  * operation was partially finished when the operation was cancelled the
 172  * partial result will be returned, without an error.
 173  *
 174  * On error -1 is returned and @error is set accordingly.
 175  *
 176  * Return value: Number of bytes written, or -1 on error
 177  **/
 178 gssize
 179 g_output_stream_write (GOutputStream  *stream,
 180                        const void     *buffer,
 181                        gsize           count,
 182                        GCancellable   *cancellable,
 183                        GError        **error)
 184 {
 185   GOutputStreamClass *class;
 186   gssize res;
 187
 188   g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), -1);
 189   g_return_val_if_fail (buffer != NULL, 0);
 190
 191   if (count == 0)
 192     return 0;
 193
 194   if (((gssize) count) < 0)
 195     {
 196       g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
 197                    _("Too large count value passed to %s"), G_STRFUNC);
 198       return -1;
 199     }
 200
 201   class = G_OUTPUT_STREAM_GET_CLASS (stream);
 202
 203   if (class->write_fn == NULL)
 204     {
 205       g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
 206                            _("Output stream doesn't implement write"));
 207       return -1;
 208     }
 209
 210   if (!g_output_stream_set_pending (stream, error))
 211     return -1;
 212
 213   if (cancellable)
 214     g_cancellable_push_current (cancellable);
 215
 216   res = class->write_fn (stream, buffer, count, cancellable, error);
 217
 218   if (cancellable)
 219     g_cancellable_pop_current (cancellable);
 220
 221   g_output_stream_clear_pending (stream);
 222
 223   return res;
 224 }
 225
 226 /**
 227  * g_output_stream_write_all:
 228  * @stream: a #GOutputStream.
 229  * @buffer: (array length=count) (element-type uint8): the buffer containing the data to write.
 230  * @count: the number of bytes to write
 231  * @bytes_written: location to store the number of bytes that was
 232  *     written to the stream
 233  * @cancellable: optional #GCancellable object, %NULL to ignore.
 234  * @error: location to store the error occuring, or %NULL to ignore
 235  *
 236  * Tries to write @count bytes from @buffer into the stream. Will block
 237  * during the operation.
 238  *
 239  * This function is similar to g_output_stream_write(), except it tries to
 240  * write as many bytes as requested, only stopping on an error.
 241  *
 242  * On a successful write of @count bytes, %TRUE is returned, and @bytes_written
 243  * is set to @count.
 244  *
 245  * If there is an error during the operation FALSE is returned and @error
 246  * is set to indicate the error status, @bytes_written is updated to contain
 247  * the number of bytes written into the stream before the error occurred.
 248  *
 249  * Return value: %TRUE on success, %FALSE if there was an error
 250  **/
 251 gboolean
 252 g_output_stream_write_all (GOutputStream  *stream,
 253                            const void     *buffer,
 254                            gsize           count,
 255                            gsize          *bytes_written,
 256                            GCancellable   *cancellable,
 257                            GError        **error)
 258 {
 259   gsize _bytes_written;
 260   gssize res;
 261
 262   g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), FALSE);
 263   g_return_val_if_fail (buffer != NULL, FALSE);
 264
 265   _bytes_written = 0;
 266   while (_bytes_written < count)
 267     {
 268       res = g_output_stream_write (stream, (char *)buffer + _bytes_written, count - _bytes_written,
 269                                    cancellable, error);
 270       if (res == -1)
 271         {
 272           if (bytes_written)
 273             *bytes_written = _bytes_written;
 274           return FALSE;
 275         }
 276
 277       if (res == 0)
 278         g_warning ("Write returned zero without error");
 279
 280       _bytes_written += res;
 281     }
 282
 283   if (bytes_written)
 284     *bytes_written = _bytes_written;
 285
 286   return TRUE;
 287 }
 288
 289 /**
 290  * g_output_stream_flush:
 291  * @stream: a #GOutputStream.
 292  * @cancellable: optional cancellable object
 293  * @error: location to store the error occuring, or %NULL to ignore
 294  *
 295  * Flushed any outstanding buffers in the stream. Will block during
 296  * the operation. Closing the stream will implicitly cause a flush.
 297  *
 298  * This function is optional for inherited classes.
 299  *
 300  * If @cancellable is not %NULL, then the operation can be cancelled by
 301  * triggering the cancellable object from another thread. If the operation
 302  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
 303  *
 304  * Return value: %TRUE on success, %FALSE on error
 305  **/
 306 gboolean
 307 g_output_stream_flush (GOutputStream  *stream,
 308                        GCancellable   *cancellable,
 309                        GError        **error)
 310 {
 311   GOutputStreamClass *class;
 312   gboolean res;
 313
 314   g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), FALSE);
 315
 316   if (!g_output_stream_set_pending (stream, error))
 317     return FALSE;
 318
 319   class = G_OUTPUT_STREAM_GET_CLASS (stream);
 320
 321   res = TRUE;
 322   if (class->flush)
 323     {
 324       if (cancellable)
 325         g_cancellable_push_current (cancellable);
 326
 327       res = class->flush (stream, cancellable, error);
 328
 329       if (cancellable)
 330         g_cancellable_pop_current (cancellable);
 331     }
 332
 333   g_output_stream_clear_pending (stream);
 334
 335   return res;
 336 }
 337
 338 /**
 339  * g_output_stream_splice:
 340  * @stream: a #GOutputStream.
 341  * @source: a #GInputStream.
 342  * @flags: a set of #GOutputStreamSpliceFlags.
 343  * @cancellable: optional #GCancellable object, %NULL to ignore.
 344  * @error: a #GError location to store the error occuring, or %NULL to
 345  * ignore.
 346  *
 347  * Splices an input stream into an output stream.
 348  *
 349  * Returns: a #gssize containing the size of the data spliced, or
 350  *     -1 if an error occurred.
 351  **/
 352 gssize
 353 g_output_stream_splice (GOutputStream             *stream,
 354                         GInputStream              *source,
 355                         GOutputStreamSpliceFlags   flags,
 356                         GCancellable              *cancellable,
 357                         GError                   **error)
 358 {
 359   GOutputStreamClass *class;
 360   gssize bytes_copied;
 361
 362   g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), -1);
 363   g_return_val_if_fail (G_IS_INPUT_STREAM (source), -1);
 364
 365   if (g_input_stream_is_closed (source))
 366     {
 367       g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_CLOSED,
 368                            _("Source stream is already closed"));
 369       return -1;
 370     }
 371
 372   if (!g_output_stream_set_pending (stream, error))
 373     return -1;
 374
 375   class = G_OUTPUT_STREAM_GET_CLASS (stream);
 376
 377   if (cancellable)
 378     g_cancellable_push_current (cancellable);
 379
 380   bytes_copied = class->splice (stream, source, flags, cancellable, error);
 381
 382   if (cancellable)
 383     g_cancellable_pop_current (cancellable);
 384
 385   g_output_stream_clear_pending (stream);
 386
 387   return bytes_copied;
 388 }
 389
 390 static gssize
 391 g_output_stream_real_splice (GOutputStream             *stream,
 392                              GInputStream              *source,
 393                              GOutputStreamSpliceFlags   flags,
 394                              GCancellable              *cancellable,
 395                              GError                   **error)
 396 {
 397   GOutputStreamClass *class = G_OUTPUT_STREAM_GET_CLASS (stream);
 398   gssize n_read, n_written;
 399   gssize bytes_copied;
 400   char buffer[8192], *p;
 401   gboolean res;
 402
 403   bytes_copied = 0;
 404   if (class->write_fn == NULL)
 405     {
 406       g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
 407                            _("Output stream doesn't implement write"));
 408       res = FALSE;
 409       goto notsupported;
 410     }
 411
 412   res = TRUE;
 413   do
 414     {
 415       n_read = g_input_stream_read (source, buffer, sizeof (buffer), cancellable, error);
 416       if (n_read == -1)
 417         {
 418           res = FALSE;
 419           break;
 420         }
 421
 422       if (n_read == 0)
 423         break;
 424
 425       p = buffer;
 426       while (n_read > 0)
 427         {
 428           n_written = class->write_fn (stream, p, n_read, cancellable, error);
 429           if (n_written == -1)
 430             {
 431               res = FALSE;
 432               break;
 433             }
 434
 435           p += n_written;
 436           n_read -= n_written;
 437           bytes_copied += n_written;
 438         }
 439     }
 440   while (res);
 441
 442  notsupported:
 443   if (!res)
 444     error = NULL; /* Ignore further errors */
 445
 446   if (flags & G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE)
 447     {
 448       /* Don't care about errors in source here */
 449       g_input_stream_close (source, cancellable, NULL);
 450     }
 451
 452   if (flags & G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET)
 453     {
 454       /* But write errors on close are bad! */
 455       if (class->close_fn &&
 456           !class->close_fn (stream, cancellable, error))
 457         res = FALSE;
 458     }
 459
 460   if (res)
 461     return bytes_copied;
 462
 463   return -1;
 464 }
 465
 466
 467 /**
 468  * g_output_stream_close:
 469  * @stream: A #GOutputStream.
 470  * @cancellable: optional cancellable object
 471  * @error: location to store the error occuring, or %NULL to ignore
 472  *
 473  * Closes the stream, releasing resources related to it.
 474  *
 475  * Once the stream is closed, all other operations will return %G_IO_ERROR_CLOSED.
 476  * Closing a stream multiple times will not return an error.
 477  *
 478  * Closing a stream will automatically flush any outstanding buffers in the
 479  * stream.
 480  *
 481  * Streams will be automatically closed when the last reference
 482  * is dropped, but you might want to call this function to make sure
 483  * resources are released as early as possible.
 484  *
 485  * Some streams might keep the backing store of the stream (e.g. a file descriptor)
 486  * open after the stream is closed. See the documentation for the individual
 487  * stream for details.
 488  *
 489  * On failure the first error that happened will be reported, but the close
 490  * operation will finish as much as possible. A stream that failed to
 491  * close will still return %G_IO_ERROR_CLOSED for all operations. Still, it
 492  * is important to check and report the error to the user, otherwise
 493  * there might be a loss of data as all data might not be written.
 494  *
 495  * If @cancellable is not NULL, then the operation can be cancelled by
 496  * triggering the cancellable object from another thread. If the operation
 497  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
 498  * Cancelling a close will still leave the stream closed, but there some streams
 499  * can use a faster close that doesn't block to e.g. check errors. On
 500  * cancellation (as with any error) there is no guarantee that all written
 501  * data will reach the target.
 502  *
 503  * Return value: %TRUE on success, %FALSE on failure
 504  **/
 505 gboolean
 506 g_output_stream_close (GOutputStream  *stream,
 507                        GCancellable   *cancellable,
 508                        GError        **error)
 509 {
 510   GOutputStreamClass *class;
 511   gboolean res;
 512
 513   g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), FALSE);
 514
 515   class = G_OUTPUT_STREAM_GET_CLASS (stream);
 516
 517   if (stream->priv->closed)
 518     return TRUE;
 519
 520   if (!g_output_stream_set_pending (stream, error))
 521     return FALSE;
 522
 523   stream->priv->closing = TRUE;
 524
 525   if (cancellable)
 526     g_cancellable_push_current (cancellable);
 527
 528   if (class->flush)
 529     res = class->flush (stream, cancellable, error);
 530   else
 531     res = TRUE;
 532
 533   if (!res)
 534     {
 535       /* flushing caused the error that we want to return,
 536        * but we still want to close the underlying stream if possible
 537        */
 538       if (class->close_fn)
 539         class->close_fn (stream, cancellable, NULL);
 540     }
 541   else
 542     {
 543       res = TRUE;
 544       if (class->close_fn)
 545         res = class->close_fn (stream, cancellable, error);
 546     }
 547
 548   if (cancellable)
 549     g_cancellable_pop_current (cancellable);
 550
 551   stream->priv->closing = FALSE;
 552   stream->priv->closed = TRUE;
 553   g_output_stream_clear_pending (stream);
 554
 555   return res;
 556 }
 557
 558 static void
 559 async_ready_callback_wrapper (GObject      *source_object,
 560                               GAsyncResult *res,
 561                               gpointer      user_data)
 562 {
 563   GOutputStream *stream = G_OUTPUT_STREAM (source_object);
 564
 565   g_output_stream_clear_pending (stream);
 566   if (stream->priv->outstanding_callback)
 567     (*stream->priv->outstanding_callback) (source_object, res, user_data);
 568   g_object_unref (stream);
 569 }
 570
 571 typedef struct {
 572   gint io_priority;
 573   GCancellable *cancellable;
 574   GError *flush_error;
 575   gpointer user_data;
 576 } CloseUserData;
 577
 578 static void
 579 async_ready_close_callback_wrapper (GObject      *source_object,
 580                                     GAsyncResult *res,
 581                                     gpointer      user_data)
 582 {
 583   GOutputStream *stream = G_OUTPUT_STREAM (source_object);
 584   CloseUserData *data = user_data;
 585
 586   stream->priv->closing = FALSE;
 587   stream->priv->closed = TRUE;
 588
 589   g_output_stream_clear_pending (stream);
 590
 591   if (stream->priv->outstanding_callback)
 592     {
 593       if (data->flush_error != NULL)
 594         {
 595           GSimpleAsyncResult *err;
 596
 597           err = g_simple_async_result_new_from_error (source_object,
 598                                                       stream->priv->outstanding_callback,
 599                                                       data->user_data,
 600                                                       data->flush_error);
 601
 602           (*stream->priv->outstanding_callback) (source_object,
 603                                                  G_ASYNC_RESULT (err),
 604                                                  data->user_data);
 605           g_object_unref (err);
 606         }
 607       else
 608         {
 609           (*stream->priv->outstanding_callback) (source_object,
 610                                                  res,
 611                                                  data->user_data);
 612         }
 613     }
 614
 615   g_object_unref (stream);
 616
 617   if (data->cancellable)
 618     g_object_unref (data->cancellable);
 619
 620   if (data->flush_error)
 621     g_error_free (data->flush_error);
 622
 623   g_slice_free (CloseUserData, data);
 624 }
 625
 626 static void
 627 async_ready_close_flushed_callback_wrapper (GObject      *source_object,
 628                                             GAsyncResult *res,
 629                                             gpointer      user_data)
 630 {
 631   GOutputStream *stream = G_OUTPUT_STREAM (source_object);
 632   GOutputStreamClass *class;
 633   CloseUserData *data = user_data;
 634   GSimpleAsyncResult *simple;
 635
 636   /* propagate the possible error */
 637   if (G_IS_SIMPLE_ASYNC_RESULT (res))
 638     {
 639       simple = G_SIMPLE_ASYNC_RESULT (res);
 640       g_simple_async_result_propagate_error (simple, &data->flush_error);
 641     }
 642
 643   class = G_OUTPUT_STREAM_GET_CLASS (stream);
 644
 645   /* we still close, even if there was a flush error */
 646   class->close_async (stream, data->io_priority, data->cancellable,
 647                       async_ready_close_callback_wrapper, user_data);
 648 }
 649
 650 /**
 651  * g_output_stream_write_async:
 652  * @stream: A #GOutputStream.
 653  * @buffer: (array length=count) (element-type uint8): the buffer containing the data to write.
 654  * @count: the number of bytes to write
 655  * @io_priority: the io priority of the request.
 656  * @cancellable: optional #GCancellable object, %NULL to ignore.
 657  * @callback: callback to call when the request is satisfied
 658  * @user_data: the data to pass to callback function
 659  *
 660  * Request an asynchronous write of @count bytes from @buffer into
 661  * the stream. When the operation is finished @callback will be called.
 662  * You can then call g_output_stream_write_finish() to get the result of the
 663  * operation.
 664  *
 665  * During an async request no other sync and async calls are allowed,
 666  * and will result in %G_IO_ERROR_PENDING errors.
 667  *
 668  * A value of @count larger than %G_MAXSSIZE will cause a
 669  * %G_IO_ERROR_INVALID_ARGUMENT error.
 670  *
 671  * On success, the number of bytes written will be passed to the
 672  * @callback. It is not an error if this is not the same as the
 673  * requested size, as it can happen e.g. on a partial I/O error,
 674  * but generally we try to write as many bytes as requested.
 675  *
 676  * Any outstanding I/O request with higher priority (lower numerical
 677  * value) will be executed before an outstanding request with lower
 678  * priority. Default priority is %G_PRIORITY_DEFAULT.
 679  *
 680  * The asyncronous methods have a default fallback that uses threads
 681  * to implement asynchronicity, so they are optional for inheriting
 682  * classes. However, if you override one you must override all.
 683  *
 684  * For the synchronous, blocking version of this function, see
 685  * g_output_stream_write().
 686  **/
 687 void
 688 g_output_stream_write_async (GOutputStream       *stream,
 689                              const void          *buffer,
 690                              gsize                count,
 691                              int                  io_priority,
 692                              GCancellable        *cancellable,
 693                              GAsyncReadyCallback  callback,
 694                              gpointer             user_data)
 695 {
 696   GOutputStreamClass *class;
 697   GSimpleAsyncResult *simple;
 698   GError *error = NULL;
 699
 700   g_return_if_fail (G_IS_OUTPUT_STREAM (stream));
 701   g_return_if_fail (buffer != NULL);
 702
 703   if (count == 0)
 704     {
 705       simple = g_simple_async_result_new (G_OBJECT (stream),
 706                                           callback,
 707                                           user_data,
 708                                           g_output_stream_write_async);
 709       g_simple_async_result_complete_in_idle (simple);
 710       g_object_unref (simple);
 711       return;
 712     }
 713
 714   if (((gssize) count) < 0)
 715     {
 716       g_simple_async_report_error_in_idle (G_OBJECT (stream),
 717                                            callback,
 718                                            user_data,
 719                                            G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
 720                                            _("Too large count value passed to %s"),
 721                                            G_STRFUNC);
 722       return;
 723     }
 724
 725   if (!g_output_stream_set_pending (stream, &error))
 726     {
 727       g_simple_async_report_gerror_in_idle (G_OBJECT (stream),
 728                                             callback,
 729                                             user_data,
 730                                             error);
 731       g_error_free (error);
 732       return;
 733     }
 734
 735   class = G_OUTPUT_STREAM_GET_CLASS (stream);
 736
 737   stream->priv->outstanding_callback = callback;
 738   g_object_ref (stream);
 739   class->write_async (stream, buffer, count, io_priority, cancellable,
 740                       async_ready_callback_wrapper, user_data);
 741 }
 742
 743 /**
 744  * g_output_stream_write_finish:
 745  * @stream: a #GOutputStream.
 746  * @result: a #GAsyncResult.
 747  * @error: a #GError location to store the error occuring, or %NULL to
 748  * ignore.
 749  *
 750  * Finishes a stream write operation.
 751  *
 752  * Returns: a #gssize containing the number of bytes written to the stream.
 753  **/
 754 gssize
 755 g_output_stream_write_finish (GOutputStream  *stream,
 756                               GAsyncResult   *result,
 757                               GError        **error)
 758 {
 759   GSimpleAsyncResult *simple;
 760   GOutputStreamClass *class;
 761
 762   g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), -1);
 763   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), -1);
 764
 765   if (G_IS_SIMPLE_ASYNC_RESULT (result))
 766     {
 767       simple = G_SIMPLE_ASYNC_RESULT (result);
 768       if (g_simple_async_result_propagate_error (simple, error))
 769         return -1;
 770
 771       /* Special case writes of 0 bytes */
 772       if (g_simple_async_result_get_source_tag (simple) == g_output_stream_write_async)
 773         return 0;
 774     }
 775
 776   class = G_OUTPUT_STREAM_GET_CLASS (stream);
 777   return class->write_finish (stream, result, error);
 778 }
 779
 780 typedef struct {
 781   GInputStream *source;
 782   gpointer user_data;
 783   GAsyncReadyCallback callback;
 784 } SpliceUserData;
 785
 786 static void
 787 async_ready_splice_callback_wrapper (GObject      *source_object,
 788                                      GAsyncResult *res,
 789                                      gpointer     _data)
 790 {
 791   GOutputStream *stream = G_OUTPUT_STREAM (source_object);
 792   SpliceUserData *data = _data;
 793
 794   g_output_stream_clear_pending (stream);
 795
 796   if (data->callback)
 797     (*data->callback) (source_object, res, data->user_data);
 798
 799   g_object_unref (stream);
 800   g_object_unref (data->source);
 801   g_free (data);
 802 }
 803
 804 /**
 805  * g_output_stream_splice_async:
 806  * @stream: a #GOutputStream.
 807  * @source: a #GInputStream.
 808  * @flags: a set of #GOutputStreamSpliceFlags.
 809  * @io_priority: the io priority of the request.
 810  * @cancellable: optional #GCancellable object, %NULL to ignore.
 811  * @callback: a #GAsyncReadyCallback.
 812  * @user_data: user data passed to @callback.
 813  *
 814  * Splices a stream asynchronously.
 815  * When the operation is finished @callback will be called.
 816  * You can then call g_output_stream_splice_finish() to get the
 817  * result of the operation.
 818  *
 819  * For the synchronous, blocking version of this function, see
 820  * g_output_stream_splice().
 821  **/
 822 void
 823 g_output_stream_splice_async (GOutputStream            *stream,
 824                               GInputStream             *source,
 825                               GOutputStreamSpliceFlags  flags,
 826                               int                       io_priority,
 827                               GCancellable             *cancellable,
 828                               GAsyncReadyCallback       callback,
 829                               gpointer                  user_data)
 830 {
 831   GOutputStreamClass *class;
 832   SpliceUserData *data;
 833   GError *error = NULL;
 834
 835   g_return_if_fail (G_IS_OUTPUT_STREAM (stream));
 836   g_return_if_fail (G_IS_INPUT_STREAM (source));
 837
 838   if (g_input_stream_is_closed (source))
 839     {
 840       g_simple_async_report_error_in_idle (G_OBJECT (stream),
 841                                            callback,
 842                                            user_data,
 843                                            G_IO_ERROR, G_IO_ERROR_CLOSED,
 844                                            _("Source stream is already closed"));
 845       return;
 846     }
 847
 848   if (!g_output_stream_set_pending (stream, &error))
 849     {
 850       g_simple_async_report_gerror_in_idle (G_OBJECT (stream),
 851                                             callback,
 852                                             user_data,
 853                                             error);
 854       g_error_free (error);
 855       return;
 856     }
 857
 858   class = G_OUTPUT_STREAM_GET_CLASS (stream);
 859
 860   data = g_new0 (SpliceUserData, 1);
 861   data->callback = callback;
 862   data->user_data = user_data;
 863   data->source = g_object_ref (source);
 864
 865   g_object_ref (stream);
 866   class->splice_async (stream, source, flags, io_priority, cancellable,
 867                       async_ready_splice_callback_wrapper, data);
 868 }
 869
 870 /**
 871  * g_output_stream_splice_finish:
 872  * @stream: a #GOutputStream.
 873  * @result: a #GAsyncResult.
 874  * @error: a #GError location to store the error occuring, or %NULL to
 875  * ignore.
 876  *
 877  * Finishes an asynchronous stream splice operation.
 878  *
 879  * Returns: a #gssize of the number of bytes spliced.
 880  **/
 881 gssize
 882 g_output_stream_splice_finish (GOutputStream  *stream,
 883                                GAsyncResult   *result,
 884                                GError        **error)
 885 {
 886   GSimpleAsyncResult *simple;
 887   GOutputStreamClass *class;
 888
 889   g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), -1);
 890   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), -1);
 891
 892   if (G_IS_SIMPLE_ASYNC_RESULT (result))
 893     {
 894       simple = G_SIMPLE_ASYNC_RESULT (result);
 895       if (g_simple_async_result_propagate_error (simple, error))
 896         return -1;
 897     }
 898
 899   class = G_OUTPUT_STREAM_GET_CLASS (stream);
 900   return class->splice_finish (stream, result, error);
 901 }
 902
 903 /**
 904  * g_output_stream_flush_async:
 905  * @stream: a #GOutputStream.
 906  * @io_priority: the io priority of the request.
 907  * @cancellable: optional #GCancellable object, %NULL to ignore.
 908  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
 909  * @user_data: the data to pass to callback function
 910  *
 911  * Flushes a stream asynchronously.
 912  * For behaviour details see g_output_stream_flush().
 913  *
 914  * When the operation is finished @callback will be
 915  * called. You can then call g_output_stream_flush_finish() to get the
 916  * result of the operation.
 917  **/
 918 void
 919 g_output_stream_flush_async (GOutputStream       *stream,
 920                              int                  io_priority,
 921                              GCancellable        *cancellable,
 922                              GAsyncReadyCallback  callback,
 923                              gpointer             user_data)
 924 {
 925   GOutputStreamClass *class;
 926   GSimpleAsyncResult *simple;
 927   GError *error = NULL;
 928
 929   g_return_if_fail (G_IS_OUTPUT_STREAM (stream));
 930
 931   if (!g_output_stream_set_pending (stream, &error))
 932     {
 933       g_simple_async_report_gerror_in_idle (G_OBJECT (stream),
 934                                             callback,
 935                                             user_data,
 936                                             error);
 937       g_error_free (error);
 938       return;
 939     }
 940
 941   stream->priv->outstanding_callback = callback;
 942   g_object_ref (stream);
 943
 944   class = G_OUTPUT_STREAM_GET_CLASS (stream);
 945
 946   if (class->flush_async == NULL)
 947     {
 948       simple = g_simple_async_result_new (G_OBJECT (stream),
 949                                           async_ready_callback_wrapper,
 950                                           user_data,
 951                                           g_output_stream_flush_async);
 952       g_simple_async_result_complete_in_idle (simple);
 953       g_object_unref (simple);
 954       return;
 955     }
 956
 957   class->flush_async (stream, io_priority, cancellable,
 958                       async_ready_callback_wrapper, user_data);
 959 }
 960
 961 /**
 962  * g_output_stream_flush_finish:
 963  * @stream: a #GOutputStream.
 964  * @result: a GAsyncResult.
 965  * @error: a #GError location to store the error occuring, or %NULL to
 966  * ignore.
 967  *
 968  * Finishes flushing an output stream.
 969  *
 970  * Returns: %TRUE if flush operation suceeded, %FALSE otherwise.
 971  **/
 972 gboolean
 973 g_output_stream_flush_finish (GOutputStream  *stream,
 974                               GAsyncResult   *result,
 975                               GError        **error)
 976 {
 977   GSimpleAsyncResult *simple;
 978   GOutputStreamClass *klass;
 979
 980   g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), FALSE);
 981   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
 982
 983   if (G_IS_SIMPLE_ASYNC_RESULT (result))
 984     {
 985       simple = G_SIMPLE_ASYNC_RESULT (result);
 986       if (g_simple_async_result_propagate_error (simple, error))
 987         return FALSE;
 988
 989       /* Special case default implementation */
 990       if (g_simple_async_result_get_source_tag (simple) == g_output_stream_flush_async)
 991         return TRUE;
 992     }
 993
 994   klass = G_OUTPUT_STREAM_GET_CLASS (stream);
 995   return klass->flush_finish (stream, result, error);
 996 }
 997
 998
 999 /**
1000  * g_output_stream_close_async:
1001  * @stream: A #GOutputStream.
1002  * @io_priority: the io priority of the request.
1003  * @callback: callback to call when the request is satisfied
1004  * @user_data: the data to pass to callback function
1005  * @cancellable: optional cancellable object
1006  *
1007  * Requests an asynchronous close of the stream, releasing resources
1008  * related to it. When the operation is finished @callback will be
1009  * called. You can then call g_output_stream_close_finish() to get
1010  * the result of the operation.
1011  *
1012  * For behaviour details see g_output_stream_close().
1013  *
1014  * The asyncronous methods have a default fallback that uses threads
1015  * to implement asynchronicity, so they are optional for inheriting
1016  * classes. However, if you override one you must override all.
1017  **/
1018 void
1019 g_output_stream_close_async (GOutputStream       *stream,
1020                              int                  io_priority,
1021                              GCancellable        *cancellable,
1022                              GAsyncReadyCallback  callback,
1023                              gpointer             user_data)
1024 {
1025   GOutputStreamClass *class;
1026   GSimpleAsyncResult *simple;
1027   GError *error = NULL;
1028   CloseUserData *data;
1029
1030   g_return_if_fail (G_IS_OUTPUT_STREAM (stream));
1031
1032   if (stream->priv->closed)
1033     {
1034       simple = g_simple_async_result_new (G_OBJECT (stream),
1035                                           callback,
1036                                           user_data,
1037                                           g_output_stream_close_async);
1038       g_simple_async_result_complete_in_idle (simple);
1039       g_object_unref (simple);
1040       return;
1041     }
1042
1043   if (!g_output_stream_set_pending (stream, &error))
1044     {
1045       g_simple_async_report_gerror_in_idle (G_OBJECT (stream),
1046                                             callback,
1047                                             user_data,
1048                                             error);
1049       g_error_free (error);
1050       return;
1051     }
1052
1053   class = G_OUTPUT_STREAM_GET_CLASS (stream);
1054   stream->priv->closing = TRUE;
1055   stream->priv->outstanding_callback = callback;
1056   g_object_ref (stream);
1057
1058   data = g_slice_new0 (CloseUserData);
1059
1060   if (cancellable != NULL)
1061     data->cancellable = g_object_ref (cancellable);
1062
1063   data->io_priority = io_priority;
1064   data->user_data = user_data;
1065
1066   /* Call close_async directly if there is no need to flush, or if the flush
1067      can be done sync (in the output stream async close thread) */
1068   if (class->flush_async == NULL ||
1069       (class->flush_async == g_output_stream_real_flush_async &&
1070        (class->flush == NULL || class->close_async == g_output_stream_real_close_async)))
1071     {
1072       class->close_async (stream, io_priority, cancellable,
1073                           async_ready_close_callback_wrapper, data);
1074     }
1075   else
1076     {
1077       /* First do an async flush, then do the async close in the callback
1078          wrapper (see async_ready_close_flushed_callback_wrapper) */
1079       class->flush_async (stream, io_priority, cancellable,
1080                           async_ready_close_flushed_callback_wrapper, data);
1081     }
1082 }
1083
1084 /**
1085  * g_output_stream_close_finish:
1086  * @stream: a #GOutputStream.
1087  * @result: a #GAsyncResult.
1088  * @error: a #GError location to store the error occuring, or %NULL to
1089  * ignore.
1090  *
1091  * Closes an output stream.
1092  *
1093  * Returns: %TRUE if stream was successfully closed, %FALSE otherwise.
1094  **/
1095 gboolean
1096 g_output_stream_close_finish (GOutputStream  *stream,
1097                               GAsyncResult   *result,
1098                               GError        **error)
1099 {
1100   GSimpleAsyncResult *simple;
1101   GOutputStreamClass *class;
1102
1103   g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), FALSE);
1104   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
1105
1106   if (G_IS_SIMPLE_ASYNC_RESULT (result))
1107     {
1108       simple = G_SIMPLE_ASYNC_RESULT (result);
1109       if (g_simple_async_result_propagate_error (simple, error))
1110         return FALSE;
1111
1112       /* Special case already closed */
1113       if (g_simple_async_result_get_source_tag (simple) == g_output_stream_close_async)
1114         return TRUE;
1115     }
1116
1117   class = G_OUTPUT_STREAM_GET_CLASS (stream);
1118   return class->close_finish (stream, result, error);
1119 }
1120
1121 /**
1122  * g_output_stream_is_closed:
1123  * @stream: a #GOutputStream.
1124  *
1125  * Checks if an output stream has already been closed.
1126  *
1127  * Returns: %TRUE if @stream is closed. %FALSE otherwise.
1128  **/
1129 gboolean
1130 g_output_stream_is_closed (GOutputStream *stream)
1131 {
1132   g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), TRUE);
1133
1134   return stream->priv->closed;
1135 }
1136
1137 /**
1138  * g_output_stream_is_closing:
1139  * @stream: a #GOutputStream.
1140  *
1141  * Checks if an output stream is being closed. This can be
1142  * used inside e.g. a flush implementation to see if the
1143  * flush (or other i/o operation) is called from within
1144  * the closing operation.
1145  *
1146  * Returns: %TRUE if @stream is being closed. %FALSE otherwise.
1147  *
1148  * Since: 2.24
1149  **/
1150 gboolean
1151 g_output_stream_is_closing (GOutputStream *stream)
1152 {
1153   g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), TRUE);
1154
1155   return stream->priv->closing;
1156 }
1157
1158 /**
1159  * g_output_stream_has_pending:
1160  * @stream: a #GOutputStream.
1161  *
1162  * Checks if an ouput stream has pending actions.
1163  *
1164  * Returns: %TRUE if @stream has pending actions.
1165  **/
1166 gboolean
1167 g_output_stream_has_pending (GOutputStream *stream)
1168 {
1169   g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), FALSE);
1170
1171   return stream->priv->pending;
1172 }
1173
1174 /**
1175  * g_output_stream_set_pending:
1176  * @stream: a #GOutputStream.
1177  * @error: a #GError location to store the error occuring, or %NULL to
1178  * ignore.
1179  *
1180  * Sets @stream to have actions pending. If the pending flag is
1181  * already set or @stream is closed, it will return %FALSE and set
1182  * @error.
1183  *
1184  * Return value: %TRUE if pending was previously unset and is now set.
1185  **/
1186 gboolean
1187 g_output_stream_set_pending (GOutputStream *stream,
1188                              GError **error)
1189 {
1190   g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), FALSE);
1191
1192   if (stream->priv->closed)
1193     {
1194       g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_CLOSED,
1195                            _("Stream is already closed"));
1196       return FALSE;
1197     }
1198
1199   if (stream->priv->pending)
1200     {
1201       g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_PENDING,
1202                            /* Translators: This is an error you get if there is
1203                             * already an operation running against this stream when
1204                             * you try to start one */
1205                            _("Stream has outstanding operation"));
1206       return FALSE;
1207     }
1208
1209   stream->priv->pending = TRUE;
1210   return TRUE;
1211 }
1212
1213 /**
1214  * g_output_stream_clear_pending:
1215  * @stream: output stream
1216  *
1217  * Clears the pending flag on @stream.
1218  **/
1219 void
1220 g_output_stream_clear_pending (GOutputStream *stream)
1221 {
1222   g_return_if_fail (G_IS_OUTPUT_STREAM (stream));
1223
1224   stream->priv->pending = FALSE;
1225 }
1226
1227
1228 /********************************************
1229  *   Default implementation of async ops    *
1230  ********************************************/
1231
1232 typedef struct {
1233   const void         *buffer;
1234   gsize               count_requested;
1235   gssize              count_written;
1236 } WriteData;
1237
1238 static void
1239 write_async_thread (GSimpleAsyncResult *res,
1240                     GObject            *object,
1241                     GCancellable       *cancellable)
1242 {
1243   WriteData *op;
1244   GOutputStreamClass *class;
1245   GError *error = NULL;
1246
1247   class = G_OUTPUT_STREAM_GET_CLASS (object);
1248   op = g_simple_async_result_get_op_res_gpointer (res);
1249   op->count_written = class->write_fn (G_OUTPUT_STREAM (object), op->buffer, op->count_requested,
1250                                        cancellable, &error);
1251   if (op->count_written == -1)
1252     {
1253       g_simple_async_result_set_from_error (res, error);
1254       g_error_free (error);
1255     }
1256 }
1257
1258 static void
1259 g_output_stream_real_write_async (GOutputStream       *stream,
1260                                   const void          *buffer,
1261                                   gsize                count,
1262                                   int                  io_priority,
1263                                   GCancellable        *cancellable,
1264                                   GAsyncReadyCallback  callback,
1265                                   gpointer             user_data)
1266 {
1267   GSimpleAsyncResult *res;
1268   WriteData *op;
1269
1270   op = g_new0 (WriteData, 1);
1271   res = g_simple_async_result_new (G_OBJECT (stream), callback, user_data, g_output_stream_real_write_async);
1272   g_simple_async_result_set_op_res_gpointer (res, op, g_free);
1273   op->buffer = buffer;
1274   op->count_requested = count;
1275
1276   g_simple_async_result_run_in_thread (res, write_async_thread, io_priority, cancellable);
1277   g_object_unref (res);
1278 }
1279
1280 static gssize
1281 g_output_stream_real_write_finish (GOutputStream  *stream,
1282                                    GAsyncResult   *result,
1283                                    GError        **error)
1284 {
1285   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
1286   WriteData *op;
1287
1288   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_output_stream_real_write_async);
1289   op = g_simple_async_result_get_op_res_gpointer (simple);
1290   return op->count_written;
1291 }
1292
1293 typedef struct {
1294   GInputStream *source;
1295   GOutputStreamSpliceFlags flags;
1296   gssize bytes_copied;
1297 } SpliceData;
1298
1299 static void
1300 splice_async_thread (GSimpleAsyncResult *result,
1301                      GObject            *object,
1302                      GCancellable       *cancellable)
1303 {
1304   SpliceData *op;
1305   GOutputStreamClass *class;
1306   GError *error = NULL;
1307   GOutputStream *stream;
1308
1309   stream = G_OUTPUT_STREAM (object);
1310   class = G_OUTPUT_STREAM_GET_CLASS (object);
1311   op = g_simple_async_result_get_op_res_gpointer (result);
1312
1313   op->bytes_copied = class->splice (stream,
1314                                     op->source,
1315                                     op->flags,
1316                                     cancellable,
1317                                     &error);
1318   if (op->bytes_copied == -1)
1319     {
1320       g_simple_async_result_set_from_error (result, error);
1321       g_error_free (error);
1322     }
1323 }
1324
1325 static void
1326 g_output_stream_real_splice_async (GOutputStream             *stream,
1327                                    GInputStream              *source,
1328                                    GOutputStreamSpliceFlags   flags,
1329                                    int                        io_priority,
1330                                    GCancellable              *cancellable,
1331                                    GAsyncReadyCallback        callback,
1332                                    gpointer                   user_data)
1333 {
1334   GSimpleAsyncResult *res;
1335   SpliceData *op;
1336
1337   op = g_new0 (SpliceData, 1);
1338   res = g_simple_async_result_new (G_OBJECT (stream), callback, user_data, g_output_stream_real_splice_async);
1339   g_simple_async_result_set_op_res_gpointer (res, op, g_free);
1340   op->flags = flags;
1341   op->source = source;
1342
1343   /* TODO: In the case where both source and destintion have
1344      non-threadbased async calls we can use a true async copy here */
1345
1346   g_simple_async_result_run_in_thread (res, splice_async_thread, io_priority, cancellable);
1347   g_object_unref (res);
1348 }
1349
1350 static gssize
1351 g_output_stream_real_splice_finish (GOutputStream  *stream,
1352                                     GAsyncResult   *result,
1353                                     GError        **error)
1354 {
1355   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
1356   SpliceData *op;
1357
1358   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_output_stream_real_splice_async);
1359   op = g_simple_async_result_get_op_res_gpointer (simple);
1360   return op->bytes_copied;
1361 }
1362
1363
1364 static void
1365 flush_async_thread (GSimpleAsyncResult *res,
1366                     GObject            *object,
1367                     GCancellable       *cancellable)
1368 {
1369   GOutputStreamClass *class;
1370   gboolean result;
1371   GError *error = NULL;
1372
1373   class = G_OUTPUT_STREAM_GET_CLASS (object);
1374   result = TRUE;
1375   if (class->flush)
1376     result = class->flush (G_OUTPUT_STREAM (object), cancellable, &error);
1377
1378   if (!result)
1379     {
1380       g_simple_async_result_set_from_error (res, error);
1381       g_error_free (error);
1382     }
1383 }
1384
1385 static void
1386 g_output_stream_real_flush_async (GOutputStream       *stream,
1387                                   int                  io_priority,
1388                                   GCancellable        *cancellable,
1389                                   GAsyncReadyCallback  callback,
1390                                   gpointer             user_data)
1391 {
1392   GSimpleAsyncResult *res;
1393
1394   res = g_simple_async_result_new (G_OBJECT (stream), callback, user_data, g_output_stream_real_write_async);
1395
1396   g_simple_async_result_run_in_thread (res, flush_async_thread, io_priority, cancellable);
1397   g_object_unref (res);
1398 }
1399
1400 static gboolean
1401 g_output_stream_real_flush_finish (GOutputStream  *stream,
1402                                    GAsyncResult   *result,
1403                                    GError        **error)
1404 {
1405   return TRUE;
1406 }
1407
1408 static void
1409 close_async_thread (GSimpleAsyncResult *res,
1410                     GObject            *object,
1411                     GCancellable       *cancellable)
1412 {
1413   GOutputStreamClass *class;
1414   GError *error = NULL;
1415   gboolean result = TRUE;
1416
1417   class = G_OUTPUT_STREAM_GET_CLASS (object);
1418
1419   /* Do a flush here if there is a flush function, and we did not have to do
1420      an async flush before (see g_output_stream_close_async) */
1421   if (class->flush != NULL &&
1422       (class->flush_async == NULL ||
1423        class->flush_async == g_output_stream_real_flush_async))
1424     {
1425       result = class->flush (G_OUTPUT_STREAM (object), cancellable, &error);
1426     }
1427
1428   /* Auto handling of cancelation disabled, and ignore
1429      cancellation, since we want to close things anyway, although
1430      possibly in a quick-n-dirty way. At least we never want to leak
1431      open handles */
1432
1433   if (class->close_fn)
1434     {
1435       /* Make sure to close, even if the flush failed (see sync close) */
1436       if (!result)
1437         class->close_fn (G_OUTPUT_STREAM (object), cancellable, NULL);
1438       else
1439         result = class->close_fn (G_OUTPUT_STREAM (object), cancellable, &error);
1440
1441       if (!result)
1442         {
1443           g_simple_async_result_set_from_error (res, error);
1444           g_error_free (error);
1445         }
1446     }
1447 }
1448
1449 static void
1450 g_output_stream_real_close_async (GOutputStream       *stream,
1451                                   int                  io_priority,
1452                                   GCancellable        *cancellable,
1453                                   GAsyncReadyCallback  callback,
1454                                   gpointer             user_data)
1455 {
1456   GSimpleAsyncResult *res;
1457
1458   res = g_simple_async_result_new (G_OBJECT (stream), callback, user_data, g_output_stream_real_close_async);
1459
1460   g_simple_async_result_set_handle_cancellation (res, FALSE);
1461
1462   g_simple_async_result_run_in_thread (res, close_async_thread, io_priority, cancellable);
1463   g_object_unref (res);
1464 }
1465
1466 static gboolean
1467 g_output_stream_real_close_finish (GOutputStream  *stream,
1468                                    GAsyncResult   *result,
1469                                    GError        **error)
1470 {
1471   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
1472   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_output_stream_real_close_async);
1473   return TRUE;
1474 }