taskpool: modify transfer annotations for push() and join()

While the default implementation passes NULL around as the
task handle, other implementations can only provide a safe
API by having that handle map to a refcounted opaque type.

While what's passed around is a gpointer, a valid transfer
type annotation has informative value.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/692>
This commit is contained in:
Mathieu Duponchelle 2020-11-03 02:33:32 +01:00 committed by GStreamer Merge Bot
parent 20f6a2ece4
commit c884f4c124

View file

@ -233,7 +233,7 @@ gst_task_pool_cleanup (GstTaskPool * pool)
*
* Start the execution of a new thread from @pool.
*
* Returns: (transfer none) (nullable): a pointer that should be used
* Returns: (transfer full) (nullable): a pointer that should be used
* for the gst_task_pool_join function. This pointer can be %NULL, you
* must check @error to detect errors.
*/
@ -263,7 +263,7 @@ not_supported:
/**
* gst_task_pool_join:
* @pool: a #GstTaskPool
* @id: the id
* @id: (transfer full): the id
*
* Join a task and/or return it to the pool. @id is the id obtained from
* gst_task_pool_push().