util_semaphore_take() function

Take a semaphore. This routine takes @a sem.

Syntax

Show:

Summary

Declaration

Definition

from genie_util.h:139

int util_semaphore_take(util_semaphore_t *sem, uint32_t timeout);

Implemented in genie_util.c:128

Arguments

Argument

Description

sem

Address of the semaphore.

timeout

Waiting period to take the semaphore (in milliseconds), or one of the special values K_NO_WAIT and K_FOREVER.

Return value

0 Semaphore taken. -EBUSY Returned without waiting. -EAGAIN Waiting period timed out.

Notes

Can be called by ISRs, but @a timeout must be set to K_NO_WAIT. When porting code from the nanokernel legacy API to the new API, be careful with the return value of this function. The return value is the reverse of the one of nano_sem_take family of APIs: 0 means success, and non-zero means failure, while the nano_sem_take family returns 1 for success and 0 for failure.

Examples

References

from examples

util_semaphore_take() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle