Struct Mutex

pub struct Mutex<'a, T>
where
    T: Debug,
{ /* private fields */ }

Represents a POSIX mutex which can be created by the MutexBuilder.

Example

For a detailed builder example, see MutexBuilder.

use iceoryx2_bb_posix::mutex::*;
use core::time::Duration;

let handle = MutexHandle::<i32>::new();
let mutex = MutexBuilder::new().create(5, &handle)
    .expect("Failed to create mutex");

{
    let guard = mutex.lock().expect("failed to lock mutex");
    println!("current mutex value is: {}", *guard);
}

match mutex.try_lock().expect("failed to lock") {
    Some(mut guard) => *guard = 123, // set mutex value to 123
    None => println!("unable to acquire lock"),
};

match mutex.timed_lock(Duration::from_secs(1)).expect("failed to lock") {
    Some(guard) => println!("New mutex value is: {}", *guard),
    None => println!("Timeout occurred while trying to get lock.")
};

Implementations

impl<T> Mutex<'_, T>

where T: Debug,

pub fn lock(&self) -> Result<MutexGuard<'_, '_, T>, MutexLockError<'_, '_, T>>

Blocks until the ownership of the lock could be acquired. If it was successful it returns a MutexGuard to allow access to the underlying value. If the previously owning thread has died and MutexThreadTerminationBehavior::ReleaseWhenLocked was set it returns the error MutexLockError::LockAcquiredButOwnerDied which contains also the MutexGuard. The new owner now has the responsibility to either repair the underlying value of the mutex and call Mutex::make_consistent() when it is repaired or to undertake other measures when it is unrepairable.

pub fn try_lock( &self, ) -> Result<Option<MutexGuard<'_, '_, T>>, MutexLockError<'_, '_, T>>

Tries to acquire the ownership of the lock. If it was successful it returns a MutexGuard packed inside an Option, if the lock is already owned by someone else it returns None. If the previously owning thread has died and MutexThreadTerminationBehavior::ReleaseWhenLocked was set it returns the error MutexLockError::LockAcquiredButOwnerDied which contains also the MutexGuard. The new owner now has the responsibility to either repair the underlying value of the mutex and call Mutex::make_consistent() when it is repaired or to undertake other measures when it is unrepairable.

pub fn timed_lock( &self, duration: Duration, ) -> Result<Option<MutexGuard<'_, '_, T>>, MutexTimedLockError<'_, '_, T>>

Tries to acquire the ownership of the lock until the provided timeout has elapsed. If it was successful it returns a MutexGuard packed inside an Option, if the could not be acquired lock when the timeout passed it returns None. If the previously owning thread has died and MutexThreadTerminationBehavior::ReleaseWhenLocked was set it returns the error MutexTimedLockError::MutexLockError which contains also the MutexGuard. The new owner now has the responsibility to either repair the underlying value of the mutex and call Mutex::make_consistent() when it is repaired or to undertake other measures when it is unrepairable.

pub fn make_consistent(&self)

If the previously owning thread has died and MutexThreadTerminationBehavior::ReleaseWhenLocked was set it returns the error MutexLockError::LockAcquiredButOwnerDied which contains also the MutexGuard. The new owner now has the responsibility to either repair the underlying value of the mutex and call Mutex::make_consistent() when it is repaired or to undertake other measures when it is unrepairable.

Trait Implementations

impl<'a, T> Debug for Mutex<'a, T>

where T: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'a, T> IpcCapable<'a, MutexHandle<T>> for Mutex<'a, T>

where T: Debug,

fn is_interprocess_capable(&self) -> bool

Returns true if the object is interprocess capable, otherwise false

unsafe fn from_ipc_handle(handle: &'a T) -> Self

Creates an IPC Capable object from its handle.

impl<T> Send for Mutex<'_, T>

where T: Send + Debug,

impl<T> Sync for Mutex<'_, T>

where T: Send + Debug,