element: Add note about racyness to gst_element_set_locked_state()

This is racy if the state lock of the parent bin is not taken. The
parent bin might've just checked the flag in another thread and as the
next step proceed to change the child element's state.
This commit is contained in:
Sebastian Dröge 2019-01-07 14:08:25 +02:00
parent 7f70d7a945
commit cacc834d8f

View file

@ -2241,6 +2241,10 @@ gst_element_is_locked_state (GstElement * element)
* Locks the state of an element, so state changes of the parent don't affect * Locks the state of an element, so state changes of the parent don't affect
* this element anymore. * this element anymore.
* *
* Note that this is racy if the state lock of the parent bin is not taken.
* The parent bin might've just checked the flag in another thread and as the
* next step proceed to change the child element's state.
*
* MT safe. * MT safe.
* *
* Returns: %TRUE if the state was changed, %FALSE if bad parameters were given * Returns: %TRUE if the state was changed, %FALSE if bad parameters were given