1/* GIO - GLib Input, Output and Streaming Library
2 *
3 * Copyright 2011 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
19#ifndef __G_TASK_H__
20#define __G_TASK_H__
21
22#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
23#error "Only <gio/gio.h> can be included directly."
24#endif
25
26#include <gio/giotypes.h>
27
28G_BEGIN_DECLS
29
30#define G_TYPE_TASK (g_task_get_type ())
31#define G_TASK(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_TASK, GTask))
32#define G_TASK_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_TASK, GTaskClass))
33#define G_IS_TASK(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_TASK))
34#define G_IS_TASK_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_TASK))
35#define G_TASK_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_TASK, GTaskClass))
36
37typedef struct _GTaskClass GTaskClass;
38
39GLIB_AVAILABLE_IN_2_36
40GType g_task_get_type (void) G_GNUC_CONST;
41
42GLIB_AVAILABLE_IN_2_36
43GTask *g_task_new (gpointer source_object,
44 GCancellable *cancellable,
45 GAsyncReadyCallback callback,
46 gpointer callback_data);
47
48GLIB_AVAILABLE_IN_2_36
49void g_task_report_error (gpointer source_object,
50 GAsyncReadyCallback callback,
51 gpointer callback_data,
52 gpointer source_tag,
53 GError *error);
54GLIB_AVAILABLE_IN_2_36
55void g_task_report_new_error (gpointer source_object,
56 GAsyncReadyCallback callback,
57 gpointer callback_data,
58 gpointer source_tag,
59 GQuark domain,
60 gint code,
61 const char *format,
62 ...) G_GNUC_PRINTF(7, 8);
63
64GLIB_AVAILABLE_IN_2_36
65void g_task_set_task_data (GTask *task,
66 gpointer task_data,
67 GDestroyNotify task_data_destroy);
68GLIB_AVAILABLE_IN_2_36
69void g_task_set_priority (GTask *task,
70 gint priority);
71GLIB_AVAILABLE_IN_2_36
72void g_task_set_check_cancellable (GTask *task,
73 gboolean check_cancellable);
74GLIB_AVAILABLE_IN_2_36
75void g_task_set_source_tag (GTask *task,
76 gpointer source_tag);
77
78GLIB_AVAILABLE_IN_2_36
79gpointer g_task_get_source_object (GTask *task);
80GLIB_AVAILABLE_IN_2_36
81gpointer g_task_get_task_data (GTask *task);
82GLIB_AVAILABLE_IN_2_36
83gint g_task_get_priority (GTask *task);
84GLIB_AVAILABLE_IN_2_36
85GMainContext *g_task_get_context (GTask *task);
86GLIB_AVAILABLE_IN_2_36
87GCancellable *g_task_get_cancellable (GTask *task);
88GLIB_AVAILABLE_IN_2_36
89gboolean g_task_get_check_cancellable (GTask *task);
90GLIB_AVAILABLE_IN_2_36
91gpointer g_task_get_source_tag (GTask *task);
92
93GLIB_AVAILABLE_IN_2_36
94gboolean g_task_is_valid (gpointer result,
95 gpointer source_object);
96
97
98typedef void (*GTaskThreadFunc) (GTask *task,
99 gpointer source_object,
100 gpointer task_data,
101 GCancellable *cancellable);
102GLIB_AVAILABLE_IN_2_36
103void g_task_run_in_thread (GTask *task,
104 GTaskThreadFunc task_func);
105GLIB_AVAILABLE_IN_2_36
106void g_task_run_in_thread_sync (GTask *task,
107 GTaskThreadFunc task_func);
108GLIB_AVAILABLE_IN_2_36
109gboolean g_task_set_return_on_cancel (GTask *task,
110 gboolean return_on_cancel);
111GLIB_AVAILABLE_IN_2_36
112gboolean g_task_get_return_on_cancel (GTask *task);
113
114GLIB_AVAILABLE_IN_2_36
115void g_task_attach_source (GTask *task,
116 GSource *source,
117 GSourceFunc callback);
118
119
120GLIB_AVAILABLE_IN_2_36
121void g_task_return_pointer (GTask *task,
122 gpointer result,
123 GDestroyNotify result_destroy);
124GLIB_AVAILABLE_IN_2_36
125void g_task_return_boolean (GTask *task,
126 gboolean result);
127GLIB_AVAILABLE_IN_2_36
128void g_task_return_int (GTask *task,
129 gssize result);
130
131GLIB_AVAILABLE_IN_2_36
132void g_task_return_error (GTask *task,
133 GError *error);
134GLIB_AVAILABLE_IN_2_36
135void g_task_return_new_error (GTask *task,
136 GQuark domain,
137 gint code,
138 const char *format,
139 ...) G_GNUC_PRINTF (4, 5);
140
141GLIB_AVAILABLE_IN_2_36
142gboolean g_task_return_error_if_cancelled (GTask *task);
143
144GLIB_AVAILABLE_IN_2_36
145gpointer g_task_propagate_pointer (GTask *task,
146 GError **error);
147GLIB_AVAILABLE_IN_2_36
148gboolean g_task_propagate_boolean (GTask *task,
149 GError **error);
150GLIB_AVAILABLE_IN_2_36
151gssize g_task_propagate_int (GTask *task,
152 GError **error);
153GLIB_AVAILABLE_IN_2_36
154gboolean g_task_had_error (GTask *task);
155GLIB_AVAILABLE_IN_2_44
156gboolean g_task_get_completed (GTask *task);
157
158G_END_DECLS
159
160#endif /* __G_TASK_H__ */
161