luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-11 23:16:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Mention the idiomatic way of invoking a GAsyncReadyCallback

Browse Source 
The GAsyncResult documentation didn't specify the context in which the
GAsyncReadyCallback is expected to be invoked. Since asynchronous
operations can be implemented in various ways involving GSources,
threads and coroutines, it is useful to mention what the standard
expections are.

Unfortunately, since this was left undefined for so long, we can only
phrase it as a suggestion, and not as a hard requirement.

https://bugzilla.gnome.org/show_bug.cgi?id=783825
This commit is contained in:
Debarshi Ray 2017-06-16 14:47:33 +02:00
parent 09d936c528
commit 7339a09376
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
gio/gasyncresult.c
View File

@ -36,13 +36,16 @@
* which are chained together by a #GAsyncReadyCallback. To begin * which are chained together by a #GAsyncReadyCallback. To begin
* an asynchronous operation, provide a #GAsyncReadyCallback to the * an asynchronous operation, provide a #GAsyncReadyCallback to the
* asynchronous function. This callback will be triggered when the * asynchronous function. This callback will be triggered when the
* operation has completed, and will be passed a #GAsyncResult instance * operation has completed, and must be run in a later iteration of
* filled with the details of the operation's success or failure, the * the [thread-default main context][g-main-context-push-thread-default]
* object the asynchronous function was started for and any error codes * from where the operation was initiated. It will be passed a
* returned. The asynchronous callback function is then expected to call * #GAsyncResult instance filled with the details of the operation's
* the corresponding "_finish()" function, passing the object the * success or failure, the object the asynchronous function was
* function was called for, the #GAsyncResult instance, and (optionally) * started for and any error codes returned. The asynchronous callback
* an @error to grab any error conditions that may have occurred. * function is then expected to call the corresponding "_finish()"
* function, passing the object the function was called for, the
* #GAsyncResult instance, and (optionally) an @error to grab any
* error conditions that may have occurred.
* *
* The "_finish()" function for an operation takes the generic result * The "_finish()" function for an operation takes the generic result
* (of type #GAsyncResult) and returns the specific result that the * (of type #GAsyncResult) and returns the specific result that the