Add advice on g_cancellable_reset

Don't use it at home.
This commit is contained in:
Matthias Clasen 2014-10-06 22:41:06 -04:00
parent da053e345b
commit de82b641b0

View File

@ -244,6 +244,13 @@ g_cancellable_get_current (void)
*
* If cancellable is currently in use by any cancellable operation
* then the behavior of this function is undefined.
*
* Note that it is generally not a good idea to reuse an existing
* cancellable for more operations after it has been cancelled once,
* as this function might tempt you to do. The recommended practice
* is to drop the reference to a cancellable after cancelling it,
* and let it die with the outstanding async operations. You should
* create a fresh cancellable for further async operations.
**/
void
g_cancellable_reset (GCancellable *cancellable)