glib (2.79.0)
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 typedef struct _GAsyncInitableIface GAsyncInitableIface;
42
43 /**
44 * GAsyncInitableIface:
45 * @g_iface: The parent interface.
46 * @init_async: Starts initialization of the object.
47 * @init_finish: Finishes initialization of the object.
48 *
49 * Provides an interface for asynchronous initializing object such that
50 * initialization may fail.
51 *
52 * Since: 2.22
53 **/
54 struct _GAsyncInitableIface
55 {
56 GTypeInterface g_iface;
57
58 /* Virtual Table */
59
60 void (* init_async) (GAsyncInitable *initable,
61 int io_priority,
62 GCancellable *cancellable,
63 GAsyncReadyCallback callback,
64 gpointer user_data);
65 gboolean (* init_finish) (GAsyncInitable *initable,
66 GAsyncResult *res,
67 GError **error);
68 };
69
70 GIO_AVAILABLE_IN_ALL
71 GType g_async_initable_get_type (void) G_GNUC_CONST;
72
73
74 GIO_AVAILABLE_IN_ALL
75 void g_async_initable_init_async (GAsyncInitable *initable,
76 int io_priority,
77 GCancellable *cancellable,
78 GAsyncReadyCallback callback,
79 gpointer user_data);
80 GIO_AVAILABLE_IN_ALL
81 gboolean g_async_initable_init_finish (GAsyncInitable *initable,
82 GAsyncResult *res,
83 GError **error);
84
85 GIO_AVAILABLE_IN_ALL
86 void g_async_initable_new_async (GType object_type,
87 int io_priority,
88 GCancellable *cancellable,
89 GAsyncReadyCallback callback,
90 gpointer user_data,
91 const gchar *first_property_name,
92 ...);
93
94 G_GNUC_BEGIN_IGNORE_DEPRECATIONS
95
96 GIO_DEPRECATED_IN_2_54_FOR(g_object_new_with_properties and g_async_initable_init_async)
97 void g_async_initable_newv_async (GType object_type,
98 guint n_parameters,
99 GParameter *parameters,
100 int io_priority,
101 GCancellable *cancellable,
102 GAsyncReadyCallback callback,
103 gpointer user_data);
104
105 G_GNUC_END_IGNORE_DEPRECATIONS
106
107 GIO_AVAILABLE_IN_ALL
108 void g_async_initable_new_valist_async (GType object_type,
109 const gchar *first_property_name,
110 va_list var_args,
111 int io_priority,
112 GCancellable *cancellable,
113 GAsyncReadyCallback callback,
114 gpointer user_data);
115 GIO_AVAILABLE_IN_ALL
116 GObject *g_async_initable_new_finish (GAsyncInitable *initable,
117 GAsyncResult *res,
118 GError **error);
119
120
121
122 G_END_DECLS
123
124
125 #endif /* __G_ASYNC_INITABLE_H__ */
Browse
Usage
Versions