Philip Withnall
philip.withnall@collabora.co.uk 2015

This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.

As a special exception, the copyright holders give you permission to copy, modify, and distribute the example code contained in this document under the terms of your choosing, without restriction.

Uso de métodos asíncronos al estilo de GLib en varias situaciones
Daniel Mustieles
daniel.mustieles@gmail.com 2016-2020
Javier Mazorra
mazi.debian@gmail.com 2016, 2020

# Programación asíncrona

#

        Resumen

          Uso de llamadas asíncronas con preferencia a las llamadas síncronas o uso explícito de hilos ()
          Aprenda y siga el patrón de GLib para declarar API asíncronas ()
          Coloque el retorno de llamadas de funciones asíncronas en orden descendente del archivo para que el control del flujo sea fácil de seguir ()
          Use la presencia de un GTask o GCancellable para indicar si una operación está en curso (, )
          Si ejecuta operaciones en paralelo, realice un seguimiento de cuántas operaciones aún deben comenzar y cuántas aún deben finalizar — la operación global se completa una vez que ambos recuentos son cero ()
          Separe el estado de las operaciones en estructuras ‘task data’ para GTasks, permitiendo que se reutilicen las operaciones más fácilmente sin necesidad de cambios en la gestión del estado global ()
          Considere cómo los métodos asíncronos en una instancia de un objeto interactúan con la finalización de esa instancia ()

# Conceptos

GLib soporta programación asíncrona, donde se pueden iniciar operaciones de larga duración, ejecutarlas ‘en segundo plano’, e invocar un retorno de función cuando se completan y sus resultados están disponibles. Esto está en contraste directo con las operaciones de larga duración asíncronas, que son una única llamada de función que bloquea el control de flujo del programa hasta que se completa.

Como se discutió en y , las operaciones asíncronas deberían ser favorecidas sobre las síncronas y sobre el uso explícito de hilos. No bloquean el contexto principal como las operaciones síncronas y son más fáciles de utilizar correctamente que los hilos. Frecuentemente tienen una menor penalización en el rendimiento que generar un hilo y enviarle trabajo.

# Patrón API

Las llamadas asíncronas siguen un patrón estándar en código GLib. Para una operación llamada `load_data` en la clase `File` en el espacio de nombres `Foo`, habrá:

foo_file_load_data_async (FooFile *self, …, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data)
foo_file_load_data_finish (FooFile *self, GAsyncResult *result, …, GError **error)

Los parámetros `…` para `foo_file_load_data_async()` son los específicos para la operación, en este caso, quizá el tamaño de un búfer para cargar. De manera similar para `foo_file_load_data_finish()` son los valores de retorno específicos de la operación, quizá una ubicación para devolver una cadena de tipo de contenido en este caso.

Cuando se llama a `foo_file_load_data_async()`, planifica la carga de la operación en segundo plano (como un nuevo descriptor de un archivo en el `GMainContext` o como un nuevo hilo activo, por ejemplo), después vuelve sin bloquear.

Cuando se completa la operación, el `retorno de función` se ejecuta en el mismo `GMainContext` que la llamada asíncrona original. El retorno de función se invoca exactamente una vez, tanto si la operación concluyó con éxito como si concluyó con error.

Desde el retorno de llamada `foo_file_data_finish()` se puede llamar por el código del usuario para obtener valores de retorno y detalles de error, pasando la instancia `GAsyncResult` que se pasó al retorno de llamada.

# Tiempos de vida de la operación

Al escribir operaciones asíncronas, es común escribirlas como métodos de una clase. En este caso, es importante definir cómo las operaciones en curso en una instancia de clase interactúan con la finalización de esa instancia. Hay dos enfoques:

## Fuerte

La operación en curso mantiene una referencia a la instancia de clase, forzándola a permanecer viva mientras dure la operación. La clase debe proporcionar algún tipo de método de «cierre» o «cancelación» que otras clases puedan utilizar para forzar la cancelación de la operación y permitir que se finalice esa instancia.

## Débil

La operación en curso no mantiene una referencia a la instancia de la clase, y la clase cancela la operación (usando `g_cancellable_cancel()`) en su función de disposición.

