gio/gtask.h

   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
  28 G_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
  37 typedef struct _GTaskClass   GTaskClass;
  38
  39 GLIB_AVAILABLE_IN_2_36
  40 GType         g_task_get_type              (void) G_GNUC_CONST;
  41
  42 GLIB_AVAILABLE_IN_2_36
  43 GTask        *g_task_new                   (gpointer             source_object,
  44                                             GCancellable        *cancellable,
  45                                             GAsyncReadyCallback  callback,
  46                                             gpointer             callback_data);
  47
  48 GLIB_AVAILABLE_IN_2_36
  49 void          g_task_report_error          (gpointer             source_object,
  50                                             GAsyncReadyCallback  callback,
  51                                             gpointer             callback_data,
  52                                             gpointer             source_tag,
  53                                             GError              *error);
  54 GLIB_AVAILABLE_IN_2_36
  55 void          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
  64 GLIB_AVAILABLE_IN_2_36
  65 void          g_task_set_task_data         (GTask               *task,
  66                                             gpointer             task_data,
  67                                             GDestroyNotify       task_data_destroy);
  68 GLIB_AVAILABLE_IN_2_36
  69 void          g_task_set_priority          (GTask               *task,
  70                                             gint                 priority);
  71 GLIB_AVAILABLE_IN_2_36
  72 void          g_task_set_check_cancellable (GTask               *task,
  73                                             gboolean             check_cancellable);
  74 GLIB_AVAILABLE_IN_2_36
  75 void          g_task_set_source_tag        (GTask               *task,
  76                                             gpointer             source_tag);
  77
  78 GLIB_AVAILABLE_IN_2_36
  79 gpointer      g_task_get_source_object     (GTask               *task);
  80 GLIB_AVAILABLE_IN_2_36
  81 gpointer      g_task_get_task_data         (GTask               *task);
  82 GLIB_AVAILABLE_IN_2_36
  83 gint          g_task_get_priority          (GTask               *task);
  84 GLIB_AVAILABLE_IN_2_36
  85 GMainContext *g_task_get_context           (GTask               *task);
  86 GLIB_AVAILABLE_IN_2_36
  87 GCancellable *g_task_get_cancellable       (GTask               *task);
  88 GLIB_AVAILABLE_IN_2_36
  89 gboolean      g_task_get_check_cancellable (GTask               *task);
  90 GLIB_AVAILABLE_IN_2_36
  91 gpointer      g_task_get_source_tag        (GTask               *task);
  92
  93 GLIB_AVAILABLE_IN_2_36
  94 gboolean      g_task_is_valid              (gpointer             result,
  95                                             gpointer             source_object);
  96
  97
  98 typedef void (*GTaskThreadFunc)           (GTask           *task,
  99                                            gpointer         source_object,
 100                                            gpointer         task_data,
 101                                            GCancellable    *cancellable);
 102 GLIB_AVAILABLE_IN_2_36
 103 void          g_task_run_in_thread        (GTask           *task,
 104                                            GTaskThreadFunc  task_func);
 105 GLIB_AVAILABLE_IN_2_36
 106 void          g_task_run_in_thread_sync   (GTask           *task,
 107                                            GTaskThreadFunc  task_func);
 108 GLIB_AVAILABLE_IN_2_36
 109 gboolean      g_task_set_return_on_cancel (GTask           *task,
 110                                            gboolean         return_on_cancel);
 111 GLIB_AVAILABLE_IN_2_36
 112 gboolean      g_task_get_return_on_cancel (GTask           *task);
 113
 114 GLIB_AVAILABLE_IN_2_36
 115 void          g_task_attach_source        (GTask           *task,
 116                                            GSource         *source,
 117                                            GSourceFunc      callback);
 118
 119
 120 GLIB_AVAILABLE_IN_2_36
 121 void          g_task_return_pointer            (GTask           *task,
 122                                                 gpointer         result,
 123                                                 GDestroyNotify   result_destroy);
 124 GLIB_AVAILABLE_IN_2_36
 125 void          g_task_return_boolean            (GTask           *task,
 126                                                 gboolean         result);
 127 GLIB_AVAILABLE_IN_2_36
 128 void          g_task_return_int                (GTask           *task,
 129                                                 gssize           result);
 130
 131 GLIB_AVAILABLE_IN_2_36
 132 void          g_task_return_error              (GTask           *task,
 133                                                 GError          *error);
 134 GLIB_AVAILABLE_IN_2_36
 135 void          g_task_return_new_error          (GTask           *task,
 136                                                 GQuark           domain,
 137                                                 gint             code,
 138                                                 const char      *format,
 139                                                 ...) G_GNUC_PRINTF (4, 5);
 140
 141 GLIB_AVAILABLE_IN_2_36
 142 gboolean      g_task_return_error_if_cancelled (GTask           *task);
 143
 144 GLIB_AVAILABLE_IN_2_36
 145 gpointer      g_task_propagate_pointer         (GTask           *task,
 146                                                 GError         **error);
 147 GLIB_AVAILABLE_IN_2_36
 148 gboolean      g_task_propagate_boolean         (GTask           *task,
 149                                                 GError         **error);
 150 GLIB_AVAILABLE_IN_2_36
 151 gssize        g_task_propagate_int             (GTask           *task,
 152                                                 GError         **error);
 153 GLIB_AVAILABLE_IN_2_36
 154 gboolean      g_task_had_error                 (GTask           *task);
 155 GLIB_AVAILABLE_IN_2_44
 156 gboolean      g_task_get_completed             (GTask           *task);
 157
 158 G_END_DECLS
 159
 160 #endif /* __G_TASK_H__ */