Struct Semaphore

pub struct Semaphore { /* private fields */ }

Semaphore and mutex primitives.

Implementations

impl Semaphore

pub const fn new_counting(initial: u32, max: u32) -> Self

Create a new counting semaphore.

pub const fn new_mutex(recursive: bool) -> Self

Create a new mutex.

If recursive is true, the mutex can be locked multiple times by the same task.

pub fn try_take(&self) -> bool

Try to take the semaphore.

This is a non-blocking operation. The return value indicates whether the semaphore was successfully taken.

pub fn try_take_from_isr(&self) -> bool

Try to take the semaphore from an ISR.

This is a non-blocking operation. The return value indicates whether the semaphore was successfully taken.

pub fn take(&self, timeout_us: Option<u32>) -> bool

Take the semaphore.

This is a blocking operation.

If the semaphore is already taken, the task will be blocked until the semaphore is released. Recursive mutexes can be locked multiple times by the mutex owner task.

pub fn current_count(&self) -> u32

Return the current count of the semaphore.

pub fn give(&self) -> bool

Unlock the semaphore.

pub fn try_give_from_isr(&self) -> bool

Try to unlock the semaphore from an ISR.

The return value indicates whether the semaphore was successfully unlocked.

Trait Implementations

impl SemaphoreImplementation for Semaphore

fn create(kind: SemaphoreKind) -> SemaphorePtr

Creates a new semaphore instance.

unsafe fn delete(semaphore: SemaphorePtr)

Deletes a semaphore instance.

unsafe fn take(semaphore: SemaphorePtr, timeout_us: Option<u32>) -> bool

Increments the semaphore’s counter.

unsafe fn give(semaphore: SemaphorePtr) -> bool

Increments the semaphore’s counter.

unsafe fn current_count(semaphore: SemaphorePtr) -> u32

Returns the semaphore’s current counter value.

unsafe fn try_take(semaphore: SemaphorePtr) -> bool

Attempts to decrement the semaphore’s counter.

unsafe fn try_give_from_isr( semaphore: SemaphorePtr, _hptw: Option<&mut bool>, ) -> bool

Attempts to increment the semaphore’s counter from an ISR.

unsafe fn try_take_from_isr( semaphore: SemaphorePtr, _hptw: Option<&mut bool>, ) -> bool

Attempts to decrement the semaphore’s counter from an ISR.