1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
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 of the License, or (at your option) any later version.
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.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: Alexander Larsson <alexl@redhat.com>
25 #include <sys/types.h>
34 #include "gsimpleasyncresult.h"
35 #include "gasyncresult.h"
36 #include "gcancellable.h"
37 #include "gioscheduler.h"
38 #include <gio/gioerror.h>
43 * SECTION:gsimpleasyncresult
44 * @short_description: Simple asynchronous results implementation
46 * @see_also: #GAsyncResult
48 * Implements #GAsyncResult for simple cases. Most of the time, this
49 * will be all an application needs, and will be used transparently.
50 * Because of this, #GSimpleAsyncResult is used throughout GIO for
51 * handling asynchronous functions.
53 * GSimpleAsyncResult handles #GAsyncReadyCallback<!-- -->s, error
54 * reporting, operation cancellation and the final state of an operation,
55 * completely transparent to the application. Results can be returned
56 * as a pointer e.g. for functions that return data that is collected
57 * asynchronously, a boolean value for checking the success or failure
58 * of an operation, or a #gssize for operations which return the number
59 * of bytes modified by the operation; all of the simple return cases
62 * Most of the time, an application will not need to know of the details
63 * of this API; it is handled transparently, and any necessary operations
64 * are handled by #GAsyncResult's interface. However, if implementing a
65 * new GIO module, for writing language bindings, or for complex
66 * applications that need better control of how asynchronous operations
67 * are completed, it is important to understand this functionality.
69 * GSimpleAsyncResults are tagged with the calling function to ensure
70 * that asynchronous functions and their finishing functions are used
73 * To create a new #GSimpleAsyncResult, call g_simple_async_result_new().
74 * If the result needs to be created for a #GError, use
75 * g_simple_async_result_new_from_error() or
76 * g_simple_async_result_new_take_error(). If a #GError is not available
77 * (e.g. the asynchronous operation's doesn't take a #GError argument),
78 * but the result still needs to be created for an error condition, use
79 * g_simple_async_result_new_error() (or g_simple_async_result_set_error_va()
80 * if your application or binding requires passing a variable argument list
81 * directly), and the error can then be propagated through the use of
82 * g_simple_async_result_propagate_error().
84 * An asynchronous operation can be made to ignore a cancellation event by
85 * calling g_simple_async_result_set_handle_cancellation() with a
86 * #GSimpleAsyncResult for the operation and %FALSE. This is useful for
87 * operations that are dangerous to cancel, such as close (which would
88 * cause a leak if cancelled before being run).
90 * GSimpleAsyncResult can integrate into GLib's event loop, #GMainLoop,
91 * or it can use #GThread<!-- -->s if available.
92 * g_simple_async_result_complete() will finish an I/O task directly
93 * from the point where it is called. g_simple_async_result_complete_in_idle()
94 * will finish it from an idle handler in the <link
95 * linkend="g-main-context-push-thread-default">thread-default main
96 * context</link>. g_simple_async_result_run_in_thread() will run the
97 * job in a separate thread and then deliver the result to the
98 * thread-default main context.
100 * To set the results of an asynchronous function,
101 * g_simple_async_result_set_op_res_gpointer(),
102 * g_simple_async_result_set_op_res_gboolean(), and
103 * g_simple_async_result_set_op_res_gssize()
104 * are provided, setting the operation's result to a gpointer, gboolean, or
105 * gssize, respectively.
107 * Likewise, to get the result of an asynchronous function,
108 * g_simple_async_result_get_op_res_gpointer(),
109 * g_simple_async_result_get_op_res_gboolean(), and
110 * g_simple_async_result_get_op_res_gssize() are
111 * provided, getting the operation's result as a gpointer, gboolean, and
112 * gssize, respectively.
114 * For the details of the requirements implementations must respect, see
115 * #GAsyncResult. A typical implementation of an asynchronous operation
116 * using GSimpleAsyncResult looks something like this:
120 * baked_cb (Cake *cake,
121 * gpointer user_data)
123 * /* In this example, this callback is not given a reference to the cake, so
124 * * the GSimpleAsyncResult has to take a reference to it.
126 * GSimpleAsyncResult *result = user_data;
129 * g_simple_async_result_set_error (result,
131 * BAKER_ERROR_NO_FLOUR,
132 * "Go to the supermarket");
134 * g_simple_async_result_set_op_res_gpointer (result,
135 * g_object_ref (cake),
139 * /* In this example, we assume that baked_cb is called as a callback from
140 * * the mainloop, so it's safe to complete the operation synchronously here.
141 * * If, however, _baker_prepare_cake () might call its callback without
142 * * first returning to the mainloop — inadvisable, but some APIs do so —
143 * * we would need to use g_simple_async_result_complete_in_idle().
145 * g_simple_async_result_complete (result);
146 * g_object_unref (result);
150 * baker_bake_cake_async (Baker *self,
152 * GAsyncReadyCallback callback,
153 * gpointer user_data)
155 * GSimpleAsyncResult *simple;
160 * g_simple_async_report_error_in_idle (G_OBJECT (self),
164 * BAKER_ERROR_TOO_SMALL,
165 * "%ucm radius cakes are silly",
170 * simple = g_simple_async_result_new (G_OBJECT (self),
173 * baker_bake_cake_async);
174 * cake = _baker_get_cached_cake (self, radius);
178 * g_simple_async_result_set_op_res_gpointer (simple,
179 * g_object_ref (cake),
181 * g_simple_async_result_complete_in_idle (simple);
182 * g_object_unref (simple);
183 * /* Drop the reference returned by _baker_get_cached_cake(); the
184 * * GSimpleAsyncResult has taken its own reference.
186 * g_object_unref (cake);
190 * _baker_prepare_cake (self, radius, baked_cb, user_data);
194 * baker_bake_cake_finish (Baker *self,
195 * GAsyncResult *result,
198 * GSimpleAsyncResult *simple;
201 * g_return_val_if_fail (g_simple_async_result_is_valid (result,
203 * baker_bake_cake_async),
206 * simple = (GSimpleAsyncResult *) result;
208 * if (g_simple_async_result_propagate_error (simple, error))
211 * cake = CAKE (g_simple_async_result_get_op_res_gpointer (simple));
212 * return g_object_ref (cake);
217 static void g_simple_async_result_async_result_iface_init (GAsyncResultIface *iface);
219 struct _GSimpleAsyncResult
221 GObject parent_instance;
223 GObject *source_object;
224 GAsyncReadyCallback callback;
226 GMainContext *context;
229 gboolean handle_cancellation;
239 GDestroyNotify destroy_op_res;
242 struct _GSimpleAsyncResultClass
244 GObjectClass parent_class;
248 G_DEFINE_TYPE_WITH_CODE (GSimpleAsyncResult, g_simple_async_result, G_TYPE_OBJECT,
249 G_IMPLEMENT_INTERFACE (G_TYPE_ASYNC_RESULT,
250 g_simple_async_result_async_result_iface_init))
253 clear_op_res (GSimpleAsyncResult *simple)
255 if (simple->destroy_op_res)
256 simple->destroy_op_res (simple->op_res.v_pointer);
257 simple->destroy_op_res = NULL;
258 simple->op_res.v_ssize = 0;
262 g_simple_async_result_finalize (GObject *object)
264 GSimpleAsyncResult *simple;
266 simple = G_SIMPLE_ASYNC_RESULT (object);
268 if (simple->source_object)
269 g_object_unref (simple->source_object);
272 g_main_context_unref (simple->context);
274 clear_op_res (simple);
277 g_error_free (simple->error);
279 G_OBJECT_CLASS (g_simple_async_result_parent_class)->finalize (object);
283 g_simple_async_result_class_init (GSimpleAsyncResultClass *klass)
285 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
287 gobject_class->finalize = g_simple_async_result_finalize;
291 g_simple_async_result_init (GSimpleAsyncResult *simple)
293 simple->handle_cancellation = TRUE;
295 simple->context = g_main_context_get_thread_default ();
297 g_main_context_ref (simple->context);
301 * g_simple_async_result_new:
302 * @source_object: a #GObject the asynchronous function was called with,
304 * @callback: a #GAsyncReadyCallback.
305 * @user_data: user data passed to @callback.
306 * @source_tag: the asynchronous function.
308 * Creates a #GSimpleAsyncResult.
310 * Returns: a #GSimpleAsyncResult.
313 g_simple_async_result_new (GObject *source_object,
314 GAsyncReadyCallback callback,
318 GSimpleAsyncResult *simple;
320 g_return_val_if_fail (!source_object || G_IS_OBJECT (source_object), NULL);
322 simple = g_object_new (G_TYPE_SIMPLE_ASYNC_RESULT, NULL);
323 simple->callback = callback;
325 simple->source_object = g_object_ref (source_object);
327 simple->source_object = NULL;
328 simple->user_data = user_data;
329 simple->source_tag = source_tag;
335 * g_simple_async_result_new_from_error:
336 * @source_object: a #GObject, or %NULL.
337 * @callback: a #GAsyncReadyCallback.
338 * @user_data: user data passed to @callback.
341 * Creates a #GSimpleAsyncResult from an error condition.
343 * Returns: a #GSimpleAsyncResult.
346 g_simple_async_result_new_from_error (GObject *source_object,
347 GAsyncReadyCallback callback,
351 GSimpleAsyncResult *simple;
353 g_return_val_if_fail (!source_object || G_IS_OBJECT (source_object), NULL);
355 simple = g_simple_async_result_new (source_object,
358 g_simple_async_result_set_from_error (simple, error);
364 * g_simple_async_result_new_take_error:
365 * @source_object: (allow-none): a #GObject, or %NULL
366 * @callback: a #GAsyncReadyCallback
367 * @user_data: (allow-none): user data passed to @callback
370 * Creates a #GSimpleAsyncResult from an error condition, and takes over the
371 * caller's ownership of @error, so the caller does not need to free it anymore.
373 * Returns: a #GSimpleAsyncResult
378 g_simple_async_result_new_take_error (GObject *source_object,
379 GAsyncReadyCallback callback,
383 GSimpleAsyncResult *simple;
385 g_return_val_if_fail (!source_object || G_IS_OBJECT (source_object), NULL);
387 simple = g_simple_async_result_new (source_object,
390 g_simple_async_result_take_error (simple, error);
396 * g_simple_async_result_new_error:
397 * @source_object: a #GObject, or %NULL.
398 * @callback: a #GAsyncReadyCallback.
399 * @user_data: user data passed to @callback.
400 * @domain: a #GQuark.
401 * @code: an error code.
402 * @format: a string with format characters.
403 * @...: a list of values to insert into @format.
405 * Creates a new #GSimpleAsyncResult with a set error.
407 * Returns: a #GSimpleAsyncResult.
410 g_simple_async_result_new_error (GObject *source_object,
411 GAsyncReadyCallback callback,
418 GSimpleAsyncResult *simple;
421 g_return_val_if_fail (!source_object || G_IS_OBJECT (source_object), NULL);
422 g_return_val_if_fail (domain != 0, NULL);
423 g_return_val_if_fail (format != NULL, NULL);
425 simple = g_simple_async_result_new (source_object,
429 va_start (args, format);
430 g_simple_async_result_set_error_va (simple, domain, code, format, args);
438 g_simple_async_result_get_user_data (GAsyncResult *res)
440 return G_SIMPLE_ASYNC_RESULT (res)->user_data;
444 g_simple_async_result_get_source_object (GAsyncResult *res)
446 if (G_SIMPLE_ASYNC_RESULT (res)->source_object)
447 return g_object_ref (G_SIMPLE_ASYNC_RESULT (res)->source_object);
452 g_simple_async_result_async_result_iface_init (GAsyncResultIface *iface)
454 iface->get_user_data = g_simple_async_result_get_user_data;
455 iface->get_source_object = g_simple_async_result_get_source_object;
459 * g_simple_async_result_set_handle_cancellation:
460 * @simple: a #GSimpleAsyncResult.
461 * @handle_cancellation: a #gboolean.
463 * Sets whether to handle cancellation within the asynchronous operation.
467 g_simple_async_result_set_handle_cancellation (GSimpleAsyncResult *simple,
468 gboolean handle_cancellation)
470 g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple));
471 simple->handle_cancellation = handle_cancellation;
475 * g_simple_async_result_get_source_tag: (skip)
476 * @simple: a #GSimpleAsyncResult.
478 * Gets the source tag for the #GSimpleAsyncResult.
480 * Returns: a #gpointer to the source object for the #GSimpleAsyncResult.
483 g_simple_async_result_get_source_tag (GSimpleAsyncResult *simple)
485 g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple), NULL);
486 return simple->source_tag;
490 * g_simple_async_result_propagate_error:
491 * @simple: a #GSimpleAsyncResult.
492 * @dest: a location to propegate the error to.
494 * Propagates an error from within the simple asynchronous result to
495 * a given destination.
497 * Returns: %TRUE if the error was propagated to @dest. %FALSE otherwise.
500 g_simple_async_result_propagate_error (GSimpleAsyncResult *simple,
503 g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple), FALSE);
507 g_propagate_error (dest, simple->error);
508 simple->error = NULL;
516 * g_simple_async_result_set_op_res_gpointer:
517 * @simple: a #GSimpleAsyncResult.
518 * @op_res: a pointer result from an asynchronous function.
519 * @destroy_op_res: a #GDestroyNotify function.
521 * Sets the operation result within the asynchronous result to a pointer.
524 g_simple_async_result_set_op_res_gpointer (GSimpleAsyncResult *simple,
526 GDestroyNotify destroy_op_res)
528 g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple));
530 clear_op_res (simple);
531 simple->op_res.v_pointer = op_res;
532 simple->destroy_op_res = destroy_op_res;
536 * g_simple_async_result_get_op_res_gpointer: (skip)
537 * @simple: a #GSimpleAsyncResult.
539 * Gets a pointer result as returned by the asynchronous function.
541 * Returns: a pointer from the result.
544 g_simple_async_result_get_op_res_gpointer (GSimpleAsyncResult *simple)
546 g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple), NULL);
547 return simple->op_res.v_pointer;
551 * g_simple_async_result_set_op_res_gssize:
552 * @simple: a #GSimpleAsyncResult.
553 * @op_res: a #gssize.
555 * Sets the operation result within the asynchronous result to
559 g_simple_async_result_set_op_res_gssize (GSimpleAsyncResult *simple,
562 g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple));
563 clear_op_res (simple);
564 simple->op_res.v_ssize = op_res;
568 * g_simple_async_result_get_op_res_gssize:
569 * @simple: a #GSimpleAsyncResult.
571 * Gets a gssize from the asynchronous result.
573 * Returns: a gssize returned from the asynchronous function.
576 g_simple_async_result_get_op_res_gssize (GSimpleAsyncResult *simple)
578 g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple), 0);
579 return simple->op_res.v_ssize;
583 * g_simple_async_result_set_op_res_gboolean:
584 * @simple: a #GSimpleAsyncResult.
585 * @op_res: a #gboolean.
587 * Sets the operation result to a boolean within the asynchronous result.
590 g_simple_async_result_set_op_res_gboolean (GSimpleAsyncResult *simple,
593 g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple));
594 clear_op_res (simple);
595 simple->op_res.v_boolean = !!op_res;
599 * g_simple_async_result_get_op_res_gboolean:
600 * @simple: a #GSimpleAsyncResult.
602 * Gets the operation result boolean from within the asynchronous result.
604 * Returns: %TRUE if the operation's result was %TRUE, %FALSE
605 * if the operation's result was %FALSE.
608 g_simple_async_result_get_op_res_gboolean (GSimpleAsyncResult *simple)
610 g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple), FALSE);
611 return simple->op_res.v_boolean;
615 * g_simple_async_result_set_from_error:
616 * @simple: a #GSimpleAsyncResult.
619 * Sets the result from a #GError.
622 g_simple_async_result_set_from_error (GSimpleAsyncResult *simple,
625 g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple));
626 g_return_if_fail (error != NULL);
629 g_error_free (simple->error);
630 simple->error = g_error_copy (error);
631 simple->failed = TRUE;
635 * g_simple_async_result_take_error:
636 * @simple: a #GSimpleAsyncResult
639 * Sets the result from @error, and takes over the caller's ownership
640 * of @error, so the caller does not need to free it any more.
645 g_simple_async_result_take_error (GSimpleAsyncResult *simple,
648 g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple));
649 g_return_if_fail (error != NULL);
652 g_error_free (simple->error);
653 simple->error = error;
654 simple->failed = TRUE;
658 * g_simple_async_result_set_error_va:
659 * @simple: a #GSimpleAsyncResult.
660 * @domain: a #GQuark (usually #G_IO_ERROR).
661 * @code: an error code.
662 * @format: a formatted error reporting string.
663 * @args: va_list of arguments.
665 * Sets an error within the asynchronous result without a #GError.
666 * Unless writing a binding, see g_simple_async_result_set_error().
669 g_simple_async_result_set_error_va (GSimpleAsyncResult *simple,
675 g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple));
676 g_return_if_fail (domain != 0);
677 g_return_if_fail (format != NULL);
680 g_error_free (simple->error);
681 simple->error = g_error_new_valist (domain, code, format, args);
682 simple->failed = TRUE;
686 * g_simple_async_result_set_error:
687 * @simple: a #GSimpleAsyncResult.
688 * @domain: a #GQuark (usually #G_IO_ERROR).
689 * @code: an error code.
690 * @format: a formatted error reporting string.
691 * @...: a list of variables to fill in @format.
693 * Sets an error within the asynchronous result without a #GError.
696 g_simple_async_result_set_error (GSimpleAsyncResult *simple,
704 g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple));
705 g_return_if_fail (domain != 0);
706 g_return_if_fail (format != NULL);
708 va_start (args, format);
709 g_simple_async_result_set_error_va (simple, domain, code, format, args);
714 * g_simple_async_result_complete:
715 * @simple: a #GSimpleAsyncResult.
717 * Completes an asynchronous I/O job immediately. Must be called in
718 * the thread where the asynchronous result was to be delivered, as it
719 * invokes the callback directly. If you are in a different thread use
720 * g_simple_async_result_complete_in_idle().
722 * Calling this function takes a reference to @simple for as long as
723 * is needed to complete the call.
726 g_simple_async_result_complete (GSimpleAsyncResult *simple)
728 #ifndef G_DISABLE_CHECKS
729 GSource *current_source;
730 GMainContext *current_context;
733 g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple));
735 #ifndef G_DISABLE_CHECKS
736 current_source = g_main_current_source ();
737 if (current_source && !g_source_is_destroyed (current_source))
739 current_context = g_source_get_context (current_source);
740 if (current_context == g_main_context_default ())
741 current_context = NULL;
742 if (simple->context != current_context)
743 g_warning ("g_simple_async_result_complete() called from wrong context!");
747 if (simple->callback)
748 simple->callback (simple->source_object,
749 G_ASYNC_RESULT (simple),
754 complete_in_idle_cb (gpointer data)
756 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (data);
758 g_simple_async_result_complete (simple);
764 * g_simple_async_result_complete_in_idle:
765 * @simple: a #GSimpleAsyncResult.
767 * Completes an asynchronous function in an idle handler in the <link
768 * linkend="g-main-context-push-thread-default">thread-default main
769 * loop</link> of the thread that @simple was initially created in.
771 * Calling this function takes a reference to @simple for as long as
772 * is needed to complete the call.
775 g_simple_async_result_complete_in_idle (GSimpleAsyncResult *simple)
779 g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple));
781 g_object_ref (simple);
783 source = g_idle_source_new ();
784 g_source_set_priority (source, G_PRIORITY_DEFAULT);
785 g_source_set_callback (source, complete_in_idle_cb, simple, g_object_unref);
787 g_source_attach (source, simple->context);
788 g_source_unref (source);
792 GSimpleAsyncResult *simple;
793 GCancellable *cancellable;
794 GSimpleAsyncThreadFunc func;
799 complete_in_idle_cb_for_thread (gpointer _data)
801 RunInThreadData *data = _data;
802 GSimpleAsyncResult *simple;
804 simple = data->simple;
806 if (simple->handle_cancellation &&
807 g_cancellable_is_cancelled (data->cancellable))
808 g_simple_async_result_set_error (simple,
810 G_IO_ERROR_CANCELLED,
811 "%s", _("Operation was cancelled"));
813 g_simple_async_result_complete (simple);
815 if (data->cancellable)
816 g_object_unref (data->cancellable);
817 g_object_unref (data->simple);
824 run_in_thread (GIOSchedulerJob *job,
828 RunInThreadData *data = _data;
829 GSimpleAsyncResult *simple = data->simple;
832 if (simple->handle_cancellation &&
833 g_cancellable_is_cancelled (c))
834 g_simple_async_result_set_error (simple,
836 G_IO_ERROR_CANCELLED,
837 "%s", _("Operation was cancelled"));
840 simple->source_object,
843 source = g_idle_source_new ();
844 g_source_set_priority (source, G_PRIORITY_DEFAULT);
845 g_source_set_callback (source, complete_in_idle_cb_for_thread, data, NULL);
847 g_source_attach (source, simple->context);
848 g_source_unref (source);
854 * g_simple_async_result_run_in_thread:
855 * @simple: a #GSimpleAsyncResult.
856 * @func: a #GSimpleAsyncThreadFunc.
857 * @io_priority: the io priority of the request.
858 * @cancellable: optional #GCancellable object, %NULL to ignore.
860 * Runs the asynchronous job in a separate thread and then calls
861 * g_simple_async_result_complete_in_idle() on @simple to return
862 * the result to the appropriate main loop.
864 * Calling this function takes a reference to @simple for as long as
865 * is needed to run the job and report its completion.
868 g_simple_async_result_run_in_thread (GSimpleAsyncResult *simple,
869 GSimpleAsyncThreadFunc func,
871 GCancellable *cancellable)
873 RunInThreadData *data;
875 g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple));
876 g_return_if_fail (func != NULL);
878 data = g_new (RunInThreadData, 1);
880 data->simple = g_object_ref (simple);
881 data->cancellable = cancellable;
883 g_object_ref (cancellable);
884 g_io_scheduler_push_job (run_in_thread, data, NULL, io_priority, cancellable);
888 * g_simple_async_result_is_valid:
889 * @result: the #GAsyncResult passed to the _finish function.
890 * @source: the #GObject passed to the _finish function.
891 * @source_tag: the asynchronous function.
893 * Ensures that the data passed to the _finish function of an async
894 * operation is consistent. Three checks are performed.
896 * First, @result is checked to ensure that it is really a
897 * #GSimpleAsyncResult. Second, @source is checked to ensure that it
898 * matches the source object of @result. Third, @source_tag is
899 * checked to ensure that it is either %NULL (as it is when the result was
900 * created by g_simple_async_report_error_in_idle() or
901 * g_simple_async_report_gerror_in_idle()) or equal to the
902 * @source_tag argument given to g_simple_async_result_new() (which, by
903 * convention, is a pointer to the _async function corresponding to the
904 * _finish function from which this function is called).
906 * Returns: #TRUE if all checks passed or #FALSE if any failed.
911 g_simple_async_result_is_valid (GAsyncResult *result,
915 GSimpleAsyncResult *simple;
918 if (!G_IS_SIMPLE_ASYNC_RESULT (result))
920 simple = (GSimpleAsyncResult *)result;
922 cmp_source = g_async_result_get_source_object (result);
923 if (cmp_source != source)
925 if (cmp_source != NULL)
926 g_object_unref (cmp_source);
929 if (cmp_source != NULL)
930 g_object_unref (cmp_source);
932 return source_tag == NULL ||
933 source_tag == g_simple_async_result_get_source_tag (simple);
937 * g_simple_async_report_error_in_idle:
938 * @object: a #GObject.
939 * @callback: a #GAsyncReadyCallback.
940 * @user_data: user data passed to @callback.
941 * @domain: a #GQuark containing the error domain (usually #G_IO_ERROR).
942 * @code: a specific error code.
943 * @format: a formatted error reporting string.
944 * @...: a list of variables to fill in @format.
946 * Reports an error in an asynchronous function in an idle function by
947 * directly setting the contents of the #GAsyncResult with the given error
951 g_simple_async_report_error_in_idle (GObject *object,
952 GAsyncReadyCallback callback,
959 GSimpleAsyncResult *simple;
962 g_return_if_fail (G_IS_OBJECT (object));
963 g_return_if_fail (domain != 0);
964 g_return_if_fail (format != NULL);
966 simple = g_simple_async_result_new (object,
970 va_start (args, format);
971 g_simple_async_result_set_error_va (simple, domain, code, format, args);
973 g_simple_async_result_complete_in_idle (simple);
974 g_object_unref (simple);
978 * g_simple_async_report_gerror_in_idle:
979 * @object: a #GObject.
980 * @callback: a #GAsyncReadyCallback.
981 * @user_data: user data passed to @callback.
982 * @error: the #GError to report
984 * Reports an error in an idle function. Similar to
985 * g_simple_async_report_error_in_idle(), but takes a #GError rather
986 * than building a new one.
989 g_simple_async_report_gerror_in_idle (GObject *object,
990 GAsyncReadyCallback callback,
994 GSimpleAsyncResult *simple;
996 g_return_if_fail (G_IS_OBJECT (object));
997 g_return_if_fail (error != NULL);
999 simple = g_simple_async_result_new_from_error (object,
1003 g_simple_async_result_complete_in_idle (simple);
1004 g_object_unref (simple);
1008 * g_simple_async_report_take_gerror_in_idle:
1009 * @object: a #GObject.
1010 * @callback: a #GAsyncReadyCallback.
1011 * @user_data: user data passed to @callback.
1012 * @error: the #GError to report
1014 * Reports an error in an idle function. Similar to
1015 * g_simple_async_report_gerror_in_idle(), but takes over the caller's
1016 * ownership of @error, so the caller does not have to free it any more.
1021 g_simple_async_report_take_gerror_in_idle (GObject *object,
1022 GAsyncReadyCallback callback,
1026 GSimpleAsyncResult *simple;
1028 g_return_if_fail (G_IS_OBJECT (object));
1029 g_return_if_fail (error != NULL);
1031 simple = g_simple_async_result_new_take_error (object,
1035 g_simple_async_result_complete_in_idle (simple);
1036 g_object_unref (simple);