glib-2.0/gio/gasyncresult.h

0001 /* GIO - GLib Input, Output and Streaming Library
0002  *
0003  * Copyright (C) 2006-2007 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_RESULT_H__
0024 #define __G_ASYNC_RESULT_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
0032 G_BEGIN_DECLS
0033
0034 #define G_TYPE_ASYNC_RESULT            (g_async_result_get_type ())
0035 #define G_ASYNC_RESULT(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_ASYNC_RESULT, GAsyncResult))
0036 #define G_IS_ASYNC_RESULT(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_ASYNC_RESULT))
0037 #define G_ASYNC_RESULT_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_ASYNC_RESULT, GAsyncResultIface))
0038
0039 typedef struct _GAsyncResultIface    GAsyncResultIface;
0040
0041
0042 /**
0043  * GAsyncResultIface:
0044  * @g_iface: The parent interface.
0045  * @get_user_data: Gets the user data passed to the callback.
0046  * @get_source_object: Gets the source object that issued the asynchronous operation.
0047  * @is_tagged: Checks if a result is tagged with a particular source.
0048  *
0049  * Interface definition for [iface@Gio.AsyncResult].
0050  **/
0051 struct _GAsyncResultIface
0052 {
0053   GTypeInterface g_iface;
0054
0055   /* Virtual Table */
0056
0057   gpointer  (* get_user_data)     (GAsyncResult *res);
0058   GObject * (* get_source_object) (GAsyncResult *res);
0059
0060   gboolean  (* is_tagged)         (GAsyncResult *res,
0061                    gpointer      source_tag);
0062 };
0063
0064 GIO_AVAILABLE_IN_ALL
0065 GType    g_async_result_get_type          (void) G_GNUC_CONST;
0066
0067 GIO_AVAILABLE_IN_ALL
0068 gpointer g_async_result_get_user_data     (GAsyncResult *res);
0069 GIO_AVAILABLE_IN_ALL
0070 GObject *g_async_result_get_source_object (GAsyncResult *res);
0071
0072 GIO_AVAILABLE_IN_2_34
0073 gboolean g_async_result_legacy_propagate_error (GAsyncResult  *res,
0074                         GError       **error);
0075 GIO_AVAILABLE_IN_2_34
0076 gboolean g_async_result_is_tagged              (GAsyncResult  *res,
0077                         gpointer       source_tag);
0078
0079 G_END_DECLS
0080
0081 #endif /* __G_ASYNC_RESULT_H__ */