gio/gtask.c

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright 2011 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
  21 #include "config.h"
  22
  23 #include "gtask.h"
  24
  25 #include "gasyncresult.h"
  26 #include "gcancellable.h"
  27
  28 /**
  29  * SECTION:gtask
  30  * @short_description: Cancellable synchronous or asynchronous task and result
  31  * @include: gio/gio.h
  32  * @see_also: #GAsyncResult
  33  *
  34  * <para>
  35  *   A #GTask represents and manages a cancellable "task".
  36  * </para>
  37  * <refsect2>
  38  *   <title>Asynchronous operations</title>
  39  *   <para>
  40  *     The most common usage of #GTask is as a #GAsyncResult, to
  41  *     manage data during an asynchronous operation. You call
  42  *     g_task_new() in the "start" method, followed by
  43  *     g_task_set_task_data() and the like if you need to keep some
  44  *     additional data associated with the task, and then pass the
  45  *     task object around through your asynchronous operation.
  46  *     Eventually, you will call a method such as
  47  *     g_task_return_pointer() or g_task_return_error(), which will
  48  *     save the value you give it and then invoke the task's callback
  49  *     function (waiting until the next next iteration of the main
  50  *     loop first, if necessary). The caller will pass the #GTask back
  51  *     to the operation's finish function (as a #GAsyncResult), and
  52  *     you can use g_task_propagate_pointer() or the like to extract
  53  *     the return value.
  54  *   </para>
  55  *   <example id="gtask-async"><title>GTask as a GAsyncResult</title>
  56  *   <programlisting>
  57  *     typedef struct {
  58  *       CakeFrostingType frosting;
  59  *       char *message;
  60  *     } DecorationData;
  61  *
  62  *     static void
  63  *     decoration_data_free (DecorationData *decoration)
  64  *     {
  65  *       g_free (decoration->message);
  66  *       g_slice_free (DecorationData, decoration);
  67  *     }
  68  *
  69  *     static void
  70  *     baked_cb (Cake     *cake,
  71  *               gpointer  user_data)
  72  *     {
  73  *       GTask *task = user_data;
  74  *       DecorationData *decoration = g_task_get_task_data (task);
  75  *       GError *error = NULL;
  76  *
  77  *       if (cake == NULL)
  78  *         {
  79  *           g_task_return_new_error (task, BAKER_ERROR, BAKER_ERROR_NO_FLOUR,
  80  *                                    "Go to the supermarket");
  81  *           g_object_unref (task);
  82  *           return;
  83  *         }
  84  *
  85  *       if (!cake_decorate (cake, decoration->frosting, decoration->message, &error))
  86  *         {
  87  *           g_object_unref (cake);
  88  *           /&ast; g_task_return_error() takes ownership of error &ast;/
  89  *           g_task_return_error (task, error);
  90  *           g_object_unref (task);
  91  *           return;
  92  *         }
  93  *
  94  *       g_task_return_pointer (result, cake, g_object_unref);
  95  *       g_object_unref (task);
  96  *     }
  97  *
  98  *     void
  99  *     baker_bake_cake_async (Baker               *self,
 100  *                            guint                radius,
 101  *                            CakeFlavor           flavor,
 102  *                            CakeFrostingType     frosting,
 103  *                            const char          *message,
 104  *                            GCancellable        *cancellable,
 105  *                            GAsyncReadyCallback  callback,
 106  *                            gpointer             user_data)
 107  *     {
 108  *       GTask *task;
 109  *       DecorationData *decoration;
 110  *       Cake  *cake;
 111  *
 112  *       task = g_task_new (self, cancellable, callback, user_data);
 113  *       if (radius < 3)
 114  *         {
 115  *           g_task_return_new_error (task, BAKER_ERROR, BAKER_ERROR_TOO_SMALL,
 116  *                                    "%ucm radius cakes are silly",
 117  *                                    radius);
 118  *           g_object_unref (task);
 119  *           return;
 120  *         }
 121  *
 122  *       cake = _baker_get_cached_cake (self, radius, flavor, frosting, message);
 123  *       if (cake != NULL)
 124  *         {
 125  *           /&ast; _baker_get_cached_cake() returns a reffed cake &ast;/
 126  *           g_task_return_pointer (task, cake, g_object_unref);
 127  *           g_object_unref (task);
 128  *           return;
 129  *         }
 130  *
 131  *       decoration = g_slice_new (DecorationData);
 132  *       decoration->frosting = frosting;
 133  *       decoration->message = g_strdup (message);
 134  *       g_task_set_task_data (task, decoration, (GDestroyNotify) decoration_data_free);
 135  *
 136  *       _baker_begin_cake (self, radius, flavor, cancellable, baked_cb, task);
 137  *     }
 138  *
 139  *     Cake *
 140  *     baker_bake_cake_finish (Baker         *self,
 141  *                             GAsyncResult  *result,
 142  *                             GError       **error)
 143  *     {
 144  *       g_return_val_if_fail (g_task_is_valid (result, self), NULL);
 145  *
 146  *       return g_task_propagate_pointer (G_TASK (result), error);
 147  *     }
 148  *   </programlisting>
 149  *   </example>
 150  * </refsect2>
 151  * <refsect2>
 152  *   <title>Chained asynchronous operations</title>
 153  *   <para>
 154  *     #GTask also tries to simplify asynchronous operations that
 155  *     internally chain together several smaller asynchronous
 156  *     operations. g_task_get_cancellable(), g_task_get_context(), and
 157  *     g_task_get_priority() allow you to get back the task's
 158  *     #GCancellable, #GMainContext, and <link
 159  *     linkend="io-priority">I/O priority</link> when starting a new
 160  *     subtask, so you don't have to keep track of them yourself.
 161  *     g_task_attach_source() simplifies the case of waiting for a
 162  *     source to fire (automatically using the correct #GMainContext
 163  *     and priority).
 164  *   </para>
 165  *   <example id="gtask-chained"><title>Chained asynchronous operations</title>
 166  *   <programlisting>
 167  *     typedef struct {
 168  *       Cake *cake;
 169  *       CakeFrostingType frosting;
 170  *       char *message;
 171  *     } BakingData;
 172  *
 173  *     static void
 174  *     decoration_data_free (BakingData *bd)
 175  *     {
 176  *       if (bd->cake)
 177  *         g_object_unref (bd->cake);
 178  *       g_free (bd->message);
 179  *       g_slice_free (BakingData, bd);
 180  *     }
 181  *
 182  *     static void
 183  *     decorated_cb (Cake         *cake,
 184  *                   GAsyncResult *result,
 185  *                   gpointer      user_data)
 186  *     {
 187  *       GTask *task = user_data;
 188  *       GError *error = NULL;
 189  *
 190  *       if (!cake_decorate_finish (cake, result, &error))
 191  *         {
 192  *           g_object_unref (cake);
 193  *           g_task_return_error (task, error);
 194  *           g_object_unref (task);
 195  *           return;
 196  *         }
 197  *
 198  *       /&ast; baking_data_free() will drop its ref on the cake, so
 199  *        &ast; we have to take another here to give to the caller.
 200  *        &ast;/
 201  *       g_task_return_pointer (result, g_object_ref (cake), g_object_unref);
 202  *       g_object_unref (task);
 203  *     }
 204  *
 205  *     static void
 206  *     decorator_ready (gpointer user_data)
 207  *     {
 208  *       GTask *task = user_data;
 209  *       BakingData *bd = g_task_get_task_data (task);
 210  *
 211  *       cake_decorate_async (bd->cake, bd->frosting, bd->message,
 212  *                            g_task_get_cancellable (task),
 213  *                            decorated_cb, task);
 214  *     }
 215  *
 216  *     static void
 217  *     baked_cb (Cake     *cake,
 218  *               gpointer  user_data)
 219  *     {
 220  *       GTask *task = user_data;
 221  *       BakingData *bd = g_task_get_task_data (task);
 222  *       GError *error = NULL;
 223  *
 224  *       if (cake == NULL)
 225  *         {
 226  *           g_task_return_new_error (task, BAKER_ERROR, BAKER_ERROR_NO_FLOUR,
 227  *                                    "Go to the supermarket");
 228  *           g_object_unref (task);
 229  *           return;
 230  *         }
 231  *
 232  *       bd->cake = cake;
 233  *
 234  *       /&ast; Bail out now if the user has already cancelled &ast;/
 235  *       if (g_task_return_error_if_cancelled (g_task_get_cancellable (task)))
 236  *         {
 237  *           g_object_unref (task);
 238  *           return;
 239  *         }
 240  *
 241  *       if (cake_decorator_available (cake))
 242  *         decorator_ready (task);
 243  *       else
 244  *         {
 245  *           GSource *source;
 246  *
 247  *           source = cake_decorator_wait_source_new (cake);
 248  *           /&ast; Attach @source to @task's GMainContext and have it call
 249  *            &ast; decorator_ready() when it is ready.
 250  *            &ast;/
 251  *           g_task_attach_source (task, source,
 252  *                                 G_CALLBACK (decorator_ready));
 253  *           g_source_unref (source);
 254  *         }
 255  *     }
 256  *
 257  *     void
 258  *     baker_bake_cake_async (Baker               *self,
 259  *                            guint                radius,
 260  *                            CakeFlavor           flavor,
 261  *                            CakeFrostingType     frosting,
 262  *                            const char          *message,
 263  *                            gint                 priority,
 264  *                            GCancellable        *cancellable,
 265  *                            GAsyncReadyCallback  callback,
 266  *                            gpointer             user_data)
 267  *     {
 268  *       GTask *task;
 269  *       BakingData *bd;
 270  *
 271  *       task = g_task_new (self, cancellable, callback, user_data);
 272  *       g_task_set_priority (task, priority);
 273  *
 274  *       bd = g_slice_new0 (BakingData);
 275  *       bd->frosting = frosting;
 276  *       bd->message = g_strdup (message);
 277  *       g_task_set_task_data (task, bd, (GDestroyNotify) baking_data_free);
 278  *
 279  *       _baker_begin_cake (self, radius, flavor, cancellable, baked_cb, task);
 280  *     }
 281  *
 282  *     Cake *
 283  *     baker_bake_cake_finish (Baker         *self,
 284  *                             GAsyncResult  *result,
 285  *                             GError       **error)
 286  *     {
 287  *       g_return_val_if_fail (g_task_is_valid (result, self), NULL);
 288  *
 289  *       return g_task_propagate_pointer (G_TASK (result), error);
 290  *     }
 291  *   </programlisting>
 292  *   </example>
 293  * </refsect2>
 294  * <refsect2>
 295  *   <title>Asynchronous operations from synchronous ones</title>
 296  *   <para>
 297  *     You can use g_task_run_in_thread() to turn a synchronous
 298  *     operation into an asynchronous one, by running it in a thread
 299  *     which will then dispatch the result back to the caller's
 300  *     #GMainContext when it completes.
 301  *   </para>
 302  *   <example id="gtask-run-in-thread"><title>g_task_run_in_thread()</title>
 303  *   <programlisting>
 304  *     typedef struct {
 305  *       guint radius;
 306  *       CakeFlavor flavor;
 307  *       CakeFrostingType frosting;
 308  *       char *message;
 309  *     } CakeData;
 310  *
 311  *     static void
 312  *     cake_data_free (CakeData *cake_data)
 313  *     {
 314  *       g_free (cake_data->message);
 315  *       g_slice_free (CakeData, cake_data);
 316  *     }
 317  *
 318  *     static void
 319  *     bake_cake_thread (GTask         *task,
 320  *                       gpointer       source_object,
 321  *                       gpointer       task_data,
 322  *                       GCancellable  *cancellable)
 323  *     {
 324  *       Baker *self = source_object;
 325  *       CakeData *cake_data = task_data;
 326  *       Cake *cake;
 327  *       GError *error = NULL;
 328  *
 329  *       cake = bake_cake (baker, cake_data->radius, cake_data->flavor,
 330  *                         cake_data->frosting, cake_data->message,
 331  *                         cancellable, &error);
 332  *       if (cake)
 333  *         g_task_return_pointer (task, cake, g_object_unref);
 334  *       else
 335  *         g_task_return_error (task, error);
 336  *     }
 337  *
 338  *     void
 339  *     baker_bake_cake_async (Baker               *self,
 340  *                            guint                radius,
 341  *                            CakeFlavor           flavor,
 342  *                            CakeFrostingType     frosting,
 343  *                            const char          *message,
 344  *                            GCancellable        *cancellable,
 345  *                            GAsyncReadyCallback  callback,
 346  *                            gpointer             user_data)
 347  *     {
 348  *       CakeData *cake_data;
 349  *       GTask *task;
 350  *
 351  *       cake_data = g_slice_new (CakeData);
 352  *       cake_data->radius = radius;
 353  *       cake_data->flavor = flavor;
 354  *       cake_data->frosting = frosting;
 355  *       cake_data->message = g_strdup (message);
 356  *       task = g_task_new (self, cancellable, callback, user_data);
 357  *       g_task_set_task_data (task, cake_data, (GDestroyNotify) cake_data_free);
 358  *       g_task_run_in_thread (task, bake_cake_thread);
 359  *     }
 360  *
 361  *     Cake *
 362  *     baker_bake_cake_finish (Baker         *self,
 363  *                             GAsyncResult  *result,
 364  *                             GError       **error)
 365  *     {
 366  *       g_return_val_if_fail (g_task_is_valid (result, self), NULL);
 367  *
 368  *       return g_task_propagate_pointer (G_TASK (result), error);
 369  *     }
 370  *   </programlisting>
 371  *   </example>
 372  * </refsect2>
 373  * <refsect2>
 374  *   <title>Adding cancellability to uncancellable tasks</title>
 375  *   <para>
 376  *     Finally, g_task_run_in_thread() and g_task_run_in_thread_sync()
 377  *     can be used to turn an uncancellable operation into a
 378  *     cancellable one. If you call g_task_set_return_on_cancel(),
 379  *     passing %TRUE, then if the task's #GCancellable is cancelled,
 380  *     it will return control back to the caller immediately, while
 381  *     allowing the task thread to continue running in the background
 382  *     (and simply discarding its result when it finally does finish).
 383  *     Provided that the task thread is careful about how it uses
 384  *     locks and other externally-visible resources, this allows you
 385  *     to make "GLib-friendly" asynchronous and cancellable
 386  *     synchronous variants of blocking APIs.
 387  *   </para>
 388  *   <example id="gtask-cancellable"><title>g_task_set_return_on_cancel()</title>
 389  *   <programlisting>
 390  *     static void
 391  *     bake_cake_thread (GTask         *task,
 392  *                       gpointer       source_object,
 393  *                       gpointer       task_data,
 394  *                       GCancellable  *cancellable)
 395  *     {
 396  *       Baker *self = source_object;
 397  *       CakeData *cake_data = task_data;
 398  *       Cake *cake;
 399  *       GError *error = NULL;
 400  *
 401  *       cake = bake_cake (baker, cake_data->radius, cake_data->flavor,
 402  *                         cake_data->frosting, cake_data->message,
 403  *                         &error);
 404  *       if (error)
 405  *         {
 406  *           g_task_return_error (task, error);
 407  *           return;
 408  *         }
 409  *
 410  *       /&ast; If the task has already been cancelled, then we don't
 411  *        &ast; want to add the cake to the cake cache. Likewise, we don't
 412  *        &ast; want to have the task get cancelled in the middle of
 413  *        &ast; updating the cache. g_task_set_return_on_cancel() will
 414  *        &ast; return %TRUE here if it managed to disable return-on-cancel,
 415  *        &ast; or %FALSE if the task was cancelled before it could.
 416  *        &ast;/
 417  *       if (g_task_set_return_on_cancel (task, FALSE))
 418  *         {
 419  *           /&ast; If the caller cancels at this point, their
 420  *            &ast; GAsyncReadyCallback won't be invoked until we return,
 421  *            &ast; so we don't have to worry that this code will run at
 422  *            &ast; the same time as that code does. But if there were
 423  *            &ast; other functions that might look at the cake cache,
 424  *            &ast; then we'd probably need a GMutex here as well.
 425  *            &ast;/
 426  *           baker_add_cake_to_cache (baker, cake);
 427  *           g_task_return_pointer (task, cake, g_object_unref);
 428  *         }
 429  *     }
 430  *
 431  *     void
 432  *     baker_bake_cake_async (Baker               *self,
 433  *                            guint                radius,
 434  *                            CakeFlavor           flavor,
 435  *                            CakeFrostingType     frosting,
 436  *                            const char          *message,
 437  *                            GCancellable        *cancellable,
 438  *                            GAsyncReadyCallback  callback,
 439  *                            gpointer             user_data)
 440  *     {
 441  *       CakeData *cake_data;
 442  *       GTask *task;
 443  *
 444  *       cake_data = g_slice_new (CakeData);
 445  *       /&ast; ... &ast;/
 446  *
 447  *       task = g_task_new (self, cancellable, callback, user_data);
 448  *       g_task_set_task_data (task, cake_data, (GDestroyNotify) cake_data_free);
 449  *       g_task_set_return_on_cancel (task, TRUE);
 450  *       g_task_run_in_thread (task, bake_cake_thread);
 451  *     }
 452  *
 453  *     Cake *
 454  *     baker_bake_cake_sync (Baker               *self,
 455  *                           guint                radius,
 456  *                           CakeFlavor           flavor,
 457  *                           CakeFrostingType     frosting,
 458  *                           const char          *message,
 459  *                           GCancellable        *cancellable,
 460  *                           GError             **error)
 461  *     {
 462  *       CakeData *cake_data;
 463  *       GTask *task;
 464  *       Cake *cake;
 465  *
 466  *       cake_data = g_slice_new (CakeData);
 467  *       /&ast; ... &ast;/
 468  *
 469  *       task = g_task_new (self, cancellable, NULL, NULL);
 470  *       g_task_set_task_data (task, cake_data, (GDestroyNotify) cake_data_free);
 471  *       g_task_set_return_on_cancel (task, TRUE);
 472  *       g_task_run_in_thread_sync (task, bake_cake_thread);
 473  *
 474  *       cake = g_task_propagate_pointer (task, error);
 475  *       g_object_unref (task);
 476  *       return cake;
 477  *     }
 478  *   </programlisting>
 479  *   </example>
 480  * </refsect2>
 481  * <refsect2>
 482  *   <title>Porting from <literal>GSimpleAsyncResult</literal></title>
 483  *   <para>
 484  *     #GTask's API attempts to be simpler than #GSimpleAsyncResult's
 485  *     in several ways:
 486  *   </para>
 487  *   <itemizedlist>
 488  *     <listitem><para>
 489  *       You can save task-specific data with g_task_set_task_data(), and
 490  *       retrieve it later with g_task_get_task_data(). This replaces the
 491  *       abuse of g_simple_async_result_set_op_res_gpointer() for the same
 492  *       purpose with #GSimpleAsyncResult.
 493  *     </para></listitem>
 494  *     <listitem><para>
 495  *       In addition to the task data, #GTask also keeps track of the
 496  *       <link linkend="io-priority">priority</link>, #GCancellable, and
 497  *       #GMainContext associated with the task, so tasks that consist of
 498  *       a chain of simpler asynchronous operations will have easy access
 499  *       to those values when starting each sub-task.
 500  *     </para></listitem>
 501  *     <listitem><para>
 502  *       g_task_return_error_if_cancelled() provides simplified
 503  *       handling for cancellation. In addition, cancellation
 504  *       overrides any other #GTask return value by default, like
 505  *       #GSimpleAsyncResult does when
 506  *       g_simple_async_result_set_check_cancellable() is called.
 507  *       (You can use g_task_set_check_cancellable() to turn off that
 508  *       behavior.) On the other hand, g_task_run_in_thread()
 509  *       guarantees that it will always run your
 510  *       <literal>task_func</literal>, even if the task's #GCancellable
 511  *       is already cancelled before the task gets a chance to run;
 512  *       you can start your <literal>task_func</literal> with a
 513  *       g_task_return_error_if_cancelled() check if you need the
 514  *       old behavior.
 515  *     </para></listitem>
 516  *     <listitem><para>
 517  *       The "return" methods (eg, g_task_return_pointer())
 518  *       automatically cause the task to be "completed" as well, and
 519  *       there is no need to worry about the "complete" vs "complete
 520  *       in idle" distinction. (#GTask automatically figures out
 521  *       whether the task's callback can be invoked directly, or
 522  *       if it needs to be sent to another #GMainContext, or delayed
 523  *       until the next iteration of the current #GMainContext.)
 524  *     </para></listitem>
 525  *     <listitem><para>
 526  *       The "finish" functions for #GTask-based operations are generally
 527  *       much simpler than #GSimpleAsyncResult ones, normally consisting
 528  *       of only a single call to g_task_propagate_pointer() or the like.
 529  *       Since g_task_propagate_pointer() "steals" the return value from
 530  *       the #GTask, it is not necessary to juggle pointers around to
 531  *       prevent it from being freed twice.
 532  *     </para></listitem>
 533  *     <listitem><para>
 534  *       With #GSimpleAsyncResult, it was common to call
 535  *       g_simple_async_result_propagate_error() from the
 536  *       <literal>_finish()</literal> wrapper function, and have
 537  *       virtual method implementations only deal with successful
 538  *       returns. This behavior is deprecated, because it makes it
 539  *       difficult for a subclass to chain to a parent class's async
 540  *       methods. Instead, the wrapper function should just be a
 541  *       simple wrapper, and the virtual method should call an
 542  *       appropriate <literal>g_task_propagate_</literal> function.
 543  *       Note that wrapper methods can now use
 544  *       g_async_result_legacy_propagate_error() to do old-style
 545  *       #GSimpleAsyncResult error-returning behavior, and
 546  *       g_async_result_is_tagged() to check if a result is tagged as
 547  *       having come from the <literal>_async()</literal> wrapper
 548  *       function (for "short-circuit" results, such as when passing
 549  *       0 to g_input_stream_read_async()).
 550  *     </para></listitem>
 551  *   </itemizedlist>
 552  * </refsect2>
 553  */
 554
 555 /**
 556  * GTask:
 557  *
 558  * The opaque object representing a synchronous or asynchronous task
 559  * and its result.
 560  */
 561
 562 struct _GTask {
 563   GObject parent_instance;
 564
 565   gpointer source_object;
 566   gpointer source_tag;
 567
 568   gpointer task_data;
 569   GDestroyNotify task_data_destroy;
 570
 571   GMainContext *context;
 572   guint64 creation_time;
 573   gint priority;
 574   GCancellable *cancellable;
 575   gboolean check_cancellable;
 576
 577   GAsyncReadyCallback callback;
 578   gpointer callback_data;
 579
 580   GTaskThreadFunc task_func;
 581   GMutex lock;
 582   GCond cond;
 583   gboolean return_on_cancel;
 584   gboolean thread_cancelled;
 585   gboolean synchronous;
 586   gboolean thread_complete;
 587
 588   GError *error;
 589   union {
 590     gpointer pointer;
 591     gssize   size;
 592     gboolean boolean;
 593   } result;
 594   GDestroyNotify result_destroy;
 595   gboolean result_set;
 596 };
 597
 598 #define G_TASK_IS_THREADED(task) ((task)->task_func != NULL)
 599
 600 struct _GTaskClass
 601 {
 602   GObjectClass parent_class;
 603 };
 604
 605 static void g_task_thread_pool_resort (void);
 606
 607 static void g_task_async_result_iface_init (GAsyncResultIface *iface);
 608 static void g_task_thread_pool_init (void);
 609
 610 G_DEFINE_TYPE_WITH_CODE (GTask, g_task, G_TYPE_OBJECT,
 611                          G_IMPLEMENT_INTERFACE (G_TYPE_ASYNC_RESULT,
 612                                                 g_task_async_result_iface_init);
 613                          g_task_thread_pool_init ();)
 614
 615 static GThreadPool *task_pool;
 616
 617 static void
 618 g_task_init (GTask *task)
 619 {
 620   task->check_cancellable = TRUE;
 621 }
 622
 623 static void
 624 g_task_finalize (GObject *object)
 625 {
 626   GTask *task = G_TASK (object);
 627
 628   g_clear_object (&task->source_object);
 629   g_clear_object (&task->cancellable);
 630
 631   if (task->context)
 632     g_main_context_unref (task->context);
 633
 634   if (task->task_data_destroy)
 635     task->task_data_destroy (task->task_data);
 636
 637   if (task->result_destroy && task->result.pointer)
 638     task->result_destroy (task->result.pointer);
 639
 640   if (G_TASK_IS_THREADED (task))
 641     {
 642       g_mutex_clear (&task->lock);
 643       g_cond_clear (&task->cond);
 644     }
 645
 646   G_OBJECT_CLASS (g_task_parent_class)->finalize (object);
 647 }
 648
 649 /**
 650  * g_task_new:
 651  * @source_object: (allow-none): the #GObject that owns this task, or %NULL.
 652  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
 653  * @callback: (scope async): a #GAsyncReadyCallback.
 654  * @callback_data: (closure): user data passed to @callback.
 655  *
 656  * Creates a #GTask acting on @source_object, which will eventually be
 657  * used to invoke @callback in the current <link
 658  * linkend="g-main-context-push-thread-default">thread-default main
 659  * context</link>.
 660  *
 661  * Call this in the "start" method of your asynchronous method, and
 662  * pass the #GTask around throughout the asynchronous operation. You
 663  * can use g_task_set_task_data() to attach task-specific data to the
 664  * object, which you can retrieve later via g_task_get_task_data().
 665  *
 666  * By default, if @cancellable is cancelled, then the return value of
 667  * the task will always be %G_IO_ERROR_CANCELLED, even if the task had
 668  * already completed before the cancellation. This allows for
 669  * simplified handling in cases where cancellation may imply that
 670  * other objects that the task depends on have been destroyed. If you
 671  * do not want this behavior, you can use
 672  * g_task_set_check_cancellable() to change it.
 673  *
 674  * Returns: a #GTask.
 675  *
 676  * Since: 2.36
 677  */
 678 GTask *
 679 g_task_new (gpointer              source_object,
 680             GCancellable         *cancellable,
 681             GAsyncReadyCallback   callback,
 682             gpointer              callback_data)
 683 {
 684   GTask *task;
 685   GSource *source;
 686
 687   task = g_object_new (G_TYPE_TASK, NULL);
 688   task->source_object = source_object ? g_object_ref (source_object) : NULL;
 689   task->cancellable = cancellable ? g_object_ref (cancellable) : NULL;
 690   task->callback = callback;
 691   task->callback_data = callback_data;
 692   task->context = g_main_context_ref_thread_default ();
 693
 694   source = g_main_current_source ();
 695   if (source)
 696     task->creation_time = g_source_get_time (source);
 697
 698   return task;
 699 }
 700
 701 /**
 702  * g_task_report_error:
 703  * @source_object: (allow-none): the #GObject that owns this task, or %NULL.
 704  * @callback: (scope async): a #GAsyncReadyCallback.
 705  * @callback_data: (closure): user data passed to @callback.
 706  * @source_tag: an opaque pointer indicating the source of this task
 707  * @error: (transfer full): error to report
 708  *
 709  * Creates a #GTask and then immediately calls g_task_return_error()
 710  * on it. Use this in the wrapper function of an asynchronous method
 711  * when you want to avoid even calling the virtual method. You can
 712  * then use g_async_result_is_tagged() in the finish method wrapper to
 713  * check if the result there is tagged as having been created by the
 714  * wrapper method, and deal with it appropriately if so.
 715  *
 716  * See also g_task_report_new_error().
 717  *
 718  * Since: 2.36
 719  */
 720 void
 721 g_task_report_error (gpointer             source_object,
 722                      GAsyncReadyCallback  callback,
 723                      gpointer             callback_data,
 724                      gpointer             source_tag,
 725                      GError              *error)
 726 {
 727   GTask *task;
 728
 729   task = g_task_new (source_object, NULL, callback, callback_data);
 730   g_task_set_source_tag (task, source_tag);
 731   g_task_return_error (task, error);
 732   g_object_unref (task);
 733 }
 734
 735 /**
 736  * g_task_report_new_error:
 737  * @source_object: (allow-none): the #GObject that owns this task, or %NULL.
 738  * @callback: (scope async): a #GAsyncReadyCallback.
 739  * @callback_data: (closure): user data passed to @callback.
 740  * @source_tag: an opaque pointer indicating the source of this task
 741  * @domain: a #GQuark.
 742  * @code: an error code.
 743  * @format: a string with format characters.
 744  * @...: a list of values to insert into @format.
 745  *
 746  * Creates a #GTask and then immediately calls
 747  * g_task_return_new_error() on it. Use this in the wrapper function
 748  * of an asynchronous method when you want to avoid even calling the
 749  * virtual method. You can then use g_async_result_is_tagged() in the
 750  * finish method wrapper to check if the result there is tagged as
 751  * having been created by the wrapper method, and deal with it
 752  * appropriately if so.
 753  *
 754  * See also g_task_report_error().
 755  *
 756  * Since: 2.36
 757  */
 758 void
 759 g_task_report_new_error (gpointer             source_object,
 760                          GAsyncReadyCallback  callback,
 761                          gpointer             callback_data,
 762                          gpointer             source_tag,
 763                          GQuark               domain,
 764                          gint                 code,
 765                          const char          *format,
 766                          ...)
 767 {
 768   GError *error;
 769   va_list ap;
 770
 771   va_start (ap, format);
 772   error = g_error_new_valist (domain, code, format, ap);
 773   va_end (ap);
 774
 775   g_task_report_error (source_object, callback, callback_data,
 776                        source_tag, error);
 777 }
 778
 779 /**
 780  * g_task_set_task_data:
 781  * @task: the #GTask
 782  * @task_data: (allow-none): task-specific data
 783  * @task_data_destroy: (allow-none): #GDestroyNotify for @task_data
 784  *
 785  * Sets @task's task data (freeing the existing task data, if any).
 786  *
 787  * Since: 2.36
 788  */
 789 void
 790 g_task_set_task_data (GTask          *task,
 791                       gpointer        task_data,
 792                       GDestroyNotify  task_data_destroy)
 793 {
 794   if (task->task_data_destroy)
 795     task->task_data_destroy (task->task_data);
 796
 797   task->task_data = task_data;
 798   task->task_data_destroy = task_data_destroy;
 799 }
 800
 801 /**
 802  * g_task_set_priority:
 803  * @task: the #GTask
 804  * @priority: the <link linkend="io-priority">priority</link>
 805  *   of the request.
 806  *
 807  * Sets @task's priority. If you do not call this, it will default to
 808  * %G_PRIORITY_DEFAULT.
 809  *
 810  * This will affect the priority of #GSources created with
 811  * g_task_attach_source() and the scheduling of tasks run in threads,
 812  * and can also be explicitly retrieved later via
 813  * g_task_get_priority().
 814  *
 815  * Since: 2.36
 816  */
 817 void
 818 g_task_set_priority (GTask *task,
 819                      gint   priority)
 820 {
 821   task->priority = priority;
 822 }
 823
 824 /**
 825  * g_task_set_check_cancellable:
 826  * @task: the #GTask
 827  * @check_cancellable: whether #GTask will check the state of
 828  *   its #GCancellable for you.
 829  *
 830  * Sets or clears @task's check-cancellable flag. If this is %TRUE
 831  * (the default), then g_task_propagate_pointer(), etc, and
 832  * g_task_had_error() will check the task's #GCancellable first, and
 833  * if it has been cancelled, then they will consider the task to have
 834  * returned an "Operation was cancelled" error
 835  * (%G_IO_ERROR_CANCELLED), regardless of any other error or return
 836  * value the task may have had.
 837  *
 838  * If @check_cancellable is %FALSE, then the #GTask will not check the
 839  * cancellable itself, and it is up to @task's owner to do this (eg,
 840  * via g_task_return_error_if_cancelled()).
 841  *
 842  * If you are using g_task_set_return_on_cancel() as well, then
 843  * you must leave check-cancellable set %TRUE.
 844  *
 845  * Since: 2.36
 846  */
 847 void
 848 g_task_set_check_cancellable (GTask    *task,
 849                               gboolean  check_cancellable)
 850 {
 851   g_return_if_fail (check_cancellable || !task->return_on_cancel);
 852
 853   task->check_cancellable = check_cancellable;
 854 }
 855
 856 static void g_task_thread_complete (GTask *task);
 857
 858 /**
 859  * g_task_set_return_on_cancel:
 860  * @task: the #GTask
 861  * @return_on_cancel: whether the task returns automatically when
 862  *   it is cancelled.
 863  *
 864  * Sets or clears @task's return-on-cancel flag. This is only
 865  * meaningful for tasks run via g_task_run_in_thread() or
 866  * g_task_run_in_thread_sync().
 867  *
 868  * If @return_on_cancel is %TRUE, then cancelling @task's
 869  * #GCancellable will immediately cause it to return, as though the
 870  * task's #GTaskThreadFunc had called
 871  * g_task_return_error_if_cancelled() and then returned.
 872  *
 873  * This allows you to create a cancellable wrapper around an
 874  * uninterruptable function. The #GTaskThreadFunc just needs to be
 875  * careful that it does not modify any externally-visible state after
 876  * it has been cancelled. To do that, the thread should call
 877  * g_task_set_return_on_cancel() again to (atomically) set
 878  * return-on-cancel %FALSE before making externally-visible changes;
 879  * if the task gets cancelled before the return-on-cancel flag could
 880  * be changed, g_task_set_return_on_cancel() will indicate this by
 881  * returning %FALSE.
 882  *
 883  * You can disable and re-enable this flag multiple times if you wish.
 884  * If the task's #GCancellable is cancelled while return-on-cancel is
 885  * %FALSE, then calling g_task_set_return_on_cancel() to set it %TRUE
 886  * again will cause the task to be cancelled at that point.
 887  *
 888  * If the task's #GCancellable is already cancelled before you call
 889  * g_task_run_in_thread()/g_task_run_in_thread_sync(), then the
 890  * #GTaskThreadFunc will still be run (for consistency), but the task
 891  * will also be completed right away.
 892  *
 893  * Returns: %TRUE if @task's return-on-cancel flag was changed to
 894  *   match @return_on_cancel. %FALSE if @task has already been
 895  *   cancelled.
 896  *
 897  * Since: 2.36
 898  */
 899 gboolean
 900 g_task_set_return_on_cancel (GTask    *task,
 901                              gboolean  return_on_cancel)
 902 {
 903   g_return_val_if_fail (task->check_cancellable || !return_on_cancel, FALSE);
 904
 905   if (!G_TASK_IS_THREADED (task))
 906     {
 907       task->return_on_cancel = return_on_cancel;
 908       return TRUE;
 909     }
 910
 911   g_mutex_lock (&task->lock);
 912   if (task->thread_cancelled)
 913     {
 914       if (return_on_cancel && !task->return_on_cancel)
 915         {
 916           g_mutex_unlock (&task->lock);
 917           g_task_thread_complete (task);
 918         }
 919       else
 920         g_mutex_unlock (&task->lock);
 921       return FALSE;
 922     }
 923   task->return_on_cancel = return_on_cancel;
 924   g_mutex_unlock (&task->lock);
 925
 926   return TRUE;
 927 }
 928
 929 /**
 930  * g_task_set_source_tag:
 931  * @task: the #GTask
 932  * @source_tag: an opaque pointer indicating the source of this task
 933  *
 934  * Sets @task's source tag. You can use this to tag a task return
 935  * value with a particular pointer (usually a pointer to the function
 936  * doing the tagging) and then later check it using
 937  * g_task_get_source_tag() (or g_async_result_is_tagged()) in the
 938  * task's "finish" function, to figure out if the response came from a
 939  * particular place.
 940  *
 941  * Since: 2.36
 942  */
 943 void
 944 g_task_set_source_tag (GTask    *task,
 945                        gpointer  source_tag)
 946 {
 947   task->source_tag = source_tag;
 948 }
 949
 950 /**
 951  * g_task_get_source_object:
 952  * @task: a #GTask
 953  *
 954  * Gets the source object from @task. Like
 955  * g_async_result_get_source_object(), but does not ref the object.
 956  *
 957  * Returns: (transfer none): @task's source object, or %NULL
 958  *
 959  * Since: 2.36
 960  */
 961 gpointer
 962 g_task_get_source_object (GTask *task)
 963 {
 964   return task->source_object;
 965 }
 966
 967 static GObject *
 968 g_task_ref_source_object (GAsyncResult *res)
 969 {
 970   GTask *task = G_TASK (res);
 971
 972   if (task->source_object)
 973     return g_object_ref (task->source_object);
 974   else
 975     return NULL;
 976 }
 977
 978 /**
 979  * g_task_get_task_data:
 980  * @task: a #GTask
 981  *
 982  * Gets @task's <literal>task_data</literal>.
 983  *
 984  * Returns: (transfer none): @task's <literal>task_data</literal>.
 985  *
 986  * Since: 2.36
 987  */
 988 gpointer
 989 g_task_get_task_data (GTask *task)
 990 {
 991   return task->task_data;
 992 }
 993
 994 /**
 995  * g_task_get_priority:
 996  * @task: a #GTask
 997  *
 998  * Gets @task's priority
 999  *
1000  * Returns: @task's priority
1001  *
1002  * Since: 2.36
1003  */
1004 gint
1005 g_task_get_priority (GTask *task)
1006 {
1007   return task->priority;
1008 }
1009
1010 /**
1011  * g_task_get_context:
1012  * @task: a #GTask
1013  *
1014  * Gets the #GMainContext that @task will return its result in (that
1015  * is, the context that was the <link
1016  * linkend="g-main-context-push-thread-default">thread-default main
1017  * context</link> at the point when @task was created).
1018  *
1019  * This will always return a non-%NULL value, even if the task's
1020  * context is the default #GMainContext.
1021  *
1022  * Returns: (transfer none): @task's #GMainContext
1023  *
1024  * Since: 2.36
1025  */
1026 GMainContext *
1027 g_task_get_context (GTask *task)
1028 {
1029   return task->context;
1030 }
1031
1032 /**
1033  * g_task_get_cancellable:
1034  * @task: a #GTask
1035  *
1036  * Gets @task's #GCancellable
1037  *
1038  * Returns: (transfer none): @task's #GCancellable
1039  *
1040  * Since: 2.36
1041  */
1042 GCancellable *
1043 g_task_get_cancellable (GTask *task)
1044 {
1045   return task->cancellable;
1046 }
1047
1048 /**
1049  * g_task_get_check_cancellable:
1050  * @task: the #GTask
1051  *
1052  * Gets @task's check-cancellable flag. See
1053  * g_task_set_check_cancellable() for more details.
1054  *
1055  * Since: 2.36
1056  */
1057 gboolean
1058 g_task_get_check_cancellable (GTask *task)
1059 {
1060   return task->check_cancellable;
1061 }
1062
1063 /**
1064  * g_task_get_return_on_cancel:
1065  * @task: the #GTask
1066  *
1067  * Gets @task's return-on-cancel flag. See
1068  * g_task_set_return_on_cancel() for more details.
1069  *
1070  * Since: 2.36
1071  */
1072 gboolean
1073 g_task_get_return_on_cancel (GTask *task)
1074 {
1075   return task->return_on_cancel;
1076 }
1077
1078 /**
1079  * g_task_get_source_tag:
1080  * @task: a #GTask
1081  *
1082  * Gets @task's source tag. See g_task_set_source_tag().
1083  *
1084  * Return value: (transfer none): @task's source tag
1085  *
1086  * Since: 2.36
1087  */
1088 gpointer
1089 g_task_get_source_tag (GTask *task)
1090 {
1091   return task->source_tag;
1092 }
1093
1094
1095 static void
1096 g_task_return_now (GTask *task)
1097 {
1098   g_main_context_push_thread_default (task->context);
1099   task->callback (task->source_object,
1100                   G_ASYNC_RESULT (task),
1101                   task->callback_data);
1102   g_main_context_pop_thread_default (task->context);
1103 }
1104
1105 static gboolean
1106 complete_in_idle_cb (gpointer task)
1107 {
1108   g_task_return_now (task);
1109   g_object_unref (task);
1110   return FALSE;
1111 }
1112
1113 typedef enum {
1114   G_TASK_RETURN_SUCCESS,
1115   G_TASK_RETURN_ERROR,
1116   G_TASK_RETURN_FROM_THREAD
1117 } GTaskReturnType;
1118
1119 static void
1120 g_task_return (GTask           *task,
1121                GTaskReturnType  type)
1122 {
1123   GSource *source;
1124
1125   if (type == G_TASK_RETURN_SUCCESS)
1126     task->result_set = TRUE;
1127
1128   if (task->synchronous || !task->callback)
1129     return;
1130
1131   /* Normally we want to invoke the task's callback when its return
1132    * value is set. But if the task is running in a thread, then we
1133    * want to wait until after the task_func returns, to simplify
1134    * locking/refcounting/etc.
1135    */
1136   if (G_TASK_IS_THREADED (task) && type != G_TASK_RETURN_FROM_THREAD)
1137     return;
1138
1139   g_object_ref (task);
1140
1141   /* See if we can complete the task immediately. First, we have to be
1142    * running inside the task's thread/GMainContext.
1143    */
1144   source = g_main_current_source ();
1145   if (source && g_source_get_context (source) == task->context)
1146     {
1147       /* Second, we can only complete immediately if this is not the
1148        * same iteration of the main loop that the task was created in.
1149        */
1150       if (g_source_get_time (source) > task->creation_time)
1151         {
1152           g_task_return_now (task);
1153           g_object_unref (task);
1154           return;
1155         }
1156     }
1157
1158   /* Otherwise, complete in the next iteration */
1159   source = g_idle_source_new ();
1160   g_task_attach_source (task, source, complete_in_idle_cb);
1161   g_source_unref (source);
1162 }
1163
1164
1165 /**
1166  * GTaskThreadFunc:
1167  * @task: the #GTask
1168  * @source_object: @task's source object
1169  * @task_data: @task's task data
1170  * @cancellable: @task's #GCancellable, or %NULL
1171  *
1172  * The prototype for a task function to be run in a thread via
1173  * g_task_run_in_thread() or g_task_run_in_thread_sync().
1174  *
1175  * If the return-on-cancel flag is set on @task, and @cancellable gets
1176  * cancelled, then the #GTask will be completed immediately (as though
1177  * g_task_return_error_if_cancelled() had been called), without
1178  * waiting for the task function to complete. However, the task
1179  * function will continue running in its thread in the background. The
1180  * function therefore needs to be careful about how it uses
1181  * externally-visible state in this case. See
1182  * g_task_set_return_on_cancel() for more details.
1183  *
1184  * Other than in that case, @task will be completed when the
1185  * #GTaskThreadFunc returns, <emphasis>not</emphasis> when it calls
1186  * a <literal>g_task_return_</literal> function.
1187  *
1188  * Since: 2.36
1189  */
1190
1191 static void task_thread_cancelled (GCancellable *cancellable,
1192                                    gpointer      user_data);
1193
1194 static void
1195 g_task_thread_complete (GTask *task)
1196 {
1197   g_mutex_lock (&task->lock);
1198   if (task->thread_complete)
1199     {
1200       /* The task belatedly completed after having been cancelled
1201        * (or was cancelled in the midst of being completed).
1202        */
1203       g_mutex_unlock (&task->lock);
1204       return;
1205     }
1206
1207   task->thread_complete = TRUE;
1208   g_mutex_unlock (&task->lock);
1209
1210   if (task->cancellable)
1211     g_signal_handlers_disconnect_by_func (task->cancellable, task_thread_cancelled, task);
1212
1213   if (task->synchronous)
1214     g_cond_signal (&task->cond);
1215   else
1216     g_task_return (task, G_TASK_RETURN_FROM_THREAD);
1217 }
1218
1219 static void
1220 g_task_thread_pool_thread (gpointer thread_data,
1221                            gpointer pool_data)
1222 {
1223   GTask *task = thread_data;
1224
1225   task->task_func (task, task->source_object, task->task_data,
1226                    task->cancellable);
1227   g_task_thread_complete (task);
1228   g_object_unref (task);
1229 }
1230
1231 static void
1232 task_thread_cancelled (GCancellable *cancellable,
1233                        gpointer      user_data)
1234 {
1235   GTask *task = user_data;
1236
1237   g_task_thread_pool_resort ();
1238
1239   g_mutex_lock (&task->lock);
1240   task->thread_cancelled = TRUE;
1241
1242   if (!task->return_on_cancel)
1243     {
1244       g_mutex_unlock (&task->lock);
1245       return;
1246     }
1247
1248   /* We don't actually set task->error; g_task_return_error() doesn't
1249    * use a lock, and g_task_propagate_error() will call
1250    * g_cancellable_set_error_if_cancelled() anyway.
1251    */
1252   g_mutex_unlock (&task->lock);
1253   g_task_thread_complete (task);
1254 }
1255
1256 static void
1257 task_thread_cancelled_disconnect_notify (gpointer  task,
1258                                          GClosure *closure)
1259 {
1260   g_object_unref (task);
1261 }
1262
1263 static void
1264 g_task_start_task_thread (GTask           *task,
1265                           GTaskThreadFunc  task_func)
1266 {
1267   g_mutex_init (&task->lock);
1268   g_cond_init (&task->cond);
1269
1270   g_mutex_lock (&task->lock);
1271
1272   task->task_func = task_func;
1273
1274   if (task->cancellable)
1275     {
1276       if (task->return_on_cancel &&
1277           g_cancellable_set_error_if_cancelled (task->cancellable,
1278                                                 &task->error))
1279         {
1280           task->thread_cancelled = task->thread_complete = TRUE;
1281           g_thread_pool_push (task_pool, g_object_ref (task), NULL);
1282           return;
1283         }
1284
1285       g_signal_connect_data (task->cancellable, "cancelled",
1286                              G_CALLBACK (task_thread_cancelled),
1287                              g_object_ref (task),
1288                              task_thread_cancelled_disconnect_notify, 0);
1289     }
1290
1291   g_thread_pool_push (task_pool, g_object_ref (task), &task->error);
1292   if (task->error)
1293     task->thread_complete = TRUE;
1294 }
1295
1296 /**
1297  * g_task_run_in_thread:
1298  * @task: a #GTask
1299  * @task_func: a #GTaskThreadFunc
1300  *
1301  * Runs @task_func in another thread. When @task_func returns, @task's
1302  * #GAsyncReadyCallback will be invoked in @task's #GMainContext.
1303  *
1304  * This takes a ref on @task until the task completes.
1305  *
1306  * See #GTaskThreadFunc for more details about how @task_func is handled.
1307  *
1308  * Since: 2.36
1309  */
1310 void
1311 g_task_run_in_thread (GTask           *task,
1312                       GTaskThreadFunc  task_func)
1313 {
1314   g_return_if_fail (G_IS_TASK (task));
1315
1316   g_object_ref (task);
1317   g_task_start_task_thread (task, task_func);
1318
1319   /* The task may already be cancelled, or g_thread_pool_push() may
1320    * have failed.
1321    */
1322   if (task->thread_complete)
1323     {
1324       g_mutex_unlock (&task->lock);
1325       g_task_return (task, G_TASK_RETURN_FROM_THREAD);
1326     }
1327   else
1328     g_mutex_unlock (&task->lock);
1329
1330   g_object_unref (task);
1331 }
1332
1333 /**
1334  * g_task_run_in_thread_sync:
1335  * @task: a #GTask
1336  * @task_func: a #GTaskThreadFunc
1337  *
1338  * Runs @task_func in another thread, and waits for it to return or be
1339  * cancelled. You can use g_task_propagate_pointer(), etc, afterward
1340  * to get the result of @task_func.
1341  *
1342  * See #GTaskThreadFunc for more details about how @task_func is handled.
1343  *
1344  * Normally this is used with tasks created with a %NULL
1345  * <literal>callback</literal>, but note that even if the task does
1346  * have a callback, it will not be invoked when @task_func returns.
1347  *
1348  * Since: 2.36
1349  */
1350 void
1351 g_task_run_in_thread_sync (GTask           *task,
1352                            GTaskThreadFunc  task_func)
1353 {
1354   g_return_if_fail (G_IS_TASK (task));
1355
1356   g_object_ref (task);
1357
1358   task->synchronous = TRUE;
1359   g_task_start_task_thread (task, task_func);
1360
1361   while (!task->thread_complete)
1362     g_cond_wait (&task->cond, &task->lock);
1363
1364   g_mutex_unlock (&task->lock);
1365   g_object_unref (task);
1366 }
1367
1368 /**
1369  * g_task_attach_source:
1370  * @task: a #GTask
1371  * @source: the source to attach
1372  * @callback: the callback to invoke when @source triggers
1373  *
1374  * A utility function for dealing with async operations where you need
1375  * to wait for a #GSource to trigger. Attaches @source to @task's
1376  * #GMainContext with @task's <link
1377  * linkend="io-priority">priority</link>, and sets @source's callback
1378  * to @callback, with @task as the callback's
1379  * <literal>user_data</literal>.
1380  *
1381  * This takes a reference on @task until @source is destroyed.
1382  *
1383  * Since: 2.36
1384  */
1385 void
1386 g_task_attach_source (GTask       *task,
1387                       GSource     *source,
1388                       GSourceFunc  callback)
1389 {
1390   g_source_set_callback (source, callback,
1391                          g_object_ref (task), g_object_unref);
1392   g_source_set_priority (source, task->priority);
1393   g_source_attach (source, task->context);
1394 }
1395
1396
1397 static gboolean
1398 g_task_propagate_error (GTask   *task,
1399                         GError **error)
1400 {
1401   if (task->check_cancellable &&
1402       g_cancellable_set_error_if_cancelled (task->cancellable, error))
1403     return TRUE;
1404   else if (task->error)
1405     {
1406       g_propagate_error (error, task->error);
1407       task->error = NULL;
1408       return TRUE;
1409     }
1410   else
1411     return FALSE;
1412 }
1413
1414 /**
1415  * g_task_return_pointer:
1416  * @task: a #GTask
1417  * @result: (allow-none) (transfer full): the pointer result of a task
1418  *     function
1419  * @result_destroy: (allow-none): a #GDestroyNotify function.
1420  *
1421  * Sets @task's result to @result and completes the task. If @result
1422  * is not %NULL, then @result_destroy will be used to free @result if
1423  * the caller does not take ownership of it with
1424  * g_task_propagate_pointer().
1425  *
1426  * "Completes the task" means that for an ordinary asynchronous task
1427  * it will either invoke the task's callback, or else queue that
1428  * callback to be invoked in the proper #GMainContext, or in the next
1429  * iteration of the current #GMainContext. For a task run via
1430  * g_task_run_in_thread() or g_task_run_in_thread_sync(), calling this
1431  * method will save @result to be returned to the caller later, but
1432  * the task will not actually be completed until the #GTaskThreadFunc
1433  * exits.
1434  *
1435  * Note that since the task may be completed before returning from
1436  * g_task_return_pointer(), you cannot assume that @result is still
1437  * valid after calling this, unless you are still holding another
1438  * reference on it.
1439  *
1440  * Since: 2.36
1441  */
1442 void
1443 g_task_return_pointer (GTask          *task,
1444                        gpointer        result,
1445                        GDestroyNotify  result_destroy)
1446 {
1447   g_return_if_fail (task->result_set == FALSE);
1448
1449   task->result.pointer = result;
1450   task->result_destroy = result_destroy;
1451
1452   g_task_return (task, G_TASK_RETURN_SUCCESS);
1453 }
1454
1455 /**
1456  * g_task_propagate_pointer:
1457  * @task: a #GTask
1458  * @error: return location for a #GError
1459  *
1460  * Gets the result of @task as a pointer, and transfers ownership
1461  * of that value to the caller.
1462  *
1463  * If the task resulted in an error, or was cancelled, then this will
1464  * instead return %NULL and set @error.
1465  *
1466  * Since this method transfers ownership of the return value (or
1467  * error) to the caller, you may only call it once.
1468  *
1469  * Returns: (transfer full): the task result, or %NULL on error
1470  *
1471  * Since: 2.36
1472  */
1473 gpointer
1474 g_task_propagate_pointer (GTask   *task,
1475                           GError **error)
1476 {
1477   if (g_task_propagate_error (task, error))
1478     return NULL;
1479
1480   g_return_val_if_fail (task->result_set == TRUE, NULL);
1481
1482   task->result_destroy = NULL;
1483   task->result_set = FALSE;
1484   return task->result.pointer;
1485 }
1486
1487 /**
1488  * g_task_return_int:
1489  * @task: a #GTask.
1490  * @result: the integer (#gssize) result of a task function.
1491  *
1492  * Sets @task's result to @result and completes the task (see
1493  * g_task_return_pointer() for more discussion of exactly what this
1494  * means).
1495  *
1496  * Since: 2.36
1497  */
1498 void
1499 g_task_return_int (GTask  *task,
1500                    gssize  result)
1501 {
1502   g_return_if_fail (task->result_set == FALSE);
1503
1504   task->result.size = result;
1505
1506   g_task_return (task, G_TASK_RETURN_SUCCESS);
1507 }
1508
1509 /**
1510  * g_task_propagate_int:
1511  * @task: a #GTask.
1512  * @error: return location for a #GError
1513  *
1514  * Gets the result of @task as an integer (#gssize).
1515  *
1516  * If the task resulted in an error, or was cancelled, then this will
1517  * instead return -1 and set @error.
1518  *
1519  * Since this method transfers ownership of the return value (or
1520  * error) to the caller, you may only call it once.
1521  *
1522  * Returns: the task result, or -1 on error
1523  *
1524  * Since: 2.36
1525  */
1526 gssize
1527 g_task_propagate_int (GTask   *task,
1528                       GError **error)
1529 {
1530   if (g_task_propagate_error (task, error))
1531     return -1;
1532
1533   g_return_val_if_fail (task->result_set == TRUE, -1);
1534
1535   task->result_set = FALSE;
1536   return task->result.size;
1537 }
1538
1539 /**
1540  * g_task_return_boolean:
1541  * @task: a #GTask.
1542  * @result: the #gboolean result of a task function.
1543  *
1544  * Sets @task's result to @result and completes the task (see
1545  * g_task_return_pointer() for more discussion of exactly what this
1546  * means).
1547  *
1548  * Since: 2.36
1549  */
1550 void
1551 g_task_return_boolean (GTask    *task,
1552                        gboolean  result)
1553 {
1554   g_return_if_fail (task->result_set == FALSE);
1555
1556   task->result.boolean = result;
1557
1558   g_task_return (task, G_TASK_RETURN_SUCCESS);
1559 }
1560
1561 /**
1562  * g_task_propagate_boolean:
1563  * @task: a #GTask.
1564  * @error: return location for a #GError
1565  *
1566  * Gets the result of @task as a #gboolean.
1567  *
1568  * If the task resulted in an error, or was cancelled, then this will
1569  * instead return %FALSE and set @error.
1570  *
1571  * Since this method transfers ownership of the return value (or
1572  * error) to the caller, you may only call it once.
1573  *
1574  * Returns: the task result, or %FALSE on error
1575  *
1576  * Since: 2.36
1577  */
1578 gboolean
1579 g_task_propagate_boolean (GTask   *task,
1580                           GError **error)
1581 {
1582   if (g_task_propagate_error (task, error))
1583     return FALSE;
1584
1585   g_return_val_if_fail (task->result_set == TRUE, FALSE);
1586
1587   task->result_set = FALSE;
1588   return task->result.boolean;
1589 }
1590
1591 /**
1592  * g_task_return_error:
1593  * @task: a #GTask.
1594  * @error: (transfer full): the #GError result of a task function.
1595  *
1596  * Sets @task's result to @error (which @task assumes ownership of)
1597  * and completes the task (see g_task_return_pointer() for more
1598  * discussion of exactly what this means).
1599  *
1600  * Note that since the task takes ownership of @error, and since the
1601  * task may be completed before returning from g_task_return_error(),
1602  * you cannot assume that @error is still valid after calling this.
1603  * Call g_error_copy() on the error if you need to keep a local copy
1604  * as well.
1605  *
1606  * See also g_task_return_new_error().
1607  *
1608  * Since: 2.36
1609  */
1610 void
1611 g_task_return_error (GTask  *task,
1612                      GError *error)
1613 {
1614   g_return_if_fail (task->result_set == FALSE);
1615   g_return_if_fail (error != NULL);
1616
1617   task->error = error;
1618
1619   g_task_return (task, G_TASK_RETURN_ERROR);
1620 }
1621
1622 /**
1623  * g_task_return_new_error:
1624  * @task: a #GTask.
1625  * @domain: a #GQuark.
1626  * @code: an error code.
1627  * @format: a string with format characters.
1628  * @...: a list of values to insert into @format.
1629  *
1630  * Sets @task's result to a new #GError created from @domain, @code,
1631  * @format, and the remaining arguments, and completes the task (see
1632  * g_task_return_pointer() for more discussion of exactly what this
1633  * means).
1634  *
1635  * See also g_task_return_error().
1636  *
1637  * Since: 2.36
1638  */
1639 void
1640 g_task_return_new_error (GTask           *task,
1641                          GQuark           domain,
1642                          gint             code,
1643                          const char      *format,
1644                          ...)
1645 {
1646   GError *error;
1647   va_list args;
1648
1649   va_start (args, format);
1650   error = g_error_new_valist (domain, code, format, args);
1651   va_end (args);
1652
1653   g_task_return_error (task, error);
1654 }
1655
1656 /**
1657  * g_task_return_error_if_cancelled:
1658  * @task: a #GTask
1659  *
1660  * Checks if @task's #GCancellable has been cancelled, and if so, sets
1661  * @task's error accordingly and completes the task (see
1662  * g_task_return_pointer() for more discussion of exactly what this
1663  * means).
1664  *
1665  * Return value: %TRUE if @task has been cancelled, %FALSE if not
1666  *
1667  * Since: 2.36
1668  */
1669 gboolean
1670 g_task_return_error_if_cancelled (GTask *task)
1671 {
1672   GError *error = NULL;
1673
1674   g_return_val_if_fail (task->result_set == FALSE, FALSE);
1675
1676   if (g_cancellable_set_error_if_cancelled (task->cancellable, &error))
1677     {
1678       /* We explicitly set task->error so this works even when
1679        * check-cancellable is not set.
1680        */
1681       g_clear_error (&task->error);
1682       task->error = error;
1683
1684       g_task_return (task, G_TASK_RETURN_ERROR);
1685       return TRUE;
1686     }
1687   else
1688     return FALSE;
1689 }
1690
1691 /**
1692  * g_task_had_error:
1693  * @task: a #GTask.
1694  *
1695  * Tests if @task resulted in an error.
1696  *
1697  * Returns: %TRUE if the task resulted in an error, %FALSE otherwise.
1698  *
1699  * Since: 2.36
1700  */
1701 gboolean
1702 g_task_had_error (GTask *task)
1703 {
1704   if (task->error != NULL)
1705     return TRUE;
1706
1707   if (task->check_cancellable && g_cancellable_is_cancelled (task->cancellable))
1708     return TRUE;
1709
1710   return FALSE;
1711 }
1712
1713 /**
1714  * g_task_is_valid:
1715  * @result: (type Gio.AsyncResult): A #GAsyncResult
1716  * @source_object: (allow-none): the source object expected to be
1717  *   associated with the task
1718  *
1719  * Checks that @result is a #GTask, and that @source_object is its
1720  * source object (or that @source_object is %NULL and @result has no
1721  * source object). This can be used in g_return_if_fail() checks.
1722  *
1723  * Return value: %TRUE if @result and @source_object are valid, %FALSE
1724  * if not
1725  *
1726  * Since: 2.36
1727  */
1728 gboolean
1729 g_task_is_valid (gpointer result,
1730                  gpointer source_object)
1731 {
1732   if (!G_IS_TASK (result))
1733     return FALSE;
1734
1735   return G_TASK (result)->source_object == source_object;
1736 }
1737
1738 static gint
1739 g_task_compare_priority (gconstpointer a,
1740                          gconstpointer b,
1741                          gpointer      user_data)
1742 {
1743   const GTask *ta = a;
1744   const GTask *tb = b;
1745   gboolean a_cancelled, b_cancelled;
1746
1747   a_cancelled = (ta->check_cancellable &&
1748                  g_cancellable_is_cancelled (ta->cancellable));
1749   b_cancelled = (tb->check_cancellable &&
1750                  g_cancellable_is_cancelled (tb->cancellable));
1751
1752   /* Let already-cancelled tasks finish right away */
1753   if (a_cancelled && !b_cancelled)
1754     return -1;
1755   else if (b_cancelled && !a_cancelled)
1756     return 1;
1757
1758   /* Lower priority == run sooner == negative return value */
1759   return ta->priority - tb->priority;
1760 }
1761
1762 static void
1763 g_task_thread_pool_init (void)
1764 {
1765   task_pool = g_thread_pool_new (g_task_thread_pool_thread, NULL,
1766                                  10, FALSE, NULL);
1767   g_assert (task_pool != NULL);
1768
1769   g_thread_pool_set_sort_function (task_pool, g_task_compare_priority, NULL);
1770 }
1771
1772 static void
1773 g_task_thread_pool_resort (void)
1774 {
1775   g_thread_pool_set_sort_function (task_pool, g_task_compare_priority, NULL);
1776 }
1777
1778 static void
1779 g_task_class_init (GTaskClass *klass)
1780 {
1781   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
1782
1783   gobject_class->finalize = g_task_finalize;
1784 }
1785
1786 static gpointer
1787 g_task_get_user_data (GAsyncResult *res)
1788 {
1789   return G_TASK (res)->callback_data;
1790 }
1791
1792 static gboolean
1793 g_task_is_tagged (GAsyncResult *res,
1794                   gpointer      source_tag)
1795 {
1796   return G_TASK (res)->source_tag == source_tag;
1797 }
1798
1799 static void
1800 g_task_async_result_iface_init (GAsyncResultIface *iface)
1801 {
1802   iface->get_user_data = g_task_get_user_data;
1803   iface->get_source_object = g_task_ref_source_object;
1804   iface->is_tagged = g_task_is_tagged;
1805 }