1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
/* GIO - GLib Input, Output and Streaming Library
*
* Copyright 2011 Red Hat, Inc.
*
* SPDX-License-Identifier: LGPL-2.1-or-later
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __G_TASK_H__
#define __G_TASK_H__
#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
#error "Only <gio/gio.h> can be included directly."
#endif
#include <gio/giotypes.h>
G_BEGIN_DECLS
#define G_TYPE_TASK (g_task_get_type ())
#define G_TASK(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_TASK, GTask))
#define G_TASK_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_TASK, GTaskClass))
#define G_IS_TASK(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_TASK))
#define G_IS_TASK_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_TASK))
#define G_TASK_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_TASK, GTaskClass))
typedef struct _GTaskClass GTaskClass;
GIO_AVAILABLE_IN_2_36
GType g_task_get_type (void) G_GNUC_CONST;
GIO_AVAILABLE_IN_2_36
GTask *g_task_new (gpointer source_object,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer callback_data);
GIO_AVAILABLE_IN_2_36
void g_task_report_error (gpointer source_object,
GAsyncReadyCallback callback,
gpointer callback_data,
gpointer source_tag,
GError *error);
GIO_AVAILABLE_IN_2_36
void g_task_report_new_error (gpointer source_object,
GAsyncReadyCallback callback,
gpointer callback_data,
gpointer source_tag,
GQuark domain,
gint code,
const char *format,
...) G_GNUC_PRINTF(7, 8);
GIO_AVAILABLE_IN_2_36
void g_task_set_task_data (GTask *task,
gpointer task_data,
GDestroyNotify task_data_destroy);
GIO_AVAILABLE_IN_2_36
void g_task_set_priority (GTask *task,
gint priority);
GIO_AVAILABLE_IN_2_36
void g_task_set_check_cancellable (GTask *task,
gboolean check_cancellable);
GIO_AVAILABLE_IN_2_36
void g_task_set_source_tag (GTask *task,
gpointer source_tag);
GIO_AVAILABLE_IN_2_60
void g_task_set_name (GTask *task,
const gchar *name);
GIO_AVAILABLE_IN_2_76
void g_task_set_static_name (GTask *task,
const gchar *name);
/* Macro wrapper to set the task name when setting the source tag. */
#if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_76
#define g_task_set_source_tag(task, tag) G_STMT_START { \
GTask *_task = (task); \
(g_task_set_source_tag) (_task, tag); \
if (g_task_get_name (_task) == NULL) \
g_task_set_static_name (_task, G_STRINGIFY (tag)); \
} G_STMT_END
#endif
#if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_76
#if defined (__GNUC__) && (__GNUC__ >= 2)
#define g_task_set_name(task, name) G_STMT_START { \
GTask *_task = (task); \
if (__builtin_constant_p (name)) \
g_task_set_static_name (_task, name); \
else \
g_task_set_name (_task, name); \
} G_STMT_END
#endif
#endif
GIO_AVAILABLE_IN_2_36
gpointer g_task_get_source_object (GTask *task);
GIO_AVAILABLE_IN_2_36
gpointer g_task_get_task_data (GTask *task);
GIO_AVAILABLE_IN_2_36
gint g_task_get_priority (GTask *task);
GIO_AVAILABLE_IN_2_36
GMainContext *g_task_get_context (GTask *task);
GIO_AVAILABLE_IN_2_36
GCancellable *g_task_get_cancellable (GTask *task);
GIO_AVAILABLE_IN_2_36
gboolean g_task_get_check_cancellable (GTask *task);
GIO_AVAILABLE_IN_2_36
gpointer g_task_get_source_tag (GTask *task);
GIO_AVAILABLE_IN_2_60
const gchar *g_task_get_name (GTask *task);
GIO_AVAILABLE_IN_2_36
gboolean g_task_is_valid (gpointer result,
gpointer source_object);
typedef void (*GTaskThreadFunc) (GTask *task,
gpointer source_object,
gpointer task_data,
GCancellable *cancellable);
GIO_AVAILABLE_IN_2_36
void g_task_run_in_thread (GTask *task,
GTaskThreadFunc task_func);
GIO_AVAILABLE_IN_2_36
void g_task_run_in_thread_sync (GTask *task,
GTaskThreadFunc task_func);
GIO_AVAILABLE_IN_2_36
gboolean g_task_set_return_on_cancel (GTask *task,
gboolean return_on_cancel);
GIO_AVAILABLE_IN_2_36
gboolean g_task_get_return_on_cancel (GTask *task);
GIO_AVAILABLE_IN_2_36
void g_task_attach_source (GTask *task,
GSource *source,
GSourceFunc callback);
GIO_AVAILABLE_IN_2_36
void g_task_return_pointer (GTask *task,
gpointer result,
GDestroyNotify result_destroy);
GIO_AVAILABLE_IN_2_36
void g_task_return_boolean (GTask *task,
gboolean result);
GIO_AVAILABLE_IN_2_36
void g_task_return_int (GTask *task,
gssize result);
GIO_AVAILABLE_IN_2_36
void g_task_return_error (GTask *task,
GError *error);
GIO_AVAILABLE_IN_2_36
void g_task_return_new_error (GTask *task,
GQuark domain,
gint code,
const char *format,
...) G_GNUC_PRINTF (4, 5);
GIO_AVAILABLE_IN_2_64
void g_task_return_value (GTask *task,
GValue *result);
GIO_AVAILABLE_IN_2_36
gboolean g_task_return_error_if_cancelled (GTask *task);
GIO_AVAILABLE_IN_2_36
gpointer g_task_propagate_pointer (GTask *task,
GError **error);
GIO_AVAILABLE_IN_2_36
gboolean g_task_propagate_boolean (GTask *task,
GError **error);
GIO_AVAILABLE_IN_2_36
gssize g_task_propagate_int (GTask *task,
GError **error);
GIO_AVAILABLE_IN_2_64
gboolean g_task_propagate_value (GTask *task,
GValue *value,
GError **error);
GIO_AVAILABLE_IN_2_36
gboolean g_task_had_error (GTask *task);
GIO_AVAILABLE_IN_2_44
gboolean g_task_get_completed (GTask *task);
/*< private >*/
#ifndef __GTK_DOC_IGNORE__
#ifndef __GI_SCANNER__
/* Debugging API, not part of the public API */
void g_task_print_alive_tasks (void);
#endif /* !__GI_SCANNER__ */
#endif /* !__GTK_DOC_IGNORE__ */
G_END_DECLS
#endif /* __G_TASK_H__ */
|
