glib-2.0/gio/gasyncinitable.h

0001 /* GIO - GLib Input, Output and Streaming Library
0002  *
0003  * Copyright (C) 2009 Red Hat, Inc.
0004  *
0005  * SPDX-License-Identifier: LGPL-2.1-or-later
0006  *
0007  * This library is free software; you can redistribute it and/or
0008  * modify it under the terms of the GNU Lesser General Public
0009  * License as published by the Free Software Foundation; either
0010  * version 2.1 of the License, or (at your option) any later version.
0011  *
0012  * This library is distributed in the hope that it will be useful,
0013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0015  * Lesser General Public License for more details.
0016  *
0017  * You should have received a copy of the GNU Lesser General
0018  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
0019  *
0020  * Author: Alexander Larsson <alexl@redhat.com>
0021  */
0022
0023 #ifndef __G_ASYNC_INITABLE_H__
0024 #define __G_ASYNC_INITABLE_H__
0025
0026 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
0027 #error "Only <gio/gio.h> can be included directly."
0028 #endif
0029
0030 #include <gio/giotypes.h>
0031 #include <gio/ginitable.h>
0032
0033 G_BEGIN_DECLS
0034
0035 #define G_TYPE_ASYNC_INITABLE            (g_async_initable_get_type ())
0036 #define G_ASYNC_INITABLE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_ASYNC_INITABLE, GAsyncInitable))
0037 #define G_IS_ASYNC_INITABLE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_ASYNC_INITABLE))
0038 #define G_ASYNC_INITABLE_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_ASYNC_INITABLE, GAsyncInitableIface))
0039 #define G_TYPE_IS_ASYNC_INITABLE(type)   (g_type_is_a ((type), G_TYPE_ASYNC_INITABLE))
0040
0041 typedef struct _GAsyncInitableIface GAsyncInitableIface;
0042
0043 /**
0044  * GAsyncInitableIface:
0045  * @g_iface: The parent interface.
0046  * @init_async: Starts initialization of the object.
0047  * @init_finish: Finishes initialization of the object.
0048  *
0049  * Provides an interface for asynchronous initializing object such that
0050  * initialization may fail.
0051  *
0052  * Since: 2.22
0053  **/
0054 struct _GAsyncInitableIface
0055 {
0056   GTypeInterface g_iface;
0057
0058   /* Virtual Table */
0059
0060   void     (* init_async)  (GAsyncInitable      *initable,
0061                 int                  io_priority,
0062                 GCancellable        *cancellable,
0063                 GAsyncReadyCallback  callback,
0064                 gpointer             user_data);
0065   gboolean (* init_finish) (GAsyncInitable      *initable,
0066                 GAsyncResult        *res,
0067                 GError             **error);
0068 };
0069
0070 GIO_AVAILABLE_IN_ALL
0071 GType    g_async_initable_get_type    (void) G_GNUC_CONST;
0072
0073
0074 GIO_AVAILABLE_IN_ALL
0075 void     g_async_initable_init_async       (GAsyncInitable       *initable,
0076                         int                   io_priority,
0077                         GCancellable         *cancellable,
0078                         GAsyncReadyCallback   callback,
0079                         gpointer              user_data);
0080 GIO_AVAILABLE_IN_ALL
0081 gboolean g_async_initable_init_finish      (GAsyncInitable       *initable,
0082                         GAsyncResult         *res,
0083                         GError              **error);
0084
0085 GIO_AVAILABLE_IN_ALL
0086 void     g_async_initable_new_async        (GType                 object_type,
0087                         int                   io_priority,
0088                         GCancellable         *cancellable,
0089                         GAsyncReadyCallback   callback,
0090                         gpointer              user_data,
0091                         const gchar          *first_property_name,
0092                         ...);
0093
0094 G_GNUC_BEGIN_IGNORE_DEPRECATIONS
0095
0096 GIO_DEPRECATED_IN_2_54_FOR(g_object_new_with_properties and g_async_initable_init_async)
0097 void     g_async_initable_newv_async       (GType                 object_type,
0098                         guint                 n_parameters,
0099                         GParameter           *parameters,
0100                         int                   io_priority,
0101                         GCancellable         *cancellable,
0102                         GAsyncReadyCallback   callback,
0103                         gpointer              user_data);
0104
0105 G_GNUC_END_IGNORE_DEPRECATIONS
0106
0107 GIO_AVAILABLE_IN_ALL
0108 void     g_async_initable_new_valist_async (GType                 object_type,
0109                         const gchar          *first_property_name,
0110                         va_list               var_args,
0111                         int                   io_priority,
0112                         GCancellable         *cancellable,
0113                         GAsyncReadyCallback   callback,
0114                         gpointer              user_data);
0115 GIO_AVAILABLE_IN_ALL
0116 GObject *g_async_initable_new_finish       (GAsyncInitable       *initable,
0117                         GAsyncResult         *res,
0118                         GError              **error);
0119
0120
0121
0122 G_END_DECLS
0123
0124
0125 #endif /* __G_ASYNC_INITABLE_H__ */