Which approach is used depends on the class’ design. A class which wraps a particular operation (perhaps a `MyFileTransfer` class, for example) might want to use the weak approach. A class which manages multiple network connections and asynchronous operations on them may use the strong approach instead. Due to incoming network connections, for example, it might not be in complete control of the scheduling of its asynchronous calls, so the weak approach would not be appropriate — any code dropping a reference to the object could not be sure it was not accidentally killing a new network connection.

# Ejemplos de uso de funciones asíncronas

It is often the case that multiple asynchronous calls need to be used to complete an operation. For example, opening a file for reading, then performing a couple of reads, and then closing the file. Or opening several network sockets in parallel and waiting until they are all open before continuing with other work. Some examples of these situations are given below.

## Operación individual

Una sola llamada asincrónica requiere dos funciones: una para iniciar la operación y otra para completarla. En C, la parte exigente de ejecarut una llamada asíncrona es almacenar correctamente el estado entre estas dos funciones y manejar los cambios a ese estado en el tiempo entre esas dos funciones que se están llamando. Por ejemplo, la cancelación de una llamada asíncrona en curso es un cambio de estado, y si no se implementa con cuidado, algunas actualizaciones de la IU (por ejemplo) realizadas al cancelar una operación serán deshechas por las actualizaciones en el retorno de llamada de la operación.

Este ejemplo muestra cómo copiar un archivo de una ubicación en el sistema de archivos a otra. Los principios clave demostrados aquí son:

Placing the `copy_button_clicked_cb()` (start) and `copy_finish_cb()` (finish) functions in order by using a forward declaration for `copy_finish_cb()`. This means the control flow continues linearly down the file, rather than getting to the bottom of `copy_button_clicked_cb()` and resuming in `copy_finish_cb()` somewhere else in the file.

Use of a `GCancellable` to allow cancelling the operation after it has started. The code in `cancel_button_clicked_cb()` is very simple: as the `copy_finish_cb()` callback is guaranteed to be invoked when the operation completes (even when completing early due to cancellation), all the UI and state updates for cancellation can be handled there, rather than in `cancel_button_clicked_cb()`.

An operation is ongoing exactly while `MyObjectPrivate.copy_cancellable` is non-`NULL`, making it easy to track running operations. Note that this means only one file copy operation can be started via `copy_button_clicked_cb()` at a time. One `GCancellable` cannot easily be used for multiple operations like this.

static void copy_finish_cb (GObject *source_object, GAsyncResult *result, gpointer user_data);

static void copy_button_clicked_cb (GtkButton *button gpointer user_data) { MyObjectPrivate *priv; GFile *source = NULL, *destination = NULL; /* owned */

priv = my_object_get_instance_private (MY_OBJECT (user_data));

/* Operation already in progress? */ if (priv->copy_cancellable != NULL) { g_debug ("Copy already in progress."); return; }

/* Build source and destination file paths. */ source = g_file_new_for_path (/* some path generated from UI */); destination = g_file_new_for_path (/* some other path generated from UI */);

/* Set up a cancellable. */ priv->copy_cancellable = g_cancellable_new ();

g_file_copy_async (source, destination, G_FILE_COPY_NONE, G_PRIORITY_DEFAULT, priv->copy_cancellable, NULL, NULL, copy_finish_cb, user_data);

g_object_unref (destination); g_object_unref (source);

/* Update UI to show copy is in progress. */ … }

static void copy_finish_cb (GObject *source_object, GAsyncResult *result, gpointer user_data) { MyObjectPrivate *priv; GFile *source; /* unowned */ GError *error = NULL;

source = G_FILE (source_object); priv = my_object_get_instance_private (MY_OBJECT (user_data));

/* Handle completion of the operation. */ g_file_copy_finish (source, result, &error);

if (error != NULL && !g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED)) { /* Should update the UI to signal failure. * Ignore failure due to cancellation. */ g_warning ("Failed to copy file: %s", error->message); }

g_clear_error (&error);

/* Clear the cancellable to signify the operation has finished. */ g_clear_object (&priv->copy_cancellable);

/* Update UI to show copy as complete. */ … }

