GAsyncResult

## GAsyncResult GAsyncResult — Asynchronous Function Results |

## Synopsis

    #include <gio/gio.h>

                        GAsyncResult;
    struct              GAsyncResultIface;
    void                (*GAsyncReadyCallback)              (GObject *source_object,
                                                             GAsyncResult *res,
                                                             gpointer user_data);
    gpointer            g_async_result_get_user_data        (GAsyncResult *res);
    GObject *           g_async_result_get_source_object    (GAsyncResult *res);

## Object Hierarchy

      GInterface
       +----GAsyncResult

## Prerequisites

GAsyncResult requires GObject.

## Known Implementations

GAsyncResult is implemented by GSimpleAsyncResult.

## Description

Provides a base class for implementing asynchronous function results.

Asynchronous operations are broken up into two separate operations which are chained together by a GAsyncReadyCallback. To begin an asynchronous operation, provide a GAsyncReadyCallback to the asynchronous function. This callback will be triggered when the operation has completed, and will be passed a GAsyncResult instance filled with the details of the operation's success or failure, the object the asynchronous function was started for and any error codes returned. The asynchronous callback function is then expected to call the corresponding "`_finish()`" function, passing the object the function was called for, the GAsyncResult instance, and (optionally) an `error` to grab any error conditions that may have occurred.

The "`_finish()`" function for an operation takes the generic result (of type GAsyncResult) and returns the specific result that the operation in question yields (e.g. a GFileEnumerator for a "enumerate children" operation). If the result or error status of the operation is not needed, there is no need to call the "`_finish()`" function; GIO will take care of cleaning up the result and error information after the GAsyncReadyCallback returns. You can pass `NULL` for the GAsyncReadyCallback if you don't need to take any action at all after the operation completes. Applications may also take a reference to the GAsyncResult and call "`_finish()`" later; however, the "`_finish()`" function may be called at most once.

Example of a typical asynchronous operation flow:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    void _theoretical_frobnitz_async (Theoretical         *t,
                                      GCancellable        *c,
                                      GAsyncReadyCallback *cb,
                                      gpointer             u);

    gboolean _theoretical_frobnitz_finish (Theoretical   *t,
                                           GAsyncResult  *res,
                                           GError       **e);

    static void
    frobnitz_result_func (GObject      *source_object,
             GAsyncResult *res,
             gpointer      user_data)
    {
      gboolean success = FALSE;

      success = _theoretical_frobnitz_finish (source_object, res, NULL);

      if (success)
        g_printf ("Hurray!\n");
      else
        g_printf ("Uh oh!\n");

      /* ... */

    }

    int main (int argc, void *argv[])
    {
       /* ... */

       _theoretical_frobnitz_async (theoretical_data,
                                    NULL,
                                    frobnitz_result_func,
                                    NULL);

       /* ... */
    }

The callback for an asynchronous operation is called only once, and is always called, even in the case of a cancelled operation. On cancellation the result is a `G_IO_ERROR_CANCELLED` error.

Some asynchronous operations are implemented using synchronous calls. These are run in a separate thread, if GThread has been initialized, but otherwise they are sent to the Main Event Loop and processed in an idle function. So, if you truly need asynchronous operations, make sure to initialize GThread.

## Details

### GAsyncResult

    typedef struct _GAsyncResult GAsyncResult;

Holds results information for an asynchronous operation, usually passed directly to a asynchronous `_finish()` operation.

### struct GAsyncResultIface

    struct GAsyncResultIface {
      GTypeInterface g_iface;

      /* Virtual Table */

      gpointer  (* get_user_data)     (GAsyncResult *res);
      GObject * (* get_source_object) (GAsyncResult *res);
    };

Interface definition for GAsyncResult.

GTypeInterface `g_iface`; | The parent interface.
`get_user_data` () | Gets the user data passed to the callback.
`get_source_object` () | Gets the source object that issued the asynchronous operation.

### GAsyncReadyCallback ()

    void                (*GAsyncReadyCallback)              (GObject *source_object,
                                                             GAsyncResult *res,
                                                             gpointer user_data);

Type definition for a function that will be called back when an asynchronous operation within GIO has been completed.

`source_object` : | the object the asynchronous operation was started with.
`res` : | a GAsyncResult.
`user_data` : | user data passed to the callback.

### g_async_result_get_user_data ()

    gpointer            g_async_result_get_user_data        (GAsyncResult *res);

Gets the user data from a GAsyncResult.

`res` : | a GAsyncResult.
Returns : | the user data for `res`. [transfer full]

### g_async_result_get_source_object ()

    GObject *           g_async_result_get_source_object    (GAsyncResult *res);

Gets the source object from a GAsyncResult.

`res` : | a GAsyncResult
Returns : | a new reference to the source object for the `res`, or `NULL` if there is none. [transfer full]

## See Also

GSimpleAsyncResult