1/* GIO - GLib Input, Output and Streaming Library
2 *
3 * Copyright (C) 2006-2007 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_RESULT_H__
24#define __G_ASYNC_RESULT_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
32G_BEGIN_DECLS
33
34#define G_TYPE_ASYNC_RESULT (g_async_result_get_type ())
35#define G_ASYNC_RESULT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_ASYNC_RESULT, GAsyncResult))
36#define G_IS_ASYNC_RESULT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_ASYNC_RESULT))
37#define G_ASYNC_RESULT_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_ASYNC_RESULT, GAsyncResultIface))
38
39typedef struct _GAsyncResultIface GAsyncResultIface;
40
41
42/**
43 * GAsyncResultIface:
44 * @g_iface: The parent interface.
45 * @get_user_data: Gets the user data passed to the callback.
46 * @get_source_object: Gets the source object that issued the asynchronous operation.
47 * @is_tagged: Checks if a result is tagged with a particular source.
48 *
49 * Interface definition for #GAsyncResult.
50 **/
51struct _GAsyncResultIface
52{
53 GTypeInterface g_iface;
54
55 /* Virtual Table */
56
57 gpointer (* get_user_data) (GAsyncResult *res);
58 GObject * (* get_source_object) (GAsyncResult *res);
59
60 gboolean (* is_tagged) (GAsyncResult *res,
61 gpointer source_tag);
62};
63
64GIO_AVAILABLE_IN_ALL
65GType g_async_result_get_type (void) G_GNUC_CONST;
66
67GIO_AVAILABLE_IN_ALL
68gpointer g_async_result_get_user_data (GAsyncResult *res);
69GIO_AVAILABLE_IN_ALL
70GObject *g_async_result_get_source_object (GAsyncResult *res);
71
72GIO_AVAILABLE_IN_2_34
73gboolean g_async_result_legacy_propagate_error (GAsyncResult *res,
74 GError **error);
75GIO_AVAILABLE_IN_2_34
76gboolean g_async_result_is_tagged (GAsyncResult *res,
77 gpointer source_tag);
78
79G_END_DECLS
80
81#endif /* __G_ASYNC_RESULT_H__ */
82