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.1 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, see <http://www.gnu.org/licenses/>. 17 * 18 * Author: Alexander Larsson <alexl@redhat.com> 19 */ 20 21 #ifndef __G_ASYNC_RESULT_H__ 22 #define __G_ASYNC_RESULT_H__ 23 24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION) 25 #error "Only <gio/gio.h> can be included directly." 26 #endif 27 28 #include <gio/giotypes.h> 29 30 G_BEGIN_DECLS 31 32 #define G_TYPE_ASYNC_RESULT (g_async_result_get_type ()) 33 #define G_ASYNC_RESULT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_ASYNC_RESULT, GAsyncResult)) 34 #define G_IS_ASYNC_RESULT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_ASYNC_RESULT)) 35 #define G_ASYNC_RESULT_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_ASYNC_RESULT, GAsyncResultIface)) 36 37 /** 38 * GAsyncResult: 39 * 40 * Holds results information for an asynchronous operation, 41 * usually passed directly to an asynchronous _finish() operation. 42 **/ 43 typedef struct _GAsyncResultIface GAsyncResultIface; 44 45 46 /** 47 * GAsyncResultIface: 48 * @g_iface: The parent interface. 49 * @get_user_data: Gets the user data passed to the callback. 50 * @get_source_object: Gets the source object that issued the asynchronous operation. 51 * @is_tagged: Checks if a result is tagged with a particular source. 52 * 53 * Interface definition for #GAsyncResult. 54 **/ 55 struct _GAsyncResultIface 56 { 57 GTypeInterface g_iface; 58 59 /* Virtual Table */ 60 61 gpointer (* get_user_data) (GAsyncResult *res); 62 GObject * (* get_source_object) (GAsyncResult *res); 63 64 gboolean (* is_tagged) (GAsyncResult *res, 65 gpointer source_tag); 66 }; 67 68 GLIB_AVAILABLE_IN_ALL 69 GType g_async_result_get_type (void) G_GNUC_CONST; 70 71 GLIB_AVAILABLE_IN_ALL 72 gpointer g_async_result_get_user_data (GAsyncResult *res); 73 GLIB_AVAILABLE_IN_ALL 74 GObject *g_async_result_get_source_object (GAsyncResult *res); 75 76 GLIB_AVAILABLE_IN_2_34 77 gboolean g_async_result_legacy_propagate_error (GAsyncResult *res, 78 GError **error); 79 GLIB_AVAILABLE_IN_2_34 80 gboolean g_async_result_is_tagged (GAsyncResult *res, 81 gpointer source_tag); 82 83 G_END_DECLS 84 85 #endif /* __G_ASYNC_RESULT_H__ */ 86