gtask.h 7.7 KB

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