* Copyright © 2008 codethink
* Copyright © 2009 Red Hat, Inc.
*
+ * SPDX-License-Identifier: LGPL-2.1-or-later
+ *
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
- * version 2 of the License, or (at your option) any later version.
+ * version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
- * Public License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
*
* Authors: Ryan Lortie <desrt@desrt.ca>
* Alexander Larsson <alexl@redhat.com>
#include "glibintl.h"
#include "giostream.h"
-#include <gio/gsimpleasyncresult.h>
-#include <gio/gasyncresult.h>
-
-
-G_DEFINE_TYPE (GIOStream, g_io_stream, G_TYPE_OBJECT);
+#include "gasyncresult.h"
+#include "gioprivate.h"
+#include "gtask.h"
/**
* SECTION:giostream
* @see_also: #GInputStream, #GOutputStream
*
* GIOStream represents an object that has both read and write streams.
- * Generally the two streams acts as separate input and output streams,
+ * Generally the two streams act as separate input and output streams,
* but they share some common resources and state. For instance, for
- * seekable streams they may use the same position in both streams.
+ * seekable streams, both streams may use the same position.
*
- * Examples of #GIOStream objects are #GSocketConnection which represents
- * a two-way network connection, and #GFileIOStream which represent a
+ * Examples of #GIOStream objects are #GSocketConnection, which represents
+ * a two-way network connection; and #GFileIOStream, which represents a
* file handle opened in read-write mode.
*
* To do the actual reading and writing you need to get the substreams
* The #GIOStream object owns the input and the output streams, not the other
* way around, so keeping the substreams alive will not keep the #GIOStream
* object alive. If the #GIOStream object is freed it will be closed, thus
- * closing the substream, so even if the substreams stay alive they will
- * always just return a %G_IO_ERROR_CLOSED for all operations.
+ * closing the substreams, so even if the substreams stay alive they will
+ * always return %G_IO_ERROR_CLOSED for all operations.
*
* To close a stream use g_io_stream_close() which will close the common
* stream object and also the individual substreams. You can also close
* the substreams themselves. In most cases this only marks the
- * substream as closed, so further I/O on it fails. However, some streams
- * may support "half-closed" states where one direction of the stream
- * is actually shut down.
+ * substream as closed, so further I/O on it fails but common state in the
+ * #GIOStream may still be open. However, some streams may support
+ * "half-closed" states where one direction of the stream is actually shut down.
+ *
+ * Operations on #GIOStreams cannot be started while another operation on the
+ * #GIOStream or its substreams is in progress. Specifically, an application can
+ * read from the #GInputStream and write to the #GOutputStream simultaneously
+ * (either in separate threads, or as asynchronous operations in the same
+ * thread), but an application cannot start any #GIOStream operation while there
+ * is a #GIOStream, #GInputStream or #GOutputStream operation in progress, and
+ * an application can’t start any #GInputStream or #GOutputStream operation
+ * while there is a #GIOStream operation in progress.
+ *
+ * This is a product of individual stream operations being associated with a
+ * given #GMainContext (the thread-default context at the time the operation was
+ * started), rather than entire streams being associated with a single
+ * #GMainContext.
+ *
+ * GIO may run operations on #GIOStreams from other (worker) threads, and this
+ * may be exposed to application code in the behaviour of wrapper streams, such
+ * as #GBufferedInputStream or #GTlsConnection. With such wrapper APIs,
+ * application code may only run operations on the base (wrapped) stream when
+ * the wrapper stream is idle. Note that the semantics of such operations may
+ * not be well-defined due to the state the wrapper stream leaves the base
+ * stream in (though they are guaranteed not to crash).
*
* Since: 2.22
*/
struct _GIOStreamPrivate {
guint closed : 1;
guint pending : 1;
- GAsyncReadyCallback outstanding_callback;
};
static gboolean g_io_stream_real_close (GIOStream *stream,
GAsyncResult *result,
GError **error);
-static void
-g_io_stream_finalize (GObject *object)
-{
- G_OBJECT_CLASS (g_io_stream_parent_class)->finalize (object);
-}
+G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (GIOStream, g_io_stream, G_TYPE_OBJECT)
static void
g_io_stream_dispose (GObject *object)
static void
g_io_stream_init (GIOStream *stream)
{
- stream->priv = G_TYPE_INSTANCE_GET_PRIVATE (stream,
- G_TYPE_IO_STREAM,
- GIOStreamPrivate);
+ stream->priv = g_io_stream_get_instance_private (stream);
}
static void
}
static void
-g_io_stream_set_property (GObject *object,
- guint prop_id,
- const GValue *value,
- GParamSpec *pspec)
-{
- switch (prop_id)
- {
- default:
- G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
- }
-}
-
-static void
g_io_stream_class_init (GIOStreamClass *klass)
{
GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
- g_type_class_add_private (klass, sizeof (GIOStreamPrivate));
-
- gobject_class->finalize = g_io_stream_finalize;
gobject_class->dispose = g_io_stream_dispose;
- gobject_class->set_property = g_io_stream_set_property;
gobject_class->get_property = g_io_stream_get_property;
klass->close_fn = g_io_stream_real_close;
P_("Closed"),
P_("Is the stream closed"),
FALSE,
- G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
+ G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
g_object_class_install_property (gobject_class, PROP_INPUT_STREAM,
g_param_spec_object ("input-stream",
* Gets the input stream for this object. This is used
* for reading.
*
- * Returns: a #GInputStream, owned by the #GIOStream. Do not free.
+ * Returns: (transfer none): a #GInputStream, owned by the #GIOStream.
+ * Do not free.
*
* Since: 2.22
*/
* Gets the output stream for this object. This is used for
* writing.
*
- * Returns: a #GOutputStream, owned by the #GIOStream. Do not free.
+ * Returns: (transfer none): a #GOutputStream, owned by the #GIOStream.
+ * Do not free.
*
* Since: 2.22
*/
/**
* g_io_stream_set_pending:
* @stream: a #GIOStream
- * @error: a #GError location to store the error occuring, or %NULL to
+ * @error: a #GError location to store the error occurring, 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.
+ * Returns: %TRUE if pending was previously unset and is now set.
*
* Since: 2.22
*/
/**
* g_io_stream_close:
* @stream: a #GIOStream
- * @cancellable: optional #GCancellable object, %NULL to ignore
- * @error: location to store the error occuring, or %NULL to ignore
+ * @cancellable: (nullable): optional #GCancellable object, %NULL to ignore
+ * @error: location to store the error occurring, or %NULL to ignore
*
* Closes the stream, releasing resources related to it. This will also
- * closes the individual input and output streams, if they are not already
+ * close the individual input and output streams, if they are not already
* closed.
*
* Once the stream is closed, all other operations will return
* The default implementation of this method just calls close on the
* individual input/output streams.
*
- * Return value: %TRUE on success, %FALSE on failure
+ * Returns: %TRUE on success, %FALSE on failure
*
* Since: 2.22
*/
gpointer user_data)
{
GIOStream *stream = G_IO_STREAM (source_object);
+ GIOStreamClass *klass = G_IO_STREAM_GET_CLASS (stream);
+ GTask *task = user_data;
+ GError *error = NULL;
+ gboolean success;
stream->priv->closed = TRUE;
g_io_stream_clear_pending (stream);
- if (stream->priv->outstanding_callback)
- (*stream->priv->outstanding_callback) (source_object, res, user_data);
- g_object_unref (stream);
+
+ if (g_async_result_legacy_propagate_error (res, &error))
+ success = FALSE;
+ else
+ success = klass->close_finish (stream, res, &error);
+
+ if (error)
+ g_task_return_error (task, error);
+ else
+ g_task_return_boolean (task, success);
+
+ g_object_unref (task);
}
/**
* g_io_stream_close_async:
* @stream: a #GIOStream
* @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
+ * @cancellable: (nullable): optional cancellable object
+ * @callback: (scope async): callback to call when the request is satisfied
+ * @user_data: (closure): the data to pass to callback function
*
* Requests an asynchronous close of the stream, releasing resources
* related to it. When the operation is finished @callback will be
gpointer user_data)
{
GIOStreamClass *class;
- GSimpleAsyncResult *simple;
GError *error = NULL;
+ GTask *task;
g_return_if_fail (G_IS_IO_STREAM (stream));
+ task = g_task_new (stream, cancellable, callback, user_data);
+ g_task_set_source_tag (task, g_io_stream_close_async);
+
if (stream->priv->closed)
{
- simple = g_simple_async_result_new (G_OBJECT (stream),
- callback,
- user_data,
- g_io_stream_close_async);
- g_simple_async_result_complete_in_idle (simple);
- g_object_unref (simple);
+ g_task_return_boolean (task, TRUE);
+ g_object_unref (task);
return;
}
if (!g_io_stream_set_pending (stream, &error))
{
- g_simple_async_report_gerror_in_idle (G_OBJECT (stream),
- callback,
- user_data,
- error);
- g_error_free (error);
+ g_task_return_error (task, error);
+ g_object_unref (task);
return;
}
class = G_IO_STREAM_GET_CLASS (stream);
- stream->priv->outstanding_callback = callback;
- g_object_ref (stream);
+
class->close_async (stream, io_priority, cancellable,
- async_ready_close_callback_wrapper, user_data);
+ async_ready_close_callback_wrapper, task);
}
/**
* g_io_stream_close_finish:
* @stream: a #GIOStream
* @result: a #GAsyncResult
- * @error: a #GError location to store the error occuring, or %NULL to
+ * @error: a #GError location to store the error occurring, or %NULL to
* ignore
*
* Closes a stream.
GAsyncResult *result,
GError **error)
{
- GSimpleAsyncResult *simple;
- GIOStreamClass *class;
-
g_return_val_if_fail (G_IS_IO_STREAM (stream), FALSE);
- g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
-
- if (G_IS_SIMPLE_ASYNC_RESULT (result))
- {
- simple = G_SIMPLE_ASYNC_RESULT (result);
- if (g_simple_async_result_propagate_error (simple, error))
- return FALSE;
+ g_return_val_if_fail (g_task_is_valid (result, stream), FALSE);
- /* Special case already closed */
- if (g_simple_async_result_get_source_tag (simple) == g_io_stream_close_async)
- return TRUE;
- }
-
- class = G_IO_STREAM_GET_CLASS (stream);
- return class->close_finish (stream, result, error);
+ return g_task_propagate_boolean (G_TASK (result), error);
}
static void
-close_async_thread (GSimpleAsyncResult *res,
- GObject *object,
- GCancellable *cancellable)
+close_async_thread (GTask *task,
+ gpointer source_object,
+ gpointer task_data,
+ GCancellable *cancellable)
{
+ GIOStream *stream = source_object;
GIOStreamClass *class;
GError *error = NULL;
gboolean result;
- /* 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_IO_STREAM_GET_CLASS (object);
+ class = G_IO_STREAM_GET_CLASS (stream);
if (class->close_fn)
{
- result = class->close_fn (G_IO_STREAM (object), cancellable, &error);
+ result = class->close_fn (stream,
+ g_task_get_cancellable (task),
+ &error);
if (!result)
- {
- g_simple_async_result_set_from_error (res, error);
- g_error_free (error);
- }
+ {
+ g_task_return_error (task, error);
+ return;
+ }
+ }
+
+ g_task_return_boolean (task, TRUE);
+}
+
+typedef struct
+{
+ GError *error;
+ gint pending;
+} CloseAsyncData;
+
+static void
+stream_close_complete (GObject *source,
+ GAsyncResult *result,
+ gpointer user_data)
+{
+ GTask *task = user_data;
+ CloseAsyncData *data;
+
+ data = g_task_get_task_data (task);
+ data->pending--;
+
+ if (G_IS_OUTPUT_STREAM (source))
+ {
+ GError *error = NULL;
+
+ /* Match behaviour with the sync route and give precedent to the
+ * error returned from closing the output stream.
+ */
+ g_output_stream_close_finish (G_OUTPUT_STREAM (source), result, &error);
+ if (error)
+ {
+ if (data->error)
+ g_error_free (data->error);
+ data->error = error;
+ }
+ }
+ else
+ g_input_stream_close_finish (G_INPUT_STREAM (source), result, data->error ? NULL : &data->error);
+
+ if (data->pending == 0)
+ {
+ if (data->error)
+ g_task_return_error (task, data->error);
+ else
+ g_task_return_boolean (task, TRUE);
+
+ g_slice_free (CloseAsyncData, data);
+ g_object_unref (task);
}
}
GAsyncReadyCallback callback,
gpointer user_data)
{
- GSimpleAsyncResult *res;
+ GInputStream *input;
+ GOutputStream *output;
+ GTask *task;
- res = g_simple_async_result_new (G_OBJECT (stream),
- callback,
- user_data,
- g_io_stream_real_close_async);
+ task = g_task_new (stream, cancellable, callback, user_data);
+ g_task_set_source_tag (task, g_io_stream_real_close_async);
+ g_task_set_check_cancellable (task, FALSE);
+ g_task_set_priority (task, io_priority);
- g_simple_async_result_set_handle_cancellation (res, FALSE);
+ input = g_io_stream_get_input_stream (stream);
+ output = g_io_stream_get_output_stream (stream);
- g_simple_async_result_run_in_thread (res,
- close_async_thread,
- io_priority,
- cancellable);
- g_object_unref (res);
+ if (g_input_stream_async_close_is_via_threads (input) && g_output_stream_async_close_is_via_threads (output))
+ {
+ /* No sense in dispatching to the thread twice -- just do it all
+ * in one go.
+ */
+ g_task_run_in_thread (task, close_async_thread);
+ g_object_unref (task);
+ }
+ else
+ {
+ CloseAsyncData *data;
+
+ /* We should avoid dispatching to another thread in case either
+ * object that would not do it for itself because it may not be
+ * threadsafe.
+ */
+ data = g_slice_new (CloseAsyncData);
+ data->error = NULL;
+ data->pending = 2;
+
+ g_task_set_task_data (task, data, NULL);
+ g_input_stream_close_async (input, io_priority, cancellable, stream_close_complete, task);
+ g_output_stream_close_async (output, io_priority, cancellable, stream_close_complete, task);
+ }
}
static gboolean
GAsyncResult *result,
GError **error)
{
- GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
- g_warn_if_fail (g_simple_async_result_get_source_tag (simple) ==
- g_io_stream_real_close_async);
- return TRUE;
+ g_return_val_if_fail (g_task_is_valid (result, stream), FALSE);
+
+ return g_task_propagate_boolean (G_TASK (result), error);
+}
+
+typedef struct
+{
+ GIOStream *stream1;
+ GIOStream *stream2;
+ GIOStreamSpliceFlags flags;
+ gint io_priority;
+ GCancellable *cancellable;
+ gulong cancelled_id;
+ GCancellable *op1_cancellable;
+ GCancellable *op2_cancellable;
+ guint completed;
+ GError *error;
+} SpliceContext;
+
+static void
+splice_context_free (SpliceContext *ctx)
+{
+ g_object_unref (ctx->stream1);
+ g_object_unref (ctx->stream2);
+ if (ctx->cancellable != NULL)
+ g_object_unref (ctx->cancellable);
+ g_object_unref (ctx->op1_cancellable);
+ g_object_unref (ctx->op2_cancellable);
+ g_clear_error (&ctx->error);
+ g_slice_free (SpliceContext, ctx);
+}
+
+static void
+splice_complete (GTask *task,
+ SpliceContext *ctx)
+{
+ if (ctx->cancelled_id != 0)
+ g_cancellable_disconnect (ctx->cancellable, ctx->cancelled_id);
+ ctx->cancelled_id = 0;
+
+ if (ctx->error != NULL)
+ {
+ g_task_return_error (task, ctx->error);
+ ctx->error = NULL;
+ }
+ else
+ g_task_return_boolean (task, TRUE);
+}
+
+static void
+splice_close_cb (GObject *iostream,
+ GAsyncResult *res,
+ gpointer user_data)
+{
+ GTask *task = user_data;
+ SpliceContext *ctx = g_task_get_task_data (task);
+ GError *error = NULL;
+
+ g_io_stream_close_finish (G_IO_STREAM (iostream), res, &error);
+
+ ctx->completed++;
+
+ /* Keep the first error that occurred */
+ if (error != NULL && ctx->error == NULL)
+ ctx->error = error;
+ else
+ g_clear_error (&error);
+
+ /* If all operations are done, complete now */
+ if (ctx->completed == 4)
+ splice_complete (task, ctx);
+
+ g_object_unref (task);
+}
+
+static void
+splice_cb (GObject *ostream,
+ GAsyncResult *res,
+ gpointer user_data)
+{
+ GTask *task = user_data;
+ SpliceContext *ctx = g_task_get_task_data (task);
+ GError *error = NULL;
+
+ g_output_stream_splice_finish (G_OUTPUT_STREAM (ostream), res, &error);
+
+ ctx->completed++;
+
+ /* ignore cancellation error if it was not requested by the user */
+ if (error != NULL &&
+ g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED) &&
+ (ctx->cancellable == NULL ||
+ !g_cancellable_is_cancelled (ctx->cancellable)))
+ g_clear_error (&error);
+
+ /* Keep the first error that occurred */
+ if (error != NULL && ctx->error == NULL)
+ ctx->error = error;
+ else
+ g_clear_error (&error);
+
+ if (ctx->completed == 1 &&
+ (ctx->flags & G_IO_STREAM_SPLICE_WAIT_FOR_BOTH) == 0)
+ {
+ /* We don't want to wait for the 2nd operation to finish, cancel it */
+ g_cancellable_cancel (ctx->op1_cancellable);
+ g_cancellable_cancel (ctx->op2_cancellable);
+ }
+ else if (ctx->completed == 2)
+ {
+ if (ctx->cancellable == NULL ||
+ !g_cancellable_is_cancelled (ctx->cancellable))
+ {
+ g_cancellable_reset (ctx->op1_cancellable);
+ g_cancellable_reset (ctx->op2_cancellable);
+ }
+
+ /* Close the IO streams if needed */
+ if ((ctx->flags & G_IO_STREAM_SPLICE_CLOSE_STREAM1) != 0)
+ {
+ g_io_stream_close_async (ctx->stream1,
+ g_task_get_priority (task),
+ ctx->op1_cancellable,
+ splice_close_cb, g_object_ref (task));
+ }
+ else
+ ctx->completed++;
+
+ if ((ctx->flags & G_IO_STREAM_SPLICE_CLOSE_STREAM2) != 0)
+ {
+ g_io_stream_close_async (ctx->stream2,
+ g_task_get_priority (task),
+ ctx->op2_cancellable,
+ splice_close_cb, g_object_ref (task));
+ }
+ else
+ ctx->completed++;
+
+ /* If all operations are done, complete now */
+ if (ctx->completed == 4)
+ splice_complete (task, ctx);
+ }
+
+ g_object_unref (task);
+}
+
+static void
+splice_cancelled_cb (GCancellable *cancellable,
+ GTask *task)
+{
+ SpliceContext *ctx;
+
+ ctx = g_task_get_task_data (task);
+ g_cancellable_cancel (ctx->op1_cancellable);
+ g_cancellable_cancel (ctx->op2_cancellable);
+}
+
+/**
+ * g_io_stream_splice_async:
+ * @stream1: a #GIOStream.
+ * @stream2: a #GIOStream.
+ * @flags: a set of #GIOStreamSpliceFlags.
+ * @io_priority: the io priority of the request.
+ * @cancellable: (nullable): optional #GCancellable object, %NULL to ignore.
+ * @callback: (scope async): a #GAsyncReadyCallback.
+ * @user_data: (closure): user data passed to @callback.
+ *
+ * Asynchronously splice the output stream of @stream1 to the input stream of
+ * @stream2, and splice the output stream of @stream2 to the input stream of
+ * @stream1.
+ *
+ * When the operation is finished @callback will be called.
+ * You can then call g_io_stream_splice_finish() to get the
+ * result of the operation.
+ *
+ * Since: 2.28
+ **/
+void
+g_io_stream_splice_async (GIOStream *stream1,
+ GIOStream *stream2,
+ GIOStreamSpliceFlags flags,
+ gint io_priority,
+ GCancellable *cancellable,
+ GAsyncReadyCallback callback,
+ gpointer user_data)
+{
+ GTask *task;
+ SpliceContext *ctx;
+ GInputStream *istream;
+ GOutputStream *ostream;
+
+ if (cancellable != NULL && g_cancellable_is_cancelled (cancellable))
+ {
+ g_task_report_new_error (NULL, callback, user_data,
+ g_io_stream_splice_async,
+ G_IO_ERROR, G_IO_ERROR_CANCELLED,
+ "Operation has been cancelled");
+ return;
+ }
+
+ ctx = g_slice_new0 (SpliceContext);
+ ctx->stream1 = g_object_ref (stream1);
+ ctx->stream2 = g_object_ref (stream2);
+ ctx->flags = flags;
+ ctx->op1_cancellable = g_cancellable_new ();
+ ctx->op2_cancellable = g_cancellable_new ();
+ ctx->completed = 0;
+
+ task = g_task_new (NULL, cancellable, callback, user_data);
+ g_task_set_source_tag (task, g_io_stream_splice_async);
+ g_task_set_task_data (task, ctx, (GDestroyNotify) splice_context_free);
+
+ if (cancellable != NULL)
+ {
+ ctx->cancellable = g_object_ref (cancellable);
+ ctx->cancelled_id = g_cancellable_connect (cancellable,
+ G_CALLBACK (splice_cancelled_cb), g_object_ref (task),
+ g_object_unref);
+ }
+
+ istream = g_io_stream_get_input_stream (stream1);
+ ostream = g_io_stream_get_output_stream (stream2);
+ g_output_stream_splice_async (ostream, istream, G_OUTPUT_STREAM_SPLICE_NONE,
+ io_priority, ctx->op1_cancellable, splice_cb,
+ g_object_ref (task));
+
+ istream = g_io_stream_get_input_stream (stream2);
+ ostream = g_io_stream_get_output_stream (stream1);
+ g_output_stream_splice_async (ostream, istream, G_OUTPUT_STREAM_SPLICE_NONE,
+ io_priority, ctx->op2_cancellable, splice_cb,
+ g_object_ref (task));
+
+ g_object_unref (task);
+}
+
+/**
+ * g_io_stream_splice_finish:
+ * @result: a #GAsyncResult.
+ * @error: a #GError location to store the error occurring, or %NULL to
+ * ignore.
+ *
+ * Finishes an asynchronous io stream splice operation.
+ *
+ * Returns: %TRUE on success, %FALSE otherwise.
+ *
+ * Since: 2.28
+ **/
+gboolean
+g_io_stream_splice_finish (GAsyncResult *result,
+ GError **error)
+{
+ g_return_val_if_fail (g_task_is_valid (result, NULL), FALSE);
+
+ return g_task_propagate_boolean (G_TASK (result), error);
}
projects / platform / upstream / glib.git / blobdiff