static void cancel_button_clicked_cb (GtkButton *button, gpointer user_data) { MyObjectPrivate *priv; GFile *source = NULL, *destination = NULL; /* owned */

priv = my_object_get_instance_private (MY_OBJECT (user_data));

/* Operation in progress? No-op if @copy_cancellable is %NULL. */ g_cancellable_cancel (priv->copy_cancellable); }

static void my_object_dispose (GObject *obj) { MyObjectPrivate *priv;

priv = my_object_get_instance_private (MY_OBJECT (obj));

/* Cancel any ongoing copy operation. * * This ensures that if #MyObject is disposed part-way through a copy, the * callback doesn’t get invoked with an invalid #MyObject pointer. */ g_cancellable_cancel (priv->copy_cancellable);

/* Do other dispose calls here. */ …

/* Chain up. */ G_OBJECT_CLASS (my_object_parent_class)->dispose (obj); }

For comparison, here is the same code implemented using the synchronous version of `g_file_copy()`. Note how the order of statements is almost identical. Cancellation cannot be supported here, as the UI is blocked from receiving ‘click’ events on the cancellation button while the copy is ongoing, so `NULL` is passed to the `GCancellable` parameter. This is the main reason why this code should not be used in practice.

static void copy_button_clicked_cb (GtkButton *button gpointer user_data) { MyObjectPrivate *priv; GFile *source = NULL, *destination = NULL; /* owned */

priv = my_object_get_instance_private (MY_OBJECT (user_data));

/* Build source and destination file paths. */ source = g_file_new_for_path (/* some path generated from UI */); destination = g_file_new_for_path (/* some other path generated from UI */);

g_file_copy (source, destination, G_FILE_COPY_NONE, NULL /* cancellable */, NULL, NULL, &error);

g_object_unref (destination); g_object_unref (source);

/* Handle completion of the operation. */ if (error != NULL) { /* Should update the UI to signal failure. * Ignore failure due to cancellation. */ g_warning ("Failed to copy file: %s", error->message); }

g_clear_error (&error);

/* Update UI to show copy as complete. */ … }

## Operaciones en serie

Una situación común es ejecutar múltiples operaciones asincrónicas en serie, cuando cada operación depende de que se complete la anterior.

En este ejemplo, la aplicación lee una dirección de socket desde un archivo, abre una conexión a esa dirección, lee un mensaje y luego termina.

Los puntos clave en este ejemplo son:

Cada retorno de llamada es numerada consistentemente y están todas colocadas en orden en el archivo para que el código siga secuencialmente.

Como en , un único `GCancellable` indica que la serie de operaciones está en curso. Al cancelarlo se aborta toda la secuencia.

Como en , la operación pendiente se cancela si se elimina la instancia propietaria de `MyObject` para evitar que se llame a los retornos de función después con un puntero a `MyObject` no válido.

gives a version of this example wrapped in a `GTask` for convenience.

static void connect_to_server_cb1 (GObject *source_object, GAsyncResult *result, gpointer user_data); static void connect_to_server_cb2 (GObject *source_object, GAsyncResult *result, gpointer user_data); static void connect_to_server_cb3 (GObject *source_object, GAsyncResult *result, gpointer user_data);

static void connect_to_server (MyObject *self) { MyObjectPrivate *priv; GFile *address_file = NULL; /* owned */

priv = my_object_get_instance_private (self);

if (priv->connect_cancellable != NULL) { /* Already connecting. */ return; }

/* Set up a cancellable. */ priv->connect_cancellable = g_cancellable_new ();

/* Read the socket address. */ address_file = build_address_file (); g_file_load_contents_async (address_file, priv->connect_cancellable, connect_to_server_cb1, self); g_object_unref (address_file); }

