luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-09 02:46:16 +01:00
Code Issues Packages Projects Releases Wiki Activity
253f5cda82
glib/gio/gtask.h

173 lines
8.1 KiB
C
Raw Normal View History

GTask: new GAsyncResult implementation / threaded task manager GTask is a replacement for GSimpleAsyncResult and GIOScheduler, that also allows for making cancellable wrappers around non-cancellable functions (as in GThreadedResolver). https://bugzilla.gnome.org/show_bug.cgi?id=661767
2011-10-05 16:05:50 +02:00
/* GIO - GLib Input, Output and Streaming Library
*
* Copyright 2011 Red Hat, Inc.
*
* 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
gio/: LGPLv2+ -> LGPLv2.1+ Sub-directories inside gio/ already processed in a previous commit: - fam/ - gdbus-2.0/ (which contains only codegen/) - gvdb/ - inotify/ - tests/ - win32/ - xdgmime/ Other sub-directories inside gio/: - completion/: no license headers - kqueue/: not LGPL, BSD-style license https://bugzilla.gnome.org/show_bug.cgi?id=776504
2017-05-27 18:21:30 +02:00
* version 2.1 of the License, or (at your option) any later version.
GTask: new GAsyncResult implementation / threaded task manager GTask is a replacement for GSimpleAsyncResult and GIOScheduler, that also allows for making cancellable wrappers around non-cancellable functions (as in GThreadedResolver). https://bugzilla.gnome.org/show_bug.cgi?id=661767
2011-10-05 16:05:50 +02:00
*
* 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
Updated FSF's address
2014-01-23 12:58:29 +01:00
* Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
GTask: new GAsyncResult implementation / threaded task manager GTask is a replacement for GSimpleAsyncResult and GIOScheduler, that also allows for making cancellable wrappers around non-cancellable functions (as in GThreadedResolver). https://bugzilla.gnome.org/show_bug.cgi?id=661767
2011-10-05 16:05:50 +02:00
*/
Move single-include guards inside include guards gcc has optimizations for include guards that only work if they are outermost in the the header. https://bugzilla.gnome.org/show_bug.cgi?id=689810
2012-12-28 05:43:14 +01:00
#ifndef __G_TASK_H__
#define __G_TASK_H__
GTask: new GAsyncResult implementation / threaded task manager GTask is a replacement for GSimpleAsyncResult and GIOScheduler, that also allows for making cancellable wrappers around non-cancellable functions (as in GThreadedResolver). https://bugzilla.gnome.org/show_bug.cgi?id=661767
2011-10-05 16:05:50 +02:00
#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;
GLIB_AVAILABLE_IN_2_36
GType g_task_get_type (void) G_GNUC_CONST;
GLIB_AVAILABLE_IN_2_36
GTask *g_task_new (gpointer source_object,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer callback_data);
GLIB_AVAILABLE_IN_2_36
void g_task_report_error (gpointer source_object,
GAsyncReadyCallback callback,
gpointer callback_data,
gpointer source_tag,
GError *error);
GLIB_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,
Add G_GNUC_PRINTF on all functions with format strings This allows compilation with clang without errors, even when -Wformat-nonliteral is active (as long as there are no real cases of non literal formatting). https://bugzilla.gnome.org/show_bug.cgi?id=691608
2013-01-13 17:05:14 +01:00
...) G_GNUC_PRINTF(7, 8);
GTask: new GAsyncResult implementation / threaded task manager GTask is a replacement for GSimpleAsyncResult and GIOScheduler, that also allows for making cancellable wrappers around non-cancellable functions (as in GThreadedResolver). https://bugzilla.gnome.org/show_bug.cgi?id=661767
2011-10-05 16:05:50 +02:00
GLIB_AVAILABLE_IN_2_36
void g_task_set_task_data (GTask *task,
gpointer task_data,
GDestroyNotify task_data_destroy);
GLIB_AVAILABLE_IN_2_36
void g_task_set_priority (GTask *task,
gint priority);
GLIB_AVAILABLE_IN_2_36
void g_task_set_check_cancellable (GTask *task,
gboolean check_cancellable);
GLIB_AVAILABLE_IN_2_36
void g_task_set_source_tag (GTask *task,
gpointer source_tag);
gtask: Add a g_task_set_name() method Similarly to g_source_set_name(), this sets a name on a GTask for debugging and profiling. Importantly, this name is propagated to the GSource for idle callbacks for the GTask, ending the glorious reign of `[gio] complete_in_idle_cb`. The name can be queried using g_task_get_name(). Locking is avoided by only allowing the name to be set before the GTask is used from another thread. Includes tests. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-10-07 18:37:58 +02:00
GLIB_AVAILABLE_IN_2_60
void g_task_set_name (GTask *task,
const gchar *name);
GTask: new GAsyncResult implementation / threaded task manager GTask is a replacement for GSimpleAsyncResult and GIOScheduler, that also allows for making cancellable wrappers around non-cancellable functions (as in GThreadedResolver). https://bugzilla.gnome.org/show_bug.cgi?id=661767
2011-10-05 16:05:50 +02:00
GLIB_AVAILABLE_IN_2_36
gpointer g_task_get_source_object (GTask *task);
GLIB_AVAILABLE_IN_2_36
gpointer g_task_get_task_data (GTask *task);
GLIB_AVAILABLE_IN_2_36
gint g_task_get_priority (GTask *task);
GLIB_AVAILABLE_IN_2_36
GMainContext *g_task_get_context (GTask *task);
GLIB_AVAILABLE_IN_2_36
GCancellable *g_task_get_cancellable (GTask *task);
GLIB_AVAILABLE_IN_2_36
gboolean g_task_get_check_cancellable (GTask *task);
GLIB_AVAILABLE_IN_2_36
gpointer g_task_get_source_tag (GTask *task);
gtask: Add a g_task_set_name() method Similarly to g_source_set_name(), this sets a name on a GTask for debugging and profiling. Importantly, this name is propagated to the GSource for idle callbacks for the GTask, ending the glorious reign of `[gio] complete_in_idle_cb`. The name can be queried using g_task_get_name(). Locking is avoided by only allowing the name to be set before the GTask is used from another thread. Includes tests. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-10-07 18:37:58 +02:00
GLIB_AVAILABLE_IN_2_60
const gchar *g_task_get_name (GTask *task);
GTask: new GAsyncResult implementation / threaded task manager GTask is a replacement for GSimpleAsyncResult and GIOScheduler, that also allows for making cancellable wrappers around non-cancellable functions (as in GThreadedResolver). https://bugzilla.gnome.org/show_bug.cgi?id=661767
2011-10-05 16:05:50 +02:00
GLIB_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);
GLIB_AVAILABLE_IN_2_36
void g_task_run_in_thread (GTask *task,
GTaskThreadFunc task_func);
GLIB_AVAILABLE_IN_2_36
void g_task_run_in_thread_sync (GTask *task,
GTaskThreadFunc task_func);
GLIB_AVAILABLE_IN_2_36
gboolean g_task_set_return_on_cancel (GTask *task,
gboolean return_on_cancel);
GLIB_AVAILABLE_IN_2_36
gboolean g_task_get_return_on_cancel (GTask *task);
GLIB_AVAILABLE_IN_2_36
void g_task_attach_source (GTask *task,
GSource *source,
GSourceFunc callback);
GLIB_AVAILABLE_IN_2_36
void g_task_return_pointer (GTask *task,
gpointer result,
GDestroyNotify result_destroy);
GLIB_AVAILABLE_IN_2_36
void g_task_return_boolean (GTask *task,
gboolean result);
GLIB_AVAILABLE_IN_2_36
void g_task_return_int (GTask *task,
gssize result);
GLIB_AVAILABLE_IN_2_36
void g_task_return_error (GTask *task,
GError *error);
GLIB_AVAILABLE_IN_2_36
void g_task_return_new_error (GTask *task,
GQuark domain,
gint code,
const char *format,
...) G_GNUC_PRINTF (4, 5);
task: Add return/propagate API for GValue This is useful for bindings. Related: https://gitlab.gnome.org/GNOME/glib/issues/668
2019-11-05 09:54:01 +01:00
GLIB_AVAILABLE_IN_2_64
void g_task_return_value (GTask *task,
GValue *result);
GTask: new GAsyncResult implementation / threaded task manager GTask is a replacement for GSimpleAsyncResult and GIOScheduler, that also allows for making cancellable wrappers around non-cancellable functions (as in GThreadedResolver). https://bugzilla.gnome.org/show_bug.cgi?id=661767
2011-10-05 16:05:50 +02:00
GLIB_AVAILABLE_IN_2_36
gboolean g_task_return_error_if_cancelled (GTask *task);
GLIB_AVAILABLE_IN_2_36
gpointer g_task_propagate_pointer (GTask *task,
GError **error);
GLIB_AVAILABLE_IN_2_36
gboolean g_task_propagate_boolean (GTask *task,
GError **error);
GLIB_AVAILABLE_IN_2_36
gssize g_task_propagate_int (GTask *task,
GError **error);
task: Add return/propagate API for GValue This is useful for bindings. Related: https://gitlab.gnome.org/GNOME/glib/issues/668
2019-11-05 09:54:01 +01:00
GLIB_AVAILABLE_IN_2_64
gboolean g_task_propagate_value (GTask *task,
GValue *value,
GError **error);
GTask: new GAsyncResult implementation / threaded task manager GTask is a replacement for GSimpleAsyncResult and GIOScheduler, that also allows for making cancellable wrappers around non-cancellable functions (as in GThreadedResolver). https://bugzilla.gnome.org/show_bug.cgi?id=661767
2011-10-05 16:05:50 +02:00
GLIB_AVAILABLE_IN_2_36
gboolean g_task_had_error (GTask *task);
gtask: Add a GTask:completed property This can be used to query whether the task has completed, in the sense that it has had a result set on it, and has already – or will soon – invoke its callback function. Notifications for this property are emitted immediately after the task’s main callback, in the same main context as that callback. This allows for multiple bits of code to listen for completion of the GTask, which opens the door for blocking on cancellation of the GTask and improved handling of ‘pending’ behaviour. https://bugzilla.gnome.org/show_bug.cgi?id=743636
2014-08-21 20:04:04 +02:00
GLIB_AVAILABLE_IN_2_44
gboolean g_task_get_completed (GTask *task);
GTask: new GAsyncResult implementation / threaded task manager GTask is a replacement for GSimpleAsyncResult and GIOScheduler, that also allows for making cancellable wrappers around non-cancellable functions (as in GThreadedResolver). https://bugzilla.gnome.org/show_bug.cgi?id=661767
2011-10-05 16:05:50 +02:00
G_END_DECLS
#endif /* __G_TASK_H__ */
Reference in New Issue Copy Permalink