sergiotarxz/nuttx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

include/nuttx/semaphore.h: Add a NOTE to the uninterruptible wait functions.

Browse Source
This commit is contained in:
Gregory Nutt 2020-04-06 09:39:49 -06:00 committed by Abdelatif Guettouche
parent c78bd930b5
commit f9a7417be4
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
include/nuttx/semaphore.h
View File

@ -526,6 +526,12 @@ int sem_setprotocol(FAR sem_t *sem, int protocol);
* EINVAL - Invalid attempt to get the semaphore * EINVAL - Invalid attempt to get the semaphore
* ECANCELED - May be returned if the thread is canceled while waiting. * ECANCELED - May be returned if the thread is canceled while waiting.
* *
* NOTE: It is essential that callers of this function handle the
* ECANCELED error. Correct handling is that the function should return the
* error and the error should propagate back up the calling tree to the
* cancellation point interface function where the thread termination will
* be handled gracefully
*
****************************************************************************/ ****************************************************************************/
int nxsem_wait_uninterruptible(FAR sem_t *sem); int nxsem_wait_uninterruptible(FAR sem_t *sem);
@ -551,6 +557,12 @@ int nxsem_wait_uninterruptible(FAR sem_t *sem);
* EDEADLK A deadlock condition was detected. * EDEADLK A deadlock condition was detected.
* ECANCELED May be returned if the thread is canceled while waiting. * ECANCELED May be returned if the thread is canceled while waiting.
* *
* NOTE: It is essential that callers of this function handle the
* ECANCELED error. Correct handling is that the function should return the
* error and the error should propagate back up the calling tree to the
* cancellation point interface function where the thread termination will
* be handled gracefully
*
****************************************************************************/ ****************************************************************************/
int nxsem_timedwait_uninterruptible(FAR sem_t *sem, int nxsem_timedwait_uninterruptible(FAR sem_t *sem,
@ -581,6 +593,12 @@ int nxsem_timedwait_uninterruptible(FAR sem_t *sem,
* -ETIMEDOUT is returned on the timeout condition. * -ETIMEDOUT is returned on the timeout condition.
* -ECANCELED may be returned if the thread is canceled while waiting. * -ECANCELED may be returned if the thread is canceled while waiting.
* *
* NOTE: It is essential that callers of this function handle the
* ECANCELED error. Correct handling is that the function should return the
* error and the error should propagate back up the calling tree to the
* cancellation point interface function where the thread termination will
* be handled gracefully
*
****************************************************************************/ ****************************************************************************/
int nxsem_tickwait_uninterruptible(FAR sem_t *sem, clock_t start, int nxsem_tickwait_uninterruptible(FAR sem_t *sem, clock_t start,