static void connect_to_server_cb1 (GObject *source_object, GAsyncResult *result, gpointer user_data) { MyObject *self; MyObjectPrivate *priv; GFile *address_file; /* unowned */ gchar *address = NULL; /* owned */ gsize address_size = 0; GInetAddress *inet_address = NULL; /* owned */ GInetSocketAddress *inet_socket_address = NULL; /* owned */ guint16 port = 123; GSocketClient *socket_client = NULL; /* owned */ GError *error = NULL;

address_file = G_FILE (source_object); self = MY_OBJECT (user_data); priv = my_object_get_instance_private (self);

/* Finish loading the address. */ g_file_load_contents_finish (address_file, result, &address, &address_size, NULL, &error);

if (error != NULL) { goto done; }

/* Parse the address. */ inet_address = g_inet_address_new_from_string (address);

if (inet_address == NULL) { /* Error. */ g_set_error (&error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT, "Invalid address ‘%s’.", address); goto done; }

inet_socket_address = g_inet_socket_address_new (inet_address, port);

/* Connect to the given address. */ socket_client = g_socket_client_new ();

g_socket_client_connect_async (socket_client, G_SOCKET_CONNECTABLE (inet_socket_address), priv->connect_cancellable, connect_to_server_cb2, self);

done: if (error != NULL) { /* Stop the operation. */ if (!g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED)) { g_warning ("Failed to load server address: %s", error->message); }

g_clear_object (&priv->connect_cancellable); g_error_free (error); }

g_free (address); g_clear_object (&inet_address); g_clear_object (&inet_socket_address); g_clear_object (&socket_client); }

static void connect_to_server_cb2 (GObject *source_object, GAsyncResult *result, gpointer user_data) { MyObject *self; MyObjectPrivate *priv; GSocketClient *socket_client; /* unowned */ GSocketConnection *connection = NULL; /* owned */ GInputStream *input_stream; /* unowned */ GError *error = NULL;

socket_client = G_SOCKET_CLIENT (source_object); self = MY_OBJECT (user_data); priv = my_object_get_instance_private (self);

/* Finish connecting to the socket. */ connection = g_socket_client_connect_finish (socket_client, result, &error);

if (error != NULL) { goto done; }

/* Store a reference to the connection so it is kept open while we read from * it: #GInputStream does not keep a reference to a #GIOStream which contains * it. */ priv->connection = g_object_ref (connection);

/* Read a message from the connection. This uses a single buffer stored in * #MyObject, meaning that only one connect_to_server() operation can run at * any time. The buffer could instead be allocated dynamically if this is a * problem. */ input_stream = g_io_stream_get_input_stream (G_IO_STREAM (connection));

g_input_stream_read_async (input_stream, priv->message_buffer, sizeof (priv->message_buffer), G_PRIORITY_DEFAULT, priv->connect_cancellable, connect_to_server_cb3, self);

done: if (error != NULL) { /* Stop the operation. */ if (!g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED)) { g_warning ("Failed to connect to server: %s", error->message); }

g_clear_object (&priv->connect_cancellable); g_clear_object (&priv->connection); g_error_free (error); }

g_clear_object (&connection); }

static void connect_to_server_cb3 (GObject *source_object, GAsyncResult *result, gpointer user_data) { MyObject *self; MyObjectPrivate *priv; GInputStream *input_stream; /* unowned */ gssize len = 0; GError *error = NULL;

input_stream = G_INPUT_STREAM (source_object); self = MY_OBJECT (user_data); priv = my_object_get_instance_private (self);

/* Finish reading from the socket. */ len = g_input_stream_read_finish (input_stream, result, &error);

if (error != NULL) { goto done; }

/* Handle the message. */ g_assert_cmpint (len, >=, 0); g_assert_cmpuint ((gsize) len, <=, sizeof (priv->message_buffer));

handle_received_message (self, priv->message_buffer, len, &error);

if (error != NULL) { goto done; }

done: /* Unconditionally mark the operation as finished. * * The streams should automatically close as this * last reference is dropped. */ g_clear_object (&priv->connect_cancellable); g_clear_object (&priv->connection);

if (error != NULL) { /* Warn about the error. */ if (!g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED)) { g_warning ("Failed to read from the server: %s", error->message); }

g_error_free (error); } }

