gio/gasyncinitable.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2009 Red Hat, Inc.
   4  *
   5  * SPDX-License-Identifier: LGPL-2.1-or-later
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General
  18  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  19  *
  20  * Author: Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 #ifndef __G_ASYNC_INITABLE_H__
  24 #define __G_ASYNC_INITABLE_H__
  25
  26 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  27 #error "Only <gio/gio.h> can be included directly."
  28 #endif
  29
  30 #include <gio/giotypes.h>
  31 #include <gio/ginitable.h>
  32
  33 G_BEGIN_DECLS
  34
  35 #define G_TYPE_ASYNC_INITABLE            (g_async_initable_get_type ())
  36 #define G_ASYNC_INITABLE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_ASYNC_INITABLE, GAsyncInitable))
  37 #define G_IS_ASYNC_INITABLE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_ASYNC_INITABLE))
  38 #define G_ASYNC_INITABLE_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_ASYNC_INITABLE, GAsyncInitableIface))
  39 #define G_TYPE_IS_ASYNC_INITABLE(type)   (g_type_is_a ((type), G_TYPE_ASYNC_INITABLE))
  40
  41 /**
  42  * GAsyncInitable:
  43  *
  44  * Interface for asynchronously initializable objects.
  45  *
  46  * Since: 2.22
  47  **/
  48 typedef struct _GAsyncInitableIface GAsyncInitableIface;
  49
  50 /**
  51  * GAsyncInitableIface:
  52  * @g_iface: The parent interface.
  53  * @init_async: Starts initialization of the object.
  54  * @init_finish: Finishes initialization of the object.
  55  *
  56  * Provides an interface for asynchronous initializing object such that
  57  * initialization may fail.
  58  *
  59  * Since: 2.22
  60  **/
  61 struct _GAsyncInitableIface
  62 {
  63   GTypeInterface g_iface;
  64
  65   /* Virtual Table */
  66
  67   void     (* init_async)  (GAsyncInitable      *initable,
  68                             int                  io_priority,
  69                             GCancellable        *cancellable,
  70                             GAsyncReadyCallback  callback,
  71                             gpointer             user_data);
  72   gboolean (* init_finish) (GAsyncInitable      *initable,
  73                             GAsyncResult        *res,
  74                             GError             **error);
  75 };
  76
  77 GLIB_AVAILABLE_IN_ALL
  78 GType    g_async_initable_get_type    (void) G_GNUC_CONST;
  79
  80
  81 GLIB_AVAILABLE_IN_ALL
  82 void     g_async_initable_init_async       (GAsyncInitable       *initable,
  83                                             int                   io_priority,
  84                                             GCancellable         *cancellable,
  85                                             GAsyncReadyCallback   callback,
  86                                             gpointer              user_data);
  87 GLIB_AVAILABLE_IN_ALL
  88 gboolean g_async_initable_init_finish      (GAsyncInitable       *initable,
  89                                             GAsyncResult         *res,
  90                                             GError              **error);
  91
  92 GLIB_AVAILABLE_IN_ALL
  93 void     g_async_initable_new_async        (GType                 object_type,
  94                                             int                   io_priority,
  95                                             GCancellable         *cancellable,
  96                                             GAsyncReadyCallback   callback,
  97                                             gpointer              user_data,
  98                                             const gchar          *first_property_name,
  99                                             ...);
 100
 101 G_GNUC_BEGIN_IGNORE_DEPRECATIONS
 102
 103 GLIB_DEPRECATED_IN_2_54_FOR(g_object_new_with_properties and g_async_initable_init_async)
 104 void     g_async_initable_newv_async       (GType                 object_type,
 105                                             guint                 n_parameters,
 106                                             GParameter           *parameters,
 107                                             int                   io_priority,
 108                                             GCancellable         *cancellable,
 109                                             GAsyncReadyCallback   callback,
 110                                             gpointer              user_data);
 111
 112 G_GNUC_END_IGNORE_DEPRECATIONS
 113
 114 GLIB_AVAILABLE_IN_ALL
 115 void     g_async_initable_new_valist_async (GType                 object_type,
 116                                             const gchar          *first_property_name,
 117                                             va_list               var_args,
 118                                             int                   io_priority,
 119                                             GCancellable         *cancellable,
 120                                             GAsyncReadyCallback   callback,
 121                                             gpointer              user_data);
 122 GLIB_AVAILABLE_IN_ALL
 123 GObject *g_async_initable_new_finish       (GAsyncInitable       *initable,
 124                                             GAsyncResult         *res,
 125                                             GError              **error);
 126
 127
 128
 129 G_END_DECLS
 130
 131
 132 #endif /* __G_ASYNC_INITABLE_H__ */