GAsyncInitable

typedef struct _GAsyncInitable GAsyncInitable;

Interface for asynchronously initializable objects.

Since 2.22

struct GAsyncInitableIface

struct GAsyncInitableIface {
  GTypeInterface g_iface;

  /* Virtual Table */

  void     (* init_async)  (GAsyncInitable      *initable,
			    int                  io_priority,
			    GCancellable        *cancellable,
			    GAsyncReadyCallback  callback,
			    gpointer             user_data);
  gboolean (* init_finish) (GAsyncInitable      *initable,
			    GAsyncResult        *res,
			    GError             **error);
};

Provides an interface for asynchronous initializing object such that initialization may fail.

Since 2.22

g_async_initable_init_async ()

void                g_async_initable_init_async         (GAsyncInitable *initable,
                                                         int io_priority,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Starts asynchronous initialization of the object implementing the interface. This must be done before any real use of the object after initial construction. If the object also implements GInitable you can optionally call g_initable_init() instead.

When the initialization is finished, callback will be called. You can then call g_async_initable_init_finish() to get the result of the initialization.

Implementations may also support cancellation. If cancellable is not NULL, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error G_IO_ERROR_CANCELLED will be returned. If cancellable is not NULL, and the object doesn't support cancellable initialization, the error G_IO_ERROR_NOT_SUPPORTED will be returned.

If this function is not called, or returns with an error, then all operations on the object should fail, generally returning the error G_IO_ERROR_NOT_INITIALIZED.

Implementations of this method must be idempotent: i.e. multiple calls to this function with the same argument should return the same results. Only the first call initializes the object; further calls return the result of the first call. This is so that it's safe to implement the singleton pattern in the GObject constructor function.

For classes that also support the GInitable interface, the default implementation of this method will run the g_initable_init() function in a thread, so if you want to support asynchronous initialization via threads, just implement the GAsyncInitable interface without overriding any interface methods.

Since 2.22

g_async_initable_init_finish ()

gboolean            g_async_initable_init_finish        (GAsyncInitable *initable,
                                                         GAsyncResult *res,
                                                         GError **error);

Finishes asynchronous initialization and returns the result. See g_async_initable_init_async().

Since 2.22

g_async_initable_new_async ()

void                g_async_initable_new_async          (GType object_type,
                                                         int io_priority,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data,
                                                         const gchar *first_property_name,
                                                         ...);

Helper function for constructing GAsyncInitable object. This is similar to g_object_new() but also initializes the object asynchronously.

When the initialization is finished, callback will be called. You can then call g_async_initable_new_finish() to get the new object and check for any errors.

Since 2.22

g_async_initable_new_finish ()

GObject *           g_async_initable_new_finish         (GAsyncInitable *initable,
                                                         GAsyncResult *res,
                                                         GError **error);

Finishes the async construction for the various g_async_initable_new calls, returning the created object or NULL on error.

Since 2.22

g_async_initable_new_valist_async ()

void                g_async_initable_new_valist_async   (GType object_type,
                                                         const gchar *first_property_name,
                                                         va_list var_args,
                                                         int io_priority,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Helper function for constructing GAsyncInitable object. This is similar to g_object_new_valist() but also initializes the object asynchronously.

When the initialization is finished, callback will be called. You can then call g_async_initable_new_finish() to get the new object and check for any errors.

Since 2.22

g_async_initable_newv_async ()

void                g_async_initable_newv_async         (GType object_type,
                                                         guint n_parameters,
                                                         GParameter *parameters,
                                                         int io_priority,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Helper function for constructing GAsyncInitable object. This is similar to g_object_newv() but also initializes the object asynchronously.

When the initialization is finished, callback will be called. You can then call g_async_initable_new_finish() to get the new object and check for any errors.

Since 2.22