static void my_object_dispose (GObject *obj) { MyObjectPrivate *priv;

priv = my_object_get_instance_private (MY_OBJECT (obj));

/* Cancel any ongoing connection operations. * * This ensures that if #MyObject is disposed part-way through the * connect_to_server() sequence of operations, the sequence gets cancelled and * doesn’t continue with an invalid #MyObject pointer. */ g_cancellable_cancel (priv->connect_cancellable);

/* Do other dispose calls here. */ …

/* Chain up. */ G_OBJECT_CLASS (my_object_parent_class)->dispose (obj); }

## Operaciones en paralelo

Otra situación común es ejecutar múltiples operaciones asincrónicas en paralelo, considerando que la operación general se completa cuando todos sus componentes están completos.

En este ejemplo, la aplicación elimina varios archivos en paralelo.

Los puntos clave en este ejemplo son:

The number of pending asynchronous operations (ones which have started but not yet finished) is tracked as `n_deletions_pending`. The `delete_files_cb()` callback only considers the entire operation complete once this reaches zero.

`n_deletions_to_start` tracks deletion operations being started, in case `g_file_delete_async()` manages to use a fast path and complete synchronously (without blocking).

As in , all pending deletions are cancelled if the owning `MyObject` instance is disposed, to prevent callbacks being called later with an invalid `MyObject` pointer.

static void delete_files_cb (GObject *source_object, GAsyncResult *result, gpointer user_data);

static void delete_files (MyObject *self, GPtrArray/*<owned GFile*>>*/ *files) { MyObjectPrivate *priv; GFile *address_file = NULL; /* owned */

priv = my_object_get_instance_private (self);

/* Set up a cancellable if no operation is ongoing already. */ if (priv->delete_cancellable == NULL) { priv->delete_cancellable = g_cancellable_new (); priv->n_deletions_pending = 0; priv->n_deletions_total = 0; }

/* Update internal state, and temporarily set @n_deletions_to_start. This is * used in delete_files_cb() to avoid indicating the overall operation has * completed while deletions are still being started. This can happen if * g_file_delete_async() completes synchronously, for example if there’s a * non-blocking fast path for the given file system. */ priv->n_deletions_pending += files->len; priv->n_deletions_total += files->len; priv->n_deletions_to_start = files->len;

/* Update the UI to indicate the files are being deleted. */ update_ui_to_show_progress (self, priv->n_deletions_pending, priv->n_deletions_total);

/* Start all the deletion operations in parallel. They share the same * #GCancellable. */ for (i = 0; i < files->len; i++) { GFile *file = files->pdata[i];

priv->n_deletions_to_start--; g_file_delete_async (file, G_PRIORITY_DEFAULT, priv->delete_cancellable, delete_files_cb, self); } }

static void delete_files_cb (GObject *source_object, GAsyncResult *result, gpointer user_data) { MyObject *self; MyObjectPrivate *priv; GFile *file; /* unowned */ GError *error = NULL;

file = G_FILE (source_object); self = MY_OBJECT (user_data); priv = my_object_get_instance_private (self);

/* Finish deleting the file. */ g_file_delete_finish (file, result, &error);

if (error != NULL && !g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED)) { g_warning ("Error deleting file: %s", error->message); }

g_clear_error (&error);

/* Update the internal state. */ g_assert_cmpuint (priv->n_deletions_pending, >, 0); priv->n_deletions_pending--;

/* Update the UI to show progress. */ update_ui_to_show_progress (self, priv->n_deletions_pending, priv->n_deletions_total);

/* If all deletions have completed, and no more are being started, * update the UI to show completion. */ if (priv->n_deletions_pending == 0 && priv->n_deletions_to_start == 0) { update_ui_to_show_completion (self);

/* Clear the operation state. */ g_clear_object (&priv->delete_cancellable); priv->n_deletions_total = 0; } }

static void my_object_dispose (GObject *obj) { MyObjectPrivate *priv;

priv = my_object_get_instance_private (MY_OBJECT (obj));

/* Cancel any ongoing deletion operations. * * This ensures that if #MyObject is disposed part-way through the * delete_files() set of operations, the set gets cancelled and * doesn’t continue with an invalid #MyObject pointer. */ g_cancellable_cancel (priv->delete_cancellable);

/* Do other dispose calls here. */ …

/* Chain up. */ G_OBJECT_CLASS (my_object_parent_class)->dispose (obj); }

