gio: add g_async_result_is_tagged()
[platform/upstream/glib.git] / gio / gasyncresult.h
1 /* GIO - GLib Input, Output and Streaming Library
2  *
3  * Copyright (C) 2006-2007 Red Hat, Inc.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General
16  * Public License along with this library; if not, write to the
17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18  * Boston, MA 02111-1307, USA.
19  *
20  * Author: Alexander Larsson <alexl@redhat.com>
21  */
22
23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
24 #error "Only <gio/gio.h> can be included directly."
25 #endif
26
27 #ifndef __G_ASYNC_RESULT_H__
28 #define __G_ASYNC_RESULT_H__
29
30 #include <gio/giotypes.h>
31
32 G_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
39 /**
40  * GAsyncResult:
41  *
42  * Holds results information for an asynchronous operation,
43  * usually passed directly to a asynchronous _finish() operation.
44  **/
45 typedef struct _GAsyncResultIface    GAsyncResultIface;
46
47
48 /**
49  * GAsyncResultIface:
50  * @g_iface: The parent interface.
51  * @get_user_data: Gets the user data passed to the callback.
52  * @get_source_object: Gets the source object that issued the asynchronous operation.
53  * @is_tagged: Checks if a result is tagged with a particular source.
54  *
55  * Interface definition for #GAsyncResult.
56  **/
57 struct _GAsyncResultIface
58 {
59   GTypeInterface g_iface;
60
61   /* Virtual Table */
62
63   gpointer  (* get_user_data)     (GAsyncResult *res);
64   GObject * (* get_source_object) (GAsyncResult *res);
65
66   gboolean  (* is_tagged)         (GAsyncResult *res,
67                                    gpointer      tag);
68 };
69
70 GType    g_async_result_get_type          (void) G_GNUC_CONST;
71
72 gpointer g_async_result_get_user_data     (GAsyncResult *res);
73 GObject *g_async_result_get_source_object (GAsyncResult *res);
74
75 GLIB_AVAILABLE_IN_2_34
76 gboolean g_async_result_legacy_propagate_error (GAsyncResult  *res,
77                                                 GError       **error);
78 GLIB_AVAILABLE_IN_2_34
79 gboolean g_async_result_is_tagged              (GAsyncResult  *res,
80                                                 gpointer       source_tag);
81
82 G_END_DECLS
83
84 #endif /* __G_ASYNC_RESULT_H__ */