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.
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, simple);
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
;
230 GCancellable
*check_cancellable
;
240 GDestroyNotify destroy_op_res
;
243 struct _GSimpleAsyncResultClass
245 GObjectClass parent_class
;
249 G_DEFINE_TYPE_WITH_CODE (GSimpleAsyncResult
, g_simple_async_result
, G_TYPE_OBJECT
,
250 G_IMPLEMENT_INTERFACE (G_TYPE_ASYNC_RESULT
,
251 g_simple_async_result_async_result_iface_init
))
254 clear_op_res (GSimpleAsyncResult
*simple
)
256 if (simple
->destroy_op_res
)
257 simple
->destroy_op_res (simple
->op_res
.v_pointer
);
258 simple
->destroy_op_res
= NULL
;
259 simple
->op_res
.v_ssize
= 0;
263 g_simple_async_result_finalize (GObject
*object
)
265 GSimpleAsyncResult
*simple
;
267 simple
= G_SIMPLE_ASYNC_RESULT (object
);
269 if (simple
->source_object
)
270 g_object_unref (simple
->source_object
);
272 if (simple
->check_cancellable
)
273 g_object_unref (simple
->check_cancellable
);
275 g_main_context_unref (simple
->context
);
277 clear_op_res (simple
);
280 g_error_free (simple
->error
);
282 G_OBJECT_CLASS (g_simple_async_result_parent_class
)->finalize (object
);
286 g_simple_async_result_class_init (GSimpleAsyncResultClass
*klass
)
288 GObjectClass
*gobject_class
= G_OBJECT_CLASS (klass
);
290 gobject_class
->finalize
= g_simple_async_result_finalize
;
294 g_simple_async_result_init (GSimpleAsyncResult
*simple
)
296 simple
->handle_cancellation
= TRUE
;
298 simple
->context
= g_main_context_ref_thread_default ();
302 * g_simple_async_result_new:
303 * @source_object: (allow-none): a #GObject, or %NULL.
304 * @callback: (scope async): a #GAsyncReadyCallback.
305 * @user_data: (closure): user data passed to @callback.
306 * @source_tag: the asynchronous function.
308 * Creates a #GSimpleAsyncResult.
310 * The common convention is to create the #GSimpleAsyncResult in the
311 * function that starts the asynchronous operation and use that same
312 * function as the @source_tag.
314 * If your operation supports cancellation with #GCancellable (which it
315 * probably should) then you should provide the user's cancellable to
316 * g_simple_async_result_set_check_cancellable() immediately after
317 * this function returns.
319 * Returns: a #GSimpleAsyncResult.
322 g_simple_async_result_new (GObject
*source_object
,
323 GAsyncReadyCallback callback
,
327 GSimpleAsyncResult
*simple
;
329 g_return_val_if_fail (!source_object
|| G_IS_OBJECT (source_object
), NULL
);
331 simple
= g_object_new (G_TYPE_SIMPLE_ASYNC_RESULT
, NULL
);
332 simple
->callback
= callback
;
334 simple
->source_object
= g_object_ref (source_object
);
336 simple
->source_object
= NULL
;
337 simple
->user_data
= user_data
;
338 simple
->source_tag
= source_tag
;
344 * g_simple_async_result_new_from_error:
345 * @source_object: (allow-none): a #GObject, or %NULL.
346 * @callback: (scope async): a #GAsyncReadyCallback.
347 * @user_data: (closure): user data passed to @callback.
350 * Creates a #GSimpleAsyncResult from an error condition.
352 * Returns: a #GSimpleAsyncResult.
355 g_simple_async_result_new_from_error (GObject
*source_object
,
356 GAsyncReadyCallback callback
,
360 GSimpleAsyncResult
*simple
;
362 g_return_val_if_fail (!source_object
|| G_IS_OBJECT (source_object
), NULL
);
364 simple
= g_simple_async_result_new (source_object
,
367 g_simple_async_result_set_from_error (simple
, error
);
373 * g_simple_async_result_new_take_error: (skip)
374 * @source_object: (allow-none): a #GObject, or %NULL
375 * @callback: (scope async): a #GAsyncReadyCallback
376 * @user_data: (closure): user data passed to @callback
379 * Creates a #GSimpleAsyncResult from an error condition, and takes over the
380 * caller's ownership of @error, so the caller does not need to free it anymore.
382 * Returns: a #GSimpleAsyncResult
387 g_simple_async_result_new_take_error (GObject
*source_object
,
388 GAsyncReadyCallback callback
,
392 GSimpleAsyncResult
*simple
;
394 g_return_val_if_fail (!source_object
|| G_IS_OBJECT (source_object
), NULL
);
396 simple
= g_simple_async_result_new (source_object
,
399 g_simple_async_result_take_error (simple
, error
);
405 * g_simple_async_result_new_error:
406 * @source_object: (allow-none): a #GObject, or %NULL.
407 * @callback: (scope async): a #GAsyncReadyCallback.
408 * @user_data: (closure): user data passed to @callback.
409 * @domain: a #GQuark.
410 * @code: an error code.
411 * @format: a string with format characters.
412 * @...: a list of values to insert into @format.
414 * Creates a new #GSimpleAsyncResult with a set error.
416 * Returns: a #GSimpleAsyncResult.
419 g_simple_async_result_new_error (GObject
*source_object
,
420 GAsyncReadyCallback callback
,
427 GSimpleAsyncResult
*simple
;
430 g_return_val_if_fail (!source_object
|| G_IS_OBJECT (source_object
), NULL
);
431 g_return_val_if_fail (domain
!= 0, NULL
);
432 g_return_val_if_fail (format
!= NULL
, NULL
);
434 simple
= g_simple_async_result_new (source_object
,
438 va_start (args
, format
);
439 g_simple_async_result_set_error_va (simple
, domain
, code
, format
, args
);
447 g_simple_async_result_get_user_data (GAsyncResult
*res
)
449 return G_SIMPLE_ASYNC_RESULT (res
)->user_data
;
453 g_simple_async_result_get_source_object (GAsyncResult
*res
)
455 if (G_SIMPLE_ASYNC_RESULT (res
)->source_object
)
456 return g_object_ref (G_SIMPLE_ASYNC_RESULT (res
)->source_object
);
461 g_simple_async_result_is_tagged (GAsyncResult
*res
,
464 return G_SIMPLE_ASYNC_RESULT (res
)->source_tag
== source_tag
;
468 g_simple_async_result_async_result_iface_init (GAsyncResultIface
*iface
)
470 iface
->get_user_data
= g_simple_async_result_get_user_data
;
471 iface
->get_source_object
= g_simple_async_result_get_source_object
;
472 iface
->is_tagged
= g_simple_async_result_is_tagged
;
476 * g_simple_async_result_set_handle_cancellation:
477 * @simple: a #GSimpleAsyncResult.
478 * @handle_cancellation: a #gboolean.
480 * Sets whether to handle cancellation within the asynchronous operation.
482 * This function has nothing to do with
483 * g_simple_async_result_set_check_cancellable(). It only refers to the
484 * #GCancellable passed to g_simple_async_result_run_in_thread().
487 g_simple_async_result_set_handle_cancellation (GSimpleAsyncResult
*simple
,
488 gboolean handle_cancellation
)
490 g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple
));
491 simple
->handle_cancellation
= handle_cancellation
;
495 * g_simple_async_result_get_source_tag: (skip)
496 * @simple: a #GSimpleAsyncResult.
498 * Gets the source tag for the #GSimpleAsyncResult.
500 * Returns: a #gpointer to the source object for the #GSimpleAsyncResult.
503 g_simple_async_result_get_source_tag (GSimpleAsyncResult
*simple
)
505 g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple
), NULL
);
506 return simple
->source_tag
;
510 * g_simple_async_result_propagate_error:
511 * @simple: a #GSimpleAsyncResult.
512 * @dest: (out): a location to propagate the error to.
514 * Propagates an error from within the simple asynchronous result to
515 * a given destination.
517 * If the #GCancellable given to a prior call to
518 * g_simple_async_result_set_check_cancellable() is cancelled then this
519 * function will return %TRUE with @dest set appropriately.
521 * Returns: %TRUE if the error was propagated to @dest. %FALSE otherwise.
524 g_simple_async_result_propagate_error (GSimpleAsyncResult
*simple
,
527 g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple
), FALSE
);
529 if (g_cancellable_set_error_if_cancelled (simple
->check_cancellable
, dest
))
534 g_propagate_error (dest
, simple
->error
);
535 simple
->error
= NULL
;
543 * g_simple_async_result_set_op_res_gpointer: (skip)
544 * @simple: a #GSimpleAsyncResult.
545 * @op_res: a pointer result from an asynchronous function.
546 * @destroy_op_res: a #GDestroyNotify function.
548 * Sets the operation result within the asynchronous result to a pointer.
551 g_simple_async_result_set_op_res_gpointer (GSimpleAsyncResult
*simple
,
553 GDestroyNotify destroy_op_res
)
555 g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple
));
557 clear_op_res (simple
);
558 simple
->op_res
.v_pointer
= op_res
;
559 simple
->destroy_op_res
= destroy_op_res
;
563 * g_simple_async_result_get_op_res_gpointer: (skip)
564 * @simple: a #GSimpleAsyncResult.
566 * Gets a pointer result as returned by the asynchronous function.
568 * Returns: a pointer from the result.
571 g_simple_async_result_get_op_res_gpointer (GSimpleAsyncResult
*simple
)
573 g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple
), NULL
);
574 return simple
->op_res
.v_pointer
;
578 * g_simple_async_result_set_op_res_gssize:
579 * @simple: a #GSimpleAsyncResult.
580 * @op_res: a #gssize.
582 * Sets the operation result within the asynchronous result to
586 g_simple_async_result_set_op_res_gssize (GSimpleAsyncResult
*simple
,
589 g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple
));
590 clear_op_res (simple
);
591 simple
->op_res
.v_ssize
= op_res
;
595 * g_simple_async_result_get_op_res_gssize:
596 * @simple: a #GSimpleAsyncResult.
598 * Gets a gssize from the asynchronous result.
600 * Returns: a gssize returned from the asynchronous function.
603 g_simple_async_result_get_op_res_gssize (GSimpleAsyncResult
*simple
)
605 g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple
), 0);
606 return simple
->op_res
.v_ssize
;
610 * g_simple_async_result_set_op_res_gboolean:
611 * @simple: a #GSimpleAsyncResult.
612 * @op_res: a #gboolean.
614 * Sets the operation result to a boolean within the asynchronous result.
617 g_simple_async_result_set_op_res_gboolean (GSimpleAsyncResult
*simple
,
620 g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple
));
621 clear_op_res (simple
);
622 simple
->op_res
.v_boolean
= !!op_res
;
626 * g_simple_async_result_get_op_res_gboolean:
627 * @simple: a #GSimpleAsyncResult.
629 * Gets the operation result boolean from within the asynchronous result.
631 * Returns: %TRUE if the operation's result was %TRUE, %FALSE
632 * if the operation's result was %FALSE.
635 g_simple_async_result_get_op_res_gboolean (GSimpleAsyncResult
*simple
)
637 g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple
), FALSE
);
638 return simple
->op_res
.v_boolean
;
642 * g_simple_async_result_set_from_error:
643 * @simple: a #GSimpleAsyncResult.
646 * Sets the result from a #GError.
649 g_simple_async_result_set_from_error (GSimpleAsyncResult
*simple
,
652 g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple
));
653 g_return_if_fail (error
!= NULL
);
656 g_error_free (simple
->error
);
657 simple
->error
= g_error_copy (error
);
658 simple
->failed
= TRUE
;
662 * g_simple_async_result_take_error: (skip)
663 * @simple: a #GSimpleAsyncResult
666 * Sets the result from @error, and takes over the caller's ownership
667 * of @error, so the caller does not need to free it any more.
672 g_simple_async_result_take_error (GSimpleAsyncResult
*simple
,
675 g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple
));
676 g_return_if_fail (error
!= NULL
);
679 g_error_free (simple
->error
);
680 simple
->error
= error
;
681 simple
->failed
= TRUE
;
685 * g_simple_async_result_set_error_va: (skip)
686 * @simple: a #GSimpleAsyncResult.
687 * @domain: a #GQuark (usually #G_IO_ERROR).
688 * @code: an error code.
689 * @format: a formatted error reporting string.
690 * @args: va_list of arguments.
692 * Sets an error within the asynchronous result without a #GError.
693 * Unless writing a binding, see g_simple_async_result_set_error().
696 g_simple_async_result_set_error_va (GSimpleAsyncResult
*simple
,
702 g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple
));
703 g_return_if_fail (domain
!= 0);
704 g_return_if_fail (format
!= NULL
);
707 g_error_free (simple
->error
);
708 simple
->error
= g_error_new_valist (domain
, code
, format
, args
);
709 simple
->failed
= TRUE
;
713 * g_simple_async_result_set_error: (skip)
714 * @simple: a #GSimpleAsyncResult.
715 * @domain: a #GQuark (usually #G_IO_ERROR).
716 * @code: an error code.
717 * @format: a formatted error reporting string.
718 * @...: a list of variables to fill in @format.
720 * Sets an error within the asynchronous result without a #GError.
723 g_simple_async_result_set_error (GSimpleAsyncResult
*simple
,
731 g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple
));
732 g_return_if_fail (domain
!= 0);
733 g_return_if_fail (format
!= NULL
);
735 va_start (args
, format
);
736 g_simple_async_result_set_error_va (simple
, domain
, code
, format
, args
);
741 * g_simple_async_result_complete:
742 * @simple: a #GSimpleAsyncResult.
744 * Completes an asynchronous I/O job immediately. Must be called in
745 * the thread where the asynchronous result was to be delivered, as it
746 * invokes the callback directly. If you are in a different thread use
747 * g_simple_async_result_complete_in_idle().
749 * Calling this function takes a reference to @simple for as long as
750 * is needed to complete the call.
753 g_simple_async_result_complete (GSimpleAsyncResult
*simple
)
755 #ifndef G_DISABLE_CHECKS
756 GSource
*current_source
;
757 GMainContext
*current_context
;
760 g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple
));
762 #ifndef G_DISABLE_CHECKS
763 current_source
= g_main_current_source ();
764 if (current_source
&& !g_source_is_destroyed (current_source
))
766 current_context
= g_source_get_context (current_source
);
767 if (simple
->context
!= current_context
)
768 g_warning ("g_simple_async_result_complete() called from wrong context!");
772 if (simple
->callback
)
774 g_main_context_push_thread_default (simple
->context
);
775 simple
->callback (simple
->source_object
,
776 G_ASYNC_RESULT (simple
),
778 g_main_context_pop_thread_default (simple
->context
);
783 complete_in_idle_cb (gpointer data
)
785 GSimpleAsyncResult
*simple
= G_SIMPLE_ASYNC_RESULT (data
);
787 g_simple_async_result_complete (simple
);
793 * g_simple_async_result_complete_in_idle:
794 * @simple: a #GSimpleAsyncResult.
796 * Completes an asynchronous function in an idle handler in the <link
797 * linkend="g-main-context-push-thread-default">thread-default main
798 * loop</link> of the thread that @simple was initially created in
799 * (and re-pushes that context around the invocation of the callback).
801 * Calling this function takes a reference to @simple for as long as
802 * is needed to complete the call.
805 g_simple_async_result_complete_in_idle (GSimpleAsyncResult
*simple
)
809 g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple
));
811 g_object_ref (simple
);
813 source
= g_idle_source_new ();
814 g_source_set_priority (source
, G_PRIORITY_DEFAULT
);
815 g_source_set_callback (source
, complete_in_idle_cb
, simple
, g_object_unref
);
817 g_source_attach (source
, simple
->context
);
818 g_source_unref (source
);
822 GSimpleAsyncResult
*simple
;
823 GCancellable
*cancellable
;
824 GSimpleAsyncThreadFunc func
;
829 complete_in_idle_cb_for_thread (gpointer _data
)
831 RunInThreadData
*data
= _data
;
832 GSimpleAsyncResult
*simple
;
834 simple
= data
->simple
;
836 if (simple
->handle_cancellation
&&
837 g_cancellable_is_cancelled (data
->cancellable
))
838 g_simple_async_result_set_error (simple
,
840 G_IO_ERROR_CANCELLED
,
841 "%s", _("Operation was cancelled"));
843 g_simple_async_result_complete (simple
);
845 if (data
->cancellable
)
846 g_object_unref (data
->cancellable
);
847 g_object_unref (data
->simple
);
854 run_in_thread (GIOSchedulerJob
*job
,
858 RunInThreadData
*data
= _data
;
859 GSimpleAsyncResult
*simple
= data
->simple
;
862 if (simple
->handle_cancellation
&&
863 g_cancellable_is_cancelled (c
))
864 g_simple_async_result_set_error (simple
,
866 G_IO_ERROR_CANCELLED
,
867 "%s", _("Operation was cancelled"));
870 simple
->source_object
,
873 source
= g_idle_source_new ();
874 g_source_set_priority (source
, G_PRIORITY_DEFAULT
);
875 g_source_set_callback (source
, complete_in_idle_cb_for_thread
, data
, NULL
);
877 g_source_attach (source
, simple
->context
);
878 g_source_unref (source
);
884 * g_simple_async_result_run_in_thread: (skip)
885 * @simple: a #GSimpleAsyncResult.
886 * @func: a #GSimpleAsyncThreadFunc.
887 * @io_priority: the io priority of the request.
888 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
890 * Runs the asynchronous job in a separate thread and then calls
891 * g_simple_async_result_complete_in_idle() on @simple to return
892 * the result to the appropriate main loop.
894 * Calling this function takes a reference to @simple for as long as
895 * is needed to run the job and report its completion.
898 g_simple_async_result_run_in_thread (GSimpleAsyncResult
*simple
,
899 GSimpleAsyncThreadFunc func
,
901 GCancellable
*cancellable
)
903 RunInThreadData
*data
;
905 g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple
));
906 g_return_if_fail (func
!= NULL
);
908 data
= g_new (RunInThreadData
, 1);
910 data
->simple
= g_object_ref (simple
);
911 data
->cancellable
= cancellable
;
913 g_object_ref (cancellable
);
914 g_io_scheduler_push_job (run_in_thread
, data
, NULL
, io_priority
, cancellable
);
918 * g_simple_async_result_is_valid:
919 * @result: the #GAsyncResult passed to the _finish function.
920 * @source: the #GObject passed to the _finish function.
921 * @source_tag: the asynchronous function.
923 * Ensures that the data passed to the _finish function of an async
924 * operation is consistent. Three checks are performed.
926 * First, @result is checked to ensure that it is really a
927 * #GSimpleAsyncResult. Second, @source is checked to ensure that it
928 * matches the source object of @result. Third, @source_tag is
929 * checked to ensure that it is either %NULL (as it is when the result was
930 * created by g_simple_async_report_error_in_idle() or
931 * g_simple_async_report_gerror_in_idle()) or equal to the
932 * @source_tag argument given to g_simple_async_result_new() (which, by
933 * convention, is a pointer to the _async function corresponding to the
934 * _finish function from which this function is called).
936 * Returns: #TRUE if all checks passed or #FALSE if any failed.
941 g_simple_async_result_is_valid (GAsyncResult
*result
,
945 GSimpleAsyncResult
*simple
;
948 if (!G_IS_SIMPLE_ASYNC_RESULT (result
))
950 simple
= (GSimpleAsyncResult
*)result
;
952 cmp_source
= g_async_result_get_source_object (result
);
953 if (cmp_source
!= source
)
955 if (cmp_source
!= NULL
)
956 g_object_unref (cmp_source
);
959 if (cmp_source
!= NULL
)
960 g_object_unref (cmp_source
);
962 return source_tag
== NULL
||
963 source_tag
== g_simple_async_result_get_source_tag (simple
);
967 * g_simple_async_report_error_in_idle: (skip)
968 * @object: (allow-none): a #GObject, or %NULL.
969 * @callback: a #GAsyncReadyCallback.
970 * @user_data: user data passed to @callback.
971 * @domain: a #GQuark containing the error domain (usually #G_IO_ERROR).
972 * @code: a specific error code.
973 * @format: a formatted error reporting string.
974 * @...: a list of variables to fill in @format.
976 * Reports an error in an asynchronous function in an idle function by
977 * directly setting the contents of the #GAsyncResult with the given error
981 g_simple_async_report_error_in_idle (GObject
*object
,
982 GAsyncReadyCallback callback
,
989 GSimpleAsyncResult
*simple
;
992 g_return_if_fail (!object
|| G_IS_OBJECT (object
));
993 g_return_if_fail (domain
!= 0);
994 g_return_if_fail (format
!= NULL
);
996 simple
= g_simple_async_result_new (object
,
1000 va_start (args
, format
);
1001 g_simple_async_result_set_error_va (simple
, domain
, code
, format
, args
);
1003 g_simple_async_result_complete_in_idle (simple
);
1004 g_object_unref (simple
);
1008 * g_simple_async_report_gerror_in_idle:
1009 * @object: (allow-none): a #GObject, or %NULL
1010 * @callback: (scope async): a #GAsyncReadyCallback.
1011 * @user_data: (closure): 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_error_in_idle(), but takes a #GError rather
1016 * than building a new one.
1019 g_simple_async_report_gerror_in_idle (GObject
*object
,
1020 GAsyncReadyCallback callback
,
1022 const GError
*error
)
1024 GSimpleAsyncResult
*simple
;
1026 g_return_if_fail (!object
|| G_IS_OBJECT (object
));
1027 g_return_if_fail (error
!= NULL
);
1029 simple
= g_simple_async_result_new_from_error (object
,
1033 g_simple_async_result_complete_in_idle (simple
);
1034 g_object_unref (simple
);
1038 * g_simple_async_report_take_gerror_in_idle: (skip)
1039 * @object: (allow-none): a #GObject, or %NULL
1040 * @callback: a #GAsyncReadyCallback.
1041 * @user_data: user data passed to @callback.
1042 * @error: the #GError to report
1044 * Reports an error in an idle function. Similar to
1045 * g_simple_async_report_gerror_in_idle(), but takes over the caller's
1046 * ownership of @error, so the caller does not have to free it any more.
1051 g_simple_async_report_take_gerror_in_idle (GObject
*object
,
1052 GAsyncReadyCallback callback
,
1056 GSimpleAsyncResult
*simple
;
1058 g_return_if_fail (!object
|| G_IS_OBJECT (object
));
1059 g_return_if_fail (error
!= NULL
);
1061 simple
= g_simple_async_result_new_take_error (object
,
1065 g_simple_async_result_complete_in_idle (simple
);
1066 g_object_unref (simple
);
1070 * g_simple_async_result_set_check_cancellable:
1071 * @simple: a #GSimpleAsyncResult
1072 * @check_cancellable: (allow-none): a #GCancellable to check, or %NULL to unset
1074 * Sets a #GCancellable to check before dispatching results.
1076 * This function has one very specific purpose: the provided cancellable
1077 * is checked at the time of g_simple_async_result_propagate_error() If
1078 * it is cancelled, these functions will return an "Operation was
1079 * cancelled" error (%G_IO_ERROR_CANCELLED).
1081 * Implementors of cancellable asynchronous functions should use this in
1082 * order to provide a guarantee to their callers that cancelling an
1083 * async operation will reliably result in an error being returned for
1084 * that operation (even if a positive result for the operation has
1085 * already been sent as an idle to the main context to be dispatched).
1087 * The checking described above is done regardless of any call to the
1088 * unrelated g_simple_async_result_set_handle_cancellation() function.
1093 g_simple_async_result_set_check_cancellable (GSimpleAsyncResult
*simple
,
1094 GCancellable
*check_cancellable
)
1096 g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple
));
1097 g_return_if_fail (check_cancellable
== NULL
|| G_IS_CANCELLABLE (check_cancellable
));
1099 g_clear_object (&simple
->check_cancellable
);
1100 if (check_cancellable
)
1101 simple
->check_cancellable
= g_object_ref (check_cancellable
);