## Envoltorio con `GTask`

Often when an asynchronous operation (or set of operations) becomes more complex, it needs associated state. This is typically stored in a custom structure — but defining a new structure to store the standard callback, user data and cancellable tuple is laborious. `GTask` eases this by providing a standardized way to wrap all three, plus extra custom ‘task data’.

The use of a `GTask` can replace the use of a `GCancellable` for indicating whether an operation is ongoing.

This example is functionally the same as , but refactored to use a `GTask` to wrap the sequence of operations.

Los puntos clave en este ejemplo son:

State which was in `MyObjectPrivate` in is now in the `ConnectToServerData` closure, which is set as the ‘task data’ of the `GTask` representing the overall operation. This means it’s automatically freed after the operation returns.

Furthermore, this means that manipulations of `MyObjectPrivate` state are limited to the start and end of the sequence of operations, so reusing the task in different situations becomes easier — for example, it is now a lot easier to support running multiple such tasks in parallel.

As the `GTask` holds a reference to `MyObject`, it is impossible for the object to be disposed while the sequence of operations is ongoing, so the `my_object_dispose()` code has been removed. Instead, a `my_object_close()` method exists to allow any pending operations can be cancelled so `MyObject` can be disposed when desired.

static void connect_to_server_cb1 (GObject *source_object, GAsyncResult *result, gpointer user_data); static void connect_to_server_cb2 (GObject *source_object, GAsyncResult *result, gpointer user_data); static void connect_to_server_cb3 (GObject *source_object, GAsyncResult *result, gpointer user_data);

typedef struct { GSocketConnection *connection; /* nullable; owned */ guint8 message_buffer[128]; } ConnectToServerData;

static void connect_to_server_data_free (ConnectToServerData *data) { g_clear_object (&data->connection); }

void my_object_connect_to_server_async (MyObject *self, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data) { MyObjectPrivate *priv; GTask *task = NULL; /* owned */ ConnectToServerData *data = NULL; /* owned */ GFile *address_file = NULL; /* owned */

g_return_if_fail (MY_IS_OBJECT (self)); g_return_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable));

priv = my_object_get_instance_private (self);

if (priv->connect_task != NULL) { g_task_report_new_error (self, callback, user_data, NULL, G_IO_ERROR, G_IO_ERROR_PENDING, "Already connecting to the server."); return; }

/* Set up a cancellable. */ if (cancellable != NULL) { g_object_ref (cancellable); } else { cancellable = g_cancellable_new (); }

/* Set up the task. */ task = g_task_new (self, cancellable, callback, user_data); g_task_set_check_cancellable (task, FALSE);

data = g_malloc0 (sizeof (ConnectToServerData)); g_task_set_task_data (task, data, (GDestroyNotify) connect_to_server_data_free);

g_object_unref (cancellable);

priv->connect_task = g_object_ref (task);

/* Read the socket address. */ address_file = build_address_file (); g_file_load_contents_async (address_file, g_task_get_cancellable (task), connect_to_server_cb1, g_object_ref (task)); g_object_unref (address_file);

g_clear_object (&task); }

static void connect_to_server_cb1 (GObject *source_object, GAsyncResult *result, gpointer user_data) { MyObject *self; MyObjectPrivate *priv; GTask *task = NULL; /* owned */ GFile *address_file; /* unowned */ gchar *address = NULL; /* owned */ gsize address_size = 0; GInetAddress *inet_address = NULL; /* owned */ GInetSocketAddress *inet_socket_address = NULL; /* owned */ guint16 port = 123; GSocketClient *socket_client = NULL; /* owned */ GError *error = NULL;

address_file = G_FILE (source_object); task = G_TASK (user_data); self = g_task_get_source_object (task); priv = my_object_get_instance_private (self);

/* Finish loading the address. */ g_file_load_contents_finish (address_file, result, &address, &address_size, NULL, &error);

if (error != NULL) { goto done; }

/* Parse the address. */ inet_address = g_inet_address_new_from_string (address);

if (inet_address == NULL) { /* Error. */ g_set_error (&error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT, "Invalid address ‘%s’.", address); goto done; }

inet_socket_address = g_inet_socket_address_new (inet_address, port);

/* Connect to the given address. */ socket_client = g_socket_client_new ();

g_socket_client_connect_async (socket_client, G_SOCKET_CONNECTABLE (inet_socket_address), g_task_get_cancellable (task), connect_to_server_cb2, g_object_ref (task));

done: if (error != NULL) { /* Stop the operation and propagate the error. */ g_clear_object (&priv->connect_task); g_task_return_error (task, error); }

g_free (address); g_clear_object (&inet_address); g_clear_object (&inet_socket_address); g_clear_object (&socket_client); g_clear_object (&task); }

