* Author: Alexander Larsson <alexl@redhat.com>
*/
-#include <config.h>
+#include "config.h"
#include "goutputstream.h"
+#include "gcancellable.h"
+#include "gasyncresult.h"
#include "gsimpleasyncresult.h"
+#include "ginputstream.h"
+#include "gioerror.h"
#include "glibintl.h"
+
/**
* SECTION:goutputstream
- * @short_description: base class for implementing streaming output
- *
- *
+ * @short_description: Base class for implementing streaming output
+ * @include: gio/gio.h
+ *
+ * GOutputStream has functions to write to a stream (g_output_stream_write()),
+ * to close a stream (g_output_stream_close()) and to flush pending writes
+ * (g_output_stream_flush()).
*
+ * To copy the content of an input stream to an output stream without
+ * manually handling the reads and writes, use g_output_stream_splice().
+ *
+ * All of these functions have async variants too.
**/
G_DEFINE_TYPE (GOutputStream, g_output_stream, G_TYPE_OBJECT);
struct _GOutputStreamPrivate {
guint closed : 1;
guint pending : 1;
- guint cancelled : 1;
+ guint closing : 1;
GAsyncReadyCallback outstanding_callback;
};
static void
g_output_stream_finalize (GObject *object)
{
- GOutputStream *stream;
-
- stream = G_OUTPUT_STREAM (object);
-
- if (G_OBJECT_CLASS (g_output_stream_parent_class)->finalize)
- (*G_OBJECT_CLASS (g_output_stream_parent_class)->finalize) (object);
+ G_OBJECT_CLASS (g_output_stream_parent_class)->finalize (object);
}
static void
if (!stream->priv->closed)
g_output_stream_close (stream, NULL, NULL);
-
- if (G_OBJECT_CLASS (g_output_stream_parent_class)->dispose)
- (*G_OBJECT_CLASS (g_output_stream_parent_class)->dispose) (object);
+
+ G_OBJECT_CLASS (g_output_stream_parent_class)->dispose (object);
}
static void
/**
* g_output_stream_write:
* @stream: a #GOutputStream.
- * @buffer: the buffer containing the data to write.
+ * @buffer: (array length=count) (element-type uint8): the buffer containing the data to write.
* @count: the number of bytes to write
* @cancellable: optional cancellable object
* @error: location to store the error occuring, or %NULL to ignore
*
* On success, the number of bytes written to the stream is returned.
* It is not an error if this is not the same as the requested size, as it
- * can happen e.g. on a partial i/o error, or if the there is not enough
+ * can happen e.g. on a partial i/o error, or if there is not enough
* storage in the stream. All writes either block until at least one byte
* is written, so zero is never returned (unless @count is zero).
*
* Return value: Number of bytes written, or -1 on error
**/
gssize
-g_output_stream_write (GOutputStream *stream,
- const void *buffer,
- gsize count,
- GCancellable *cancellable,
- GError **error)
+g_output_stream_write (GOutputStream *stream,
+ const void *buffer,
+ gsize count,
+ GCancellable *cancellable,
+ GError **error)
{
GOutputStreamClass *class;
gssize res;
if (((gssize) count) < 0)
{
g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
- _("Too large count value passed to g_output_stream_write"));
+ _("Too large count value passed to %s"), G_STRFUNC);
return -1;
}
- if (stream->priv->closed)
- {
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_CLOSED,
- _("Stream is already closed"));
- return -1;
- }
-
- if (stream->priv->pending)
- {
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_PENDING,
- _("Stream has outstanding operation"));
- return -1;
- }
-
class = G_OUTPUT_STREAM_GET_CLASS (stream);
- if (class->write == NULL)
+ if (class->write_fn == NULL)
{
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
- _("Output stream doesn't implement write"));
+ g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
+ _("Output stream doesn't implement write"));
return -1;
}
+ if (!g_output_stream_set_pending (stream, error))
+ return -1;
+
if (cancellable)
- g_push_current_cancellable (cancellable);
+ g_cancellable_push_current (cancellable);
- stream->priv->pending = TRUE;
- res = class->write (stream, buffer, count, cancellable, error);
- stream->priv->pending = FALSE;
+ res = class->write_fn (stream, buffer, count, cancellable, error);
if (cancellable)
- g_pop_current_cancellable (cancellable);
+ g_cancellable_pop_current (cancellable);
+ g_output_stream_clear_pending (stream);
+
return res;
}
/**
* g_output_stream_write_all:
* @stream: a #GOutputStream.
- * @buffer: the buffer containing the data to write.
+ * @buffer: (array length=count) (element-type uint8): the buffer containing the data to write.
* @count: the number of bytes to write
- * @bytes_written: location to store the number of bytes that was written to the stream
+ * @bytes_written: location to store the number of bytes that was
+ * written to the stream
* @cancellable: optional #GCancellable object, %NULL to ignore.
* @error: location to store the error occuring, or %NULL to ignore
*
*
* If there is an error during the operation FALSE is returned and @error
* is set to indicate the error status, @bytes_written is updated to contain
- * the number of bytes written into the stream before the error occured.
+ * the number of bytes written into the stream before the error occurred.
*
* Return value: %TRUE on success, %FALSE if there was an error
**/
gboolean
-g_output_stream_write_all (GOutputStream *stream,
- const void *buffer,
- gsize count,
- gsize *bytes_written,
- GCancellable *cancellable,
- GError **error)
+g_output_stream_write_all (GOutputStream *stream,
+ const void *buffer,
+ gsize count,
+ gsize *bytes_written,
+ GCancellable *cancellable,
+ GError **error)
{
gsize _bytes_written;
gssize res;
if (bytes_written)
*bytes_written = _bytes_written;
+
return TRUE;
}
* @cancellable: optional cancellable object
* @error: location to store the error occuring, or %NULL to ignore
*
- * Flushed any outstanding buffers in the stream. Will block during the operation.
- * Closing the stream will implicitly cause a flush.
+ * Flushed any outstanding buffers in the stream. Will block during
+ * the operation. Closing the stream will implicitly cause a flush.
*
* This function is optional for inherited classes.
*
* Return value: %TRUE on success, %FALSE on error
**/
gboolean
-g_output_stream_flush (GOutputStream *stream,
- GCancellable *cancellable,
- GError **error)
+g_output_stream_flush (GOutputStream *stream,
+ GCancellable *cancellable,
+ GError **error)
{
GOutputStreamClass *class;
gboolean res;
g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), FALSE);
- if (stream->priv->closed)
- {
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_CLOSED,
- _("Stream is already closed"));
- return FALSE;
- }
-
- if (stream->priv->pending)
- {
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_PENDING,
- _("Stream has outstanding operation"));
- return FALSE;
- }
+ if (!g_output_stream_set_pending (stream, error))
+ return FALSE;
class = G_OUTPUT_STREAM_GET_CLASS (stream);
if (class->flush)
{
if (cancellable)
- g_push_current_cancellable (cancellable);
+ g_cancellable_push_current (cancellable);
- stream->priv->pending = TRUE;
res = class->flush (stream, cancellable, error);
- stream->priv->pending = FALSE;
if (cancellable)
- g_pop_current_cancellable (cancellable);
+ g_cancellable_pop_current (cancellable);
}
+ g_output_stream_clear_pending (stream);
+
return res;
}
* @stream: a #GOutputStream.
* @source: a #GInputStream.
* @flags: a set of #GOutputStreamSpliceFlags.
- * @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: a #GError location to store the error occuring, or %NULL to
+ * @cancellable: optional #GCancellable object, %NULL to ignore.
+ * @error: a #GError location to store the error occuring, or %NULL to
* ignore.
*
* Splices an input stream into an output stream.
*
- * Returns: a #gssize containig the size of the data spliced.
+ * Returns: a #gssize containing the size of the data spliced, or
+ * -1 if an error occurred.
**/
gssize
-g_output_stream_splice (GOutputStream *stream,
- GInputStream *source,
- GOutputStreamSpliceFlags flags,
- GCancellable *cancellable,
- GError **error)
+g_output_stream_splice (GOutputStream *stream,
+ GInputStream *source,
+ GOutputStreamSpliceFlags flags,
+ GCancellable *cancellable,
+ GError **error)
{
GOutputStreamClass *class;
- gboolean res;
+ gssize bytes_copied;
g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), -1);
g_return_val_if_fail (G_IS_INPUT_STREAM (source), -1);
- if (stream->priv->closed)
- {
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_CLOSED,
- _("Target stream is already closed"));
- return -1;
- }
-
if (g_input_stream_is_closed (source))
{
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_CLOSED,
- _("Source stream is already closed"));
+ g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_CLOSED,
+ _("Source stream is already closed"));
return -1;
}
- if (stream->priv->pending)
- {
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_PENDING,
- _("Stream has outstanding operation"));
- return -1;
- }
-
+ if (!g_output_stream_set_pending (stream, error))
+ return -1;
+
class = G_OUTPUT_STREAM_GET_CLASS (stream);
- res = TRUE;
if (cancellable)
- g_push_current_cancellable (cancellable);
-
- stream->priv->pending = TRUE;
- res = class->splice (stream, source, flags, cancellable, error);
- stream->priv->pending = FALSE;
-
+ g_cancellable_push_current (cancellable);
+
+ bytes_copied = class->splice (stream, source, flags, cancellable, error);
+
if (cancellable)
- g_pop_current_cancellable (cancellable);
-
- return res;
+ g_cancellable_pop_current (cancellable);
+
+ g_output_stream_clear_pending (stream);
+
+ return bytes_copied;
}
static gssize
-g_output_stream_real_splice (GOutputStream *stream,
- GInputStream *source,
- GOutputStreamSpliceFlags flags,
- GCancellable *cancellable,
- GError **error)
+g_output_stream_real_splice (GOutputStream *stream,
+ GInputStream *source,
+ GOutputStreamSpliceFlags flags,
+ GCancellable *cancellable,
+ GError **error)
{
+ GOutputStreamClass *class = G_OUTPUT_STREAM_GET_CLASS (stream);
gssize n_read, n_written;
gssize bytes_copied;
char buffer[8192], *p;
gboolean res;
bytes_copied = 0;
+ if (class->write_fn == NULL)
+ {
+ g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
+ _("Output stream doesn't implement write"));
+ res = FALSE;
+ goto notsupported;
+ }
+
res = TRUE;
- do
+ do
{
n_read = g_input_stream_read (source, buffer, sizeof (buffer), cancellable, error);
if (n_read == -1)
res = FALSE;
break;
}
-
+
if (n_read == 0)
break;
p = buffer;
while (n_read > 0)
{
- stream->priv->pending = FALSE;
- n_written = g_output_stream_write (stream, p, n_read, cancellable, error);
- stream->priv->pending = TRUE;
+ n_written = class->write_fn (stream, p, n_read, cancellable, error);
if (n_written == -1)
{
res = FALSE;
}
while (res);
+ notsupported:
if (!res)
error = NULL; /* Ignore further errors */
- if (flags & G_OUTPUT_STREAM_SPLICE_FLAGS_CLOSE_SOURCE)
+ if (flags & G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE)
{
/* Don't care about errors in source here */
g_input_stream_close (source, cancellable, NULL);
}
- if (flags & G_OUTPUT_STREAM_SPLICE_FLAGS_CLOSE_TARGET)
+ if (flags & G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET)
{
/* But write errors on close are bad! */
- stream->priv->pending = FALSE;
- if (!g_output_stream_close (stream, cancellable, error))
+ if (class->close_fn &&
+ !class->close_fn (stream, cancellable, error))
res = FALSE;
- stream->priv->pending = TRUE;
}
if (res)
return bytes_copied;
-
+
return -1;
}
* stream.
*
* Streams will be automatically closed when the last reference
- * is dropped, but you might want to call make sure resources
- * are released as early as possible.
+ * is dropped, but you might want to call this function to make sure
+ * resources are released as early as possible.
*
* Some streams might keep the backing store of the stream (e.g. a file descriptor)
* open after the stream is closed. See the documentation for the individual
*
* On failure the first error that happened will be reported, but the close
* operation will finish as much as possible. A stream that failed to
- * close will still return %G_IO_ERROR_CLOSED all operations. Still, it
+ * close will still return %G_IO_ERROR_CLOSED for all operations. Still, it
* is important to check and report the error to the user, otherwise
* there might be a loss of data as all data might not be written.
*
if (stream->priv->closed)
return TRUE;
- if (stream->priv->pending)
- {
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_PENDING,
- _("Stream has outstanding operation"));
- return FALSE;
- }
+ if (!g_output_stream_set_pending (stream, error))
+ return FALSE;
- res = g_output_stream_flush (stream, cancellable, error);
+ stream->priv->closing = TRUE;
- stream->priv->pending = TRUE;
-
if (cancellable)
- g_push_current_cancellable (cancellable);
+ g_cancellable_push_current (cancellable);
+ if (class->flush)
+ res = class->flush (stream, cancellable, error);
+ else
+ res = TRUE;
+
if (!res)
{
/* flushing caused the error that we want to return,
* but we still want to close the underlying stream if possible
*/
- if (class->close)
- class->close (stream, cancellable, NULL);
+ if (class->close_fn)
+ class->close_fn (stream, cancellable, NULL);
}
else
{
res = TRUE;
- if (class->close)
- res = class->close (stream, cancellable, error);
+ if (class->close_fn)
+ res = class->close_fn (stream, cancellable, error);
}
if (cancellable)
- g_pop_current_cancellable (cancellable);
-
+ g_cancellable_pop_current (cancellable);
+
+ stream->priv->closing = FALSE;
stream->priv->closed = TRUE;
- stream->priv->pending = FALSE;
+ g_output_stream_clear_pending (stream);
return res;
}
static void
-async_ready_callback_wrapper (GObject *source_object,
- GAsyncResult *res,
- gpointer user_data)
+async_ready_callback_wrapper (GObject *source_object,
+ GAsyncResult *res,
+ gpointer user_data)
{
GOutputStream *stream = G_OUTPUT_STREAM (source_object);
- stream->priv->pending = FALSE;
+ g_output_stream_clear_pending (stream);
if (stream->priv->outstanding_callback)
(*stream->priv->outstanding_callback) (source_object, res, user_data);
g_object_unref (stream);
}
+typedef struct {
+ gint io_priority;
+ GCancellable *cancellable;
+ GError *flush_error;
+ gpointer user_data;
+} CloseUserData;
+
static void
-async_ready_close_callback_wrapper (GObject *source_object,
- GAsyncResult *res,
- gpointer user_data)
+async_ready_close_callback_wrapper (GObject *source_object,
+ GAsyncResult *res,
+ gpointer user_data)
{
GOutputStream *stream = G_OUTPUT_STREAM (source_object);
+ CloseUserData *data = user_data;
- stream->priv->pending = FALSE;
+ stream->priv->closing = FALSE;
stream->priv->closed = TRUE;
+
+ g_output_stream_clear_pending (stream);
+
if (stream->priv->outstanding_callback)
- (*stream->priv->outstanding_callback) (source_object, res, user_data);
+ {
+ if (data->flush_error != NULL)
+ {
+ GSimpleAsyncResult *err;
+
+ err = g_simple_async_result_new_from_error (source_object,
+ stream->priv->outstanding_callback,
+ data->user_data,
+ data->flush_error);
+
+ (*stream->priv->outstanding_callback) (source_object,
+ G_ASYNC_RESULT (err),
+ data->user_data);
+ g_object_unref (err);
+ }
+ else
+ {
+ (*stream->priv->outstanding_callback) (source_object,
+ res,
+ data->user_data);
+ }
+ }
+
g_object_unref (stream);
+
+ if (data->cancellable)
+ g_object_unref (data->cancellable);
+
+ if (data->flush_error)
+ g_error_free (data->flush_error);
+
+ g_slice_free (CloseUserData, data);
+}
+
+static void
+async_ready_close_flushed_callback_wrapper (GObject *source_object,
+ GAsyncResult *res,
+ gpointer user_data)
+{
+ GOutputStream *stream = G_OUTPUT_STREAM (source_object);
+ GOutputStreamClass *class;
+ CloseUserData *data = user_data;
+ GSimpleAsyncResult *simple;
+
+ /* propagate the possible error */
+ if (G_IS_SIMPLE_ASYNC_RESULT (res))
+ {
+ simple = G_SIMPLE_ASYNC_RESULT (res);
+ g_simple_async_result_propagate_error (simple, &data->flush_error);
+ }
+
+ class = G_OUTPUT_STREAM_GET_CLASS (stream);
+
+ /* we still close, even if there was a flush error */
+ class->close_async (stream, data->io_priority, data->cancellable,
+ async_ready_close_callback_wrapper, user_data);
}
/**
* g_output_stream_write_async:
* @stream: A #GOutputStream.
- * @buffer: the buffer containing the data to write.
+ * @buffer: (array length=count) (element-type uint8): the buffer containing the data to write.
* @count: the number of bytes to write
- * @io_priority: the io priority of the request. the io priority of the request
+ * @io_priority: the io priority of the request.
* @cancellable: optional #GCancellable object, %NULL to ignore.
* @callback: callback to call when the request is satisfied
* @user_data: the data to pass to callback function
*
- * Request an asynchronous write of @count bytes from @buffer into the stream.
- * When the operation is finished @callback will be called, giving the results.
+ * Request an asynchronous write of @count bytes from @buffer into
+ * the stream. When the operation is finished @callback will be called.
+ * You can then call g_output_stream_write_finish() to get the result of the
+ * operation.
*
- * During an async request no other sync and async calls are allowed, and will
- * result in %G_IO_ERROR_PENDING errors.
+ * During an async request no other sync and async calls are allowed,
+ * and will result in %G_IO_ERROR_PENDING errors.
*
- * A value of @count larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
+ * A value of @count larger than %G_MAXSSIZE will cause a
+ * %G_IO_ERROR_INVALID_ARGUMENT error.
*
* On success, the number of bytes written will be passed to the
- * @callback. It is not an error if this is not the same as the requested size, as it
- * can happen e.g. on a partial i/o error, but generally we try to write
- * as many bytes as requested.
+ * @callback. It is not an error if this is not the same as the
+ * requested size, as it can happen e.g. on a partial I/O error,
+ * but generally we try to write as many bytes as requested.
*
- * Any outstanding i/o request with higher priority (lower numerical value) will
- * be executed before an outstanding request with lower priority. Default
- * priority is %G_PRIORITY_DEFAULT.
+ * Any outstanding I/O request with higher priority (lower numerical
+ * value) will be executed before an outstanding request with lower
+ * priority. Default priority is %G_PRIORITY_DEFAULT.
*
- * The asyncronous methods have a default fallback that uses threads to implement
- * asynchronicity, so they are optional for inheriting classes. However, if you
- * override one you must override all.
+ * The asyncronous methods have a default fallback that uses threads
+ * to implement asynchronicity, so they are optional for inheriting
+ * classes. However, if you override one you must override all.
*
- * For the synchronous, blocking version of this function, see g_output_stream_write().
+ * For the synchronous, blocking version of this function, see
+ * g_output_stream_write().
**/
void
g_output_stream_write_async (GOutputStream *stream,
{
GOutputStreamClass *class;
GSimpleAsyncResult *simple;
+ GError *error = NULL;
g_return_if_fail (G_IS_OUTPUT_STREAM (stream));
g_return_if_fail (buffer != NULL);
callback,
user_data,
G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
- _("Too large count value passed to g_output_stream_write_async"));
+ _("Too large count value passed to %s"),
+ G_STRFUNC);
return;
}
- if (stream->priv->closed)
+ if (!g_output_stream_set_pending (stream, &error))
{
- g_simple_async_report_error_in_idle (G_OBJECT (stream),
- callback,
- user_data,
- G_IO_ERROR, G_IO_ERROR_CLOSED,
- _("Stream is already closed"));
+ g_simple_async_report_gerror_in_idle (G_OBJECT (stream),
+ callback,
+ user_data,
+ error);
+ g_error_free (error);
return;
}
- if (stream->priv->pending)
- {
- g_simple_async_report_error_in_idle (G_OBJECT (stream),
- callback,
- user_data,
- G_IO_ERROR, G_IO_ERROR_PENDING,
- _("Stream has outstanding operation"));
- return;
- }
-
class = G_OUTPUT_STREAM_GET_CLASS (stream);
- stream->priv->pending = TRUE;
stream->priv->outstanding_callback = callback;
g_object_ref (stream);
class->write_async (stream, buffer, count, io_priority, cancellable,
* Returns: a #gssize containing the number of bytes written to the stream.
**/
gssize
-g_output_stream_write_finish (GOutputStream *stream,
- GAsyncResult *result,
- GError **error)
+g_output_stream_write_finish (GOutputStream *stream,
+ GAsyncResult *result,
+ GError **error)
{
GSimpleAsyncResult *simple;
GOutputStreamClass *class;
} SpliceUserData;
static void
-async_ready_splice_callback_wrapper (GObject *source_object,
- GAsyncResult *res,
- gpointer _data)
+async_ready_splice_callback_wrapper (GObject *source_object,
+ GAsyncResult *res,
+ gpointer _data)
{
GOutputStream *stream = G_OUTPUT_STREAM (source_object);
SpliceUserData *data = _data;
- stream->priv->pending = FALSE;
+ g_output_stream_clear_pending (stream);
if (data->callback)
(*data->callback) (source_object, res, data->user_data);
* @user_data: user data passed to @callback.
*
* Splices a stream asynchronously.
- *
+ * When the operation is finished @callback will be called.
+ * You can then call g_output_stream_splice_finish() to get the
+ * result of the operation.
+ *
+ * For the synchronous, blocking version of this function, see
+ * g_output_stream_splice().
**/
void
-g_output_stream_splice_async (GOutputStream *stream,
- GInputStream *source,
- GOutputStreamSpliceFlags flags,
- int io_priority,
- GCancellable *cancellable,
- GAsyncReadyCallback callback,
- gpointer user_data)
+g_output_stream_splice_async (GOutputStream *stream,
+ GInputStream *source,
+ GOutputStreamSpliceFlags flags,
+ int io_priority,
+ GCancellable *cancellable,
+ GAsyncReadyCallback callback,
+ gpointer user_data)
{
GOutputStreamClass *class;
SpliceUserData *data;
+ GError *error = NULL;
g_return_if_fail (G_IS_OUTPUT_STREAM (stream));
g_return_if_fail (G_IS_INPUT_STREAM (source));
- if (stream->priv->closed)
- {
- g_simple_async_report_error_in_idle (G_OBJECT (stream),
- callback,
- user_data,
- G_IO_ERROR, G_IO_ERROR_CLOSED,
- _("Target stream is already closed"));
- return;
- }
-
if (g_input_stream_is_closed (source))
{
g_simple_async_report_error_in_idle (G_OBJECT (stream),
return;
}
- if (stream->priv->pending)
+ if (!g_output_stream_set_pending (stream, &error))
{
- g_simple_async_report_error_in_idle (G_OBJECT (stream),
- callback,
- user_data,
- G_IO_ERROR, G_IO_ERROR_PENDING,
- _("Stream has outstanding operation"));
+ g_simple_async_report_gerror_in_idle (G_OBJECT (stream),
+ callback,
+ user_data,
+ error);
+ g_error_free (error);
return;
}
class = G_OUTPUT_STREAM_GET_CLASS (stream);
- stream->priv->pending = TRUE;
-
data = g_new0 (SpliceUserData, 1);
data->callback = callback;
data->user_data = user_data;
* Returns: a #gssize of the number of bytes spliced.
**/
gssize
-g_output_stream_splice_finish (GOutputStream *stream,
- GAsyncResult *result,
- GError **error)
+g_output_stream_splice_finish (GOutputStream *stream,
+ GAsyncResult *result,
+ GError **error)
{
GSimpleAsyncResult *simple;
GOutputStreamClass *class;
* @user_data: the data to pass to callback function
*
* Flushes a stream asynchronously.
- *
+ * For behaviour details see g_output_stream_flush().
+ *
+ * When the operation is finished @callback will be
+ * called. You can then call g_output_stream_flush_finish() to get the
+ * result of the operation.
**/
void
g_output_stream_flush_async (GOutputStream *stream,
- int io_priority,
- GCancellable *cancellable,
- GAsyncReadyCallback callback,
- gpointer user_data)
+ int io_priority,
+ GCancellable *cancellable,
+ GAsyncReadyCallback callback,
+ gpointer user_data)
{
GOutputStreamClass *class;
GSimpleAsyncResult *simple;
+ GError *error = NULL;
g_return_if_fail (G_IS_OUTPUT_STREAM (stream));
- if (stream->priv->closed)
+ if (!g_output_stream_set_pending (stream, &error))
{
- g_simple_async_report_error_in_idle (G_OBJECT (stream),
- callback,
- user_data,
- G_IO_ERROR, G_IO_ERROR_CLOSED,
- _("Stream is already closed"));
- return;
- }
-
- if (stream->priv->pending)
- {
- g_simple_async_report_error_in_idle (G_OBJECT (stream),
- callback,
- user_data,
- G_IO_ERROR, G_IO_ERROR_PENDING,
- _("Stream has outstanding operation"));
+ g_simple_async_report_gerror_in_idle (G_OBJECT (stream),
+ callback,
+ user_data,
+ error);
+ g_error_free (error);
return;
}
+ stream->priv->outstanding_callback = callback;
+ g_object_ref (stream);
+
class = G_OUTPUT_STREAM_GET_CLASS (stream);
if (class->flush_async == NULL)
{
simple = g_simple_async_result_new (G_OBJECT (stream),
- callback,
+ async_ready_callback_wrapper,
user_data,
g_output_stream_flush_async);
g_simple_async_result_complete_in_idle (simple);
return;
}
- stream->priv->pending = TRUE;
- stream->priv->outstanding_callback = callback;
- g_object_ref (stream);
class->flush_async (stream, io_priority, cancellable,
async_ready_callback_wrapper, user_data);
}
* Returns: %TRUE if flush operation suceeded, %FALSE otherwise.
**/
gboolean
-g_output_stream_flush_finish (GOutputStream *stream,
- GAsyncResult *result,
- GError **error)
+g_output_stream_flush_finish (GOutputStream *stream,
+ GAsyncResult *result,
+ GError **error)
{
GSimpleAsyncResult *simple;
GOutputStreamClass *klass;
/**
* g_output_stream_close_async:
* @stream: A #GOutputStream.
+ * @io_priority: the io priority of the request.
* @callback: callback to call when the request is satisfied
* @user_data: the data to pass to callback function
* @cancellable: optional cancellable object
*
- * Requests an asynchronous closes of the stream, releasing resources related to it.
- * When the operation is finished @callback will be called, giving the results.
+ * Requests an asynchronous close of the stream, releasing resources
+ * related to it. When the operation is finished @callback will be
+ * called. You can then call g_output_stream_close_finish() to get
+ * the result of the operation.
*
* For behaviour details see g_output_stream_close().
*
- * The asyncronous methods have a default fallback that uses threads to implement
- * asynchronicity, so they are optional for inheriting classes. However, if you
- * override one you must override all.
+ * The asyncronous methods have a default fallback that uses threads
+ * to implement asynchronicity, so they are optional for inheriting
+ * classes. However, if you override one you must override all.
**/
void
-g_output_stream_close_async (GOutputStream *stream,
- int io_priority,
- GCancellable *cancellable,
- GAsyncReadyCallback callback,
- gpointer user_data)
+g_output_stream_close_async (GOutputStream *stream,
+ int io_priority,
+ GCancellable *cancellable,
+ GAsyncReadyCallback callback,
+ gpointer user_data)
{
GOutputStreamClass *class;
GSimpleAsyncResult *simple;
+ GError *error = NULL;
+ CloseUserData *data;
g_return_if_fail (G_IS_OUTPUT_STREAM (stream));
return;
}
- if (stream->priv->pending)
+ if (!g_output_stream_set_pending (stream, &error))
{
- g_simple_async_report_error_in_idle (G_OBJECT (stream),
- callback,
- user_data,
- G_IO_ERROR, G_IO_ERROR_PENDING,
- _("Stream has outstanding operation"));
+ g_simple_async_report_gerror_in_idle (G_OBJECT (stream),
+ callback,
+ user_data,
+ error);
+ g_error_free (error);
return;
}
class = G_OUTPUT_STREAM_GET_CLASS (stream);
- stream->priv->pending = TRUE;
+ stream->priv->closing = TRUE;
stream->priv->outstanding_callback = callback;
g_object_ref (stream);
- class->close_async (stream, io_priority, cancellable,
- async_ready_close_callback_wrapper, user_data);
+
+ data = g_slice_new0 (CloseUserData);
+
+ if (cancellable != NULL)
+ data->cancellable = g_object_ref (cancellable);
+
+ data->io_priority = io_priority;
+ data->user_data = user_data;
+
+ /* Call close_async directly if there is no need to flush, or if the flush
+ can be done sync (in the output stream async close thread) */
+ if (class->flush_async == NULL ||
+ (class->flush_async == g_output_stream_real_flush_async &&
+ (class->flush == NULL || class->close_async == g_output_stream_real_close_async)))
+ {
+ class->close_async (stream, io_priority, cancellable,
+ async_ready_close_callback_wrapper, data);
+ }
+ else
+ {
+ /* First do an async flush, then do the async close in the callback
+ wrapper (see async_ready_close_flushed_callback_wrapper) */
+ class->flush_async (stream, io_priority, cancellable,
+ async_ready_close_flushed_callback_wrapper, data);
+ }
}
/**
* Returns: %TRUE if stream was successfully closed, %FALSE otherwise.
**/
gboolean
-g_output_stream_close_finish (GOutputStream *stream,
- GAsyncResult *result,
- GError **error)
+g_output_stream_close_finish (GOutputStream *stream,
+ GAsyncResult *result,
+ GError **error)
{
GSimpleAsyncResult *simple;
GOutputStreamClass *class;
}
/**
+ * g_output_stream_is_closing:
+ * @stream: a #GOutputStream.
+ *
+ * Checks if an output stream is being closed. This can be
+ * used inside e.g. a flush implementation to see if the
+ * flush (or other i/o operation) is called from within
+ * the closing operation.
+ *
+ * Returns: %TRUE if @stream is being closed. %FALSE otherwise.
+ *
+ * Since: 2.24
+ **/
+gboolean
+g_output_stream_is_closing (GOutputStream *stream)
+{
+ g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), TRUE);
+
+ return stream->priv->closing;
+}
+
+/**
* g_output_stream_has_pending:
* @stream: a #GOutputStream.
*
/**
* g_output_stream_set_pending:
* @stream: a #GOutputStream.
- * @pending: a #gboolean.
+ * @error: a #GError location to store the error occuring, or %NULL to
+ * ignore.
+ *
+ * Sets @stream to have actions pending. If the pending flag is
+ * already set or @stream is closed, it will return %FALSE and set
+ * @error.
+ *
+ * Return value: %TRUE if pending was previously unset and is now set.
+ **/
+gboolean
+g_output_stream_set_pending (GOutputStream *stream,
+ GError **error)
+{
+ g_return_val_if_fail (G_IS_OUTPUT_STREAM (stream), FALSE);
+
+ if (stream->priv->closed)
+ {
+ g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_CLOSED,
+ _("Stream is already closed"));
+ return FALSE;
+ }
+
+ if (stream->priv->pending)
+ {
+ g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_PENDING,
+ /* Translators: This is an error you get if there is
+ * already an operation running against this stream when
+ * you try to start one */
+ _("Stream has outstanding operation"));
+ return FALSE;
+ }
+
+ stream->priv->pending = TRUE;
+ return TRUE;
+}
+
+/**
+ * g_output_stream_clear_pending:
+ * @stream: output stream
*
- * Sets the @stream as having pending actions if @pending is %TRUE.
+ * Clears the pending flag on @stream.
**/
void
-g_output_stream_set_pending (GOutputStream *stream,
- gboolean pending)
+g_output_stream_clear_pending (GOutputStream *stream)
{
g_return_if_fail (G_IS_OUTPUT_STREAM (stream));
- stream->priv->pending = pending;
+ stream->priv->pending = FALSE;
}
static void
write_async_thread (GSimpleAsyncResult *res,
- GObject *object,
- GCancellable *cancellable)
+ GObject *object,
+ GCancellable *cancellable)
{
WriteData *op;
GOutputStreamClass *class;
class = G_OUTPUT_STREAM_GET_CLASS (object);
op = g_simple_async_result_get_op_res_gpointer (res);
- op->count_written = class->write (G_OUTPUT_STREAM (object), op->buffer, op->count_requested,
- cancellable, &error);
+ op->count_written = class->write_fn (G_OUTPUT_STREAM (object), op->buffer, op->count_requested,
+ cancellable, &error);
if (op->count_written == -1)
{
g_simple_async_result_set_from_error (res, error);
static void
g_output_stream_real_write_async (GOutputStream *stream,
- const void *buffer,
- gsize count,
- int io_priority,
- GCancellable *cancellable,
- GAsyncReadyCallback callback,
- gpointer user_data)
+ const void *buffer,
+ gsize count,
+ int io_priority,
+ GCancellable *cancellable,
+ GAsyncReadyCallback callback,
+ gpointer user_data)
{
GSimpleAsyncResult *res;
WriteData *op;
}
static gssize
-g_output_stream_real_write_finish (GOutputStream *stream,
- GAsyncResult *result,
- GError **error)
+g_output_stream_real_write_finish (GOutputStream *stream,
+ GAsyncResult *result,
+ GError **error)
{
GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
WriteData *op;
- g_assert (g_simple_async_result_get_source_tag (simple) == g_output_stream_real_write_async);
+ g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_output_stream_real_write_async);
op = g_simple_async_result_get_op_res_gpointer (simple);
return op->count_written;
}
static void
splice_async_thread (GSimpleAsyncResult *result,
- GObject *object,
- GCancellable *cancellable)
+ GObject *object,
+ GCancellable *cancellable)
{
SpliceData *op;
GOutputStreamClass *class;
class = G_OUTPUT_STREAM_GET_CLASS (object);
op = g_simple_async_result_get_op_res_gpointer (result);
- stream->priv->pending = FALSE;
- op->bytes_copied =
- g_output_stream_splice (stream,
- op->source,
- op->flags,
- cancellable,
- &error);
- stream->priv->pending = TRUE;
-
+ op->bytes_copied = class->splice (stream,
+ op->source,
+ op->flags,
+ cancellable,
+ &error);
if (op->bytes_copied == -1)
{
g_simple_async_result_set_from_error (result, error);
}
static void
-g_output_stream_real_splice_async (GOutputStream *stream,
- GInputStream *source,
- GOutputStreamSpliceFlags flags,
- int io_priority,
- GCancellable *cancellable,
- GAsyncReadyCallback callback,
- gpointer user_data)
+g_output_stream_real_splice_async (GOutputStream *stream,
+ GInputStream *source,
+ GOutputStreamSpliceFlags flags,
+ int io_priority,
+ GCancellable *cancellable,
+ GAsyncReadyCallback callback,
+ gpointer user_data)
{
GSimpleAsyncResult *res;
SpliceData *op;
}
static gssize
-g_output_stream_real_splice_finish (GOutputStream *stream,
- GAsyncResult *result,
- GError **error)
+g_output_stream_real_splice_finish (GOutputStream *stream,
+ GAsyncResult *result,
+ GError **error)
{
GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
SpliceData *op;
- g_assert (g_simple_async_result_get_source_tag (simple) == g_output_stream_real_splice_async);
+ g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_output_stream_real_splice_async);
op = g_simple_async_result_get_op_res_gpointer (simple);
return op->bytes_copied;
}
-
static void
flush_async_thread (GSimpleAsyncResult *res,
- GObject *object,
- GCancellable *cancellable)
+ GObject *object,
+ GCancellable *cancellable)
{
GOutputStreamClass *class;
gboolean result;
static void
g_output_stream_real_flush_async (GOutputStream *stream,
- int io_priority,
- GCancellable *cancellable,
- GAsyncReadyCallback callback,
- gpointer user_data)
+ int io_priority,
+ GCancellable *cancellable,
+ GAsyncReadyCallback callback,
+ gpointer user_data)
{
GSimpleAsyncResult *res;
}
static gboolean
-g_output_stream_real_flush_finish (GOutputStream *stream,
- GAsyncResult *result,
- GError **error)
+g_output_stream_real_flush_finish (GOutputStream *stream,
+ GAsyncResult *result,
+ GError **error)
{
return TRUE;
}
static void
close_async_thread (GSimpleAsyncResult *res,
- GObject *object,
- GCancellable *cancellable)
+ GObject *object,
+ GCancellable *cancellable)
{
GOutputStreamClass *class;
GError *error = NULL;
- gboolean result;
+ gboolean result = TRUE;
+
+ class = G_OUTPUT_STREAM_GET_CLASS (object);
+
+ /* Do a flush here if there is a flush function, and we did not have to do
+ an async flush before (see g_output_stream_close_async) */
+ if (class->flush != NULL &&
+ (class->flush_async == NULL ||
+ class->flush_async == g_output_stream_real_flush_async))
+ {
+ result = class->flush (G_OUTPUT_STREAM (object), cancellable, &error);
+ }
/* Auto handling of cancelation disabled, and ignore
cancellation, since we want to close things anyway, although
possibly in a quick-n-dirty way. At least we never want to leak
open handles */
- class = G_OUTPUT_STREAM_GET_CLASS (object);
- result = class->close (G_OUTPUT_STREAM (object), cancellable, &error);
- if (!result)
+ if (class->close_fn)
{
- g_simple_async_result_set_from_error (res, error);
- g_error_free (error);
+ /* Make sure to close, even if the flush failed (see sync close) */
+ if (!result)
+ class->close_fn (G_OUTPUT_STREAM (object), cancellable, NULL);
+ else
+ result = class->close_fn (G_OUTPUT_STREAM (object), cancellable, &error);
+
+ if (!result)
+ {
+ g_simple_async_result_set_from_error (res, error);
+ g_error_free (error);
+ }
}
}
static void
-g_output_stream_real_close_async (GOutputStream *stream,
- int io_priority,
- GCancellable *cancellable,
- GAsyncReadyCallback callback,
- gpointer user_data)
+g_output_stream_real_close_async (GOutputStream *stream,
+ int io_priority,
+ GCancellable *cancellable,
+ GAsyncReadyCallback callback,
+ gpointer user_data)
{
GSimpleAsyncResult *res;
}
static gboolean
-g_output_stream_real_close_finish (GOutputStream *stream,
- GAsyncResult *result,
- GError **error)
+g_output_stream_real_close_finish (GOutputStream *stream,
+ GAsyncResult *result,
+ GError **error)
{
GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
- g_assert (g_simple_async_result_get_source_tag (simple) == g_output_stream_real_close_async);
+ g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_output_stream_real_close_async);
return TRUE;
}
projects / platform / upstream / glib.git / blobdiff