static void connect_to_server_cb2 (GObject *source_object, GAsyncResult *result, gpointer user_data) { MyObject *self; MyObjectPrivate *priv; GTask *task = NULL; /* owned */ ConnectToServerData *data; /* unowned */ GSocketClient *socket_client; /* unowned */ GSocketConnection *connection = NULL; /* owned */ GInputStream *input_stream; /* unowned */ GError *error = NULL;

socket_client = G_SOCKET_CLIENT (source_object); task = G_TASK (user_data); data = g_task_get_task_data (task); self = g_task_get_source_object (task); priv = my_object_get_instance_private (self);

/* Finish connecting to the socket. */ connection = g_socket_client_connect_finish (socket_client, result, &error);

if (error != NULL) { goto done; }

/* Store a reference to the connection so it is kept open while we read from * it: #GInputStream does not keep a reference to a #GIOStream which contains * it. */ data->connection = g_object_ref (connection);

/* Read a message from the connection. As the buffer is allocated as part of * the per-task @data, multiple tasks can run concurrently. */ input_stream = g_io_stream_get_input_stream (G_IO_STREAM (connection));

g_input_stream_read_async (input_stream, data->message_buffer, sizeof (data->message_buffer), G_PRIORITY_DEFAULT, g_task_get_cancellable (task), connect_to_server_cb3, g_object_ref (task));

done: if (error != NULL) { /* Stop the operation and propagate the error. */ g_clear_object (&priv->connect_task); g_task_return_error (task, error); }

g_clear_object (&connection); g_clear_object (&task); }

static void connect_to_server_cb3 (GObject *source_object, GAsyncResult *result, gpointer user_data) { MyObject *self; MyObjectPrivate *priv; GTask *task = NULL; /* owned */ ConnectToServerData *data; /* unowned */ GInputStream *input_stream; /* unowned */ gssize len = 0; GError *error = NULL;

input_stream = G_INPUT_STREAM (source_object); task = G_TASK (user_data); data = g_task_get_task_data (task); self = g_task_get_source_object (task); priv = my_object_get_instance_private (self);

/* Finish reading from the socket. */ len = g_input_stream_read_finish (input_stream, result, &error);

if (error != NULL) { goto done; }

/* Handle the message. */ g_assert_cmpint (len, >=, 0); g_assert_cmpuint ((gsize) len, <=, sizeof (data->message_buffer));

handle_received_message (self, data->message_buffer, len, &error);

if (error != NULL) { goto done; }

/* Success! */ g_task_return_boolean (task, TRUE);

done: /* Unconditionally mark the operation as finished. * * The streams should automatically close as this * last reference is dropped. */ g_clear_object (&priv->connect_task);

if (error != NULL) { /* Stop the operation and propagate the error. */ g_task_return_error (task, error); }

g_clear_object (&task); }

void my_object_connect_to_server_finish (MyObject *self, GAsyncResult *result, GError **error) { g_return_if_fail (MY_IS_OBJECT (self)); g_return_if_fail (g_task_is_valid (result, self)); g_return_if_fail (error == NULL || *error == NULL);

g_task_propagate_boolean (G_TASK (result), error); }

void my_object_close (MyObject *self) { MyObjectPrivate *priv;

g_return_if_fail (MY_IS_OBJECT (self));

priv = my_object_get_instance_private (self);

if (priv->connect_task != NULL) { GCancellable *cancellable = g_task_get_cancellable (priv->connect_task); g_cancellable_cancel (cancellable); } }