xwrust::xwos::lock::mtx

Struct Mutex

pub struct Mutex<T: ?Sized> { /* private fields */ }

Expand description

互斥锁对象结构体

Implementations§

source §

impl<T> Mutex<T>

source

pub const fn new(t: T) -> Self

新建互斥锁对象

此方法是编译期方法，可用于新建 static 约束的全局变量。

§示例

use xwrust::xwos::lock::mtx::*;

static GLOBAL_MUTEX: Mutex<u32> = Mutex::new(0);

source §

impl<T: ?Sized> Mutex<T>

source

pub fn init(&self)

初始化互斥锁对象

互斥锁对象必须调用此方法一次，方可正常使用。

§上下文

任意

§示例

use xwrust::xwos::lock::mtx::*;

static GLOBAL_MUTEX: Mutex<u32> = Mutex::new(0);

pub fn xwrust_example_mutex() {
    // ...省略...
    GLOBAL_MUTEX.init();
    // 从此处开始 GLOBAL_MUTEX 可正常使用
}

source

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

获取互斥锁，若线程无法获取互斥锁，就阻塞等待，直到能获得锁为止

若成功获取互斥锁，将返回 RAII Guard ： MutexGuard ，用于提供 Scoped Lock 机制。
- MutexGuard 中包含 Mutex 的引用，当 MutexGuard 生命周期结束时，会在 drop() 方法中自动解锁互斥锁。
若失败，将返回错误码 MutexError 。

§上下文

线程

§错误码

MutexError::NotInit 互斥锁未被初始化
MutexError::Interrupt 等待被中断
MutexError::NotThreadContext 不在线程上下文中
MutexError::DisPmpt 抢占被关闭
MutexError::DisBh 中断底半部被关闭
MutexError::DisIrq 中断被关闭

§示例

use xwrust::xwos::lock::mtx::*;
static GLOBAL_MUTEX: Mutex<u32> = Mutex::new(0);

pub fn xwrust_example_mutex() {
    // ...省略...
    GLOBAL_MUTEX.init();
    match GLOBAL_MUTEX.lock() {
        Ok(mut guard) => { // 上锁成功
            *guard = 1; // 访问共享变量
        } // guard 生命周期结束，自动解锁
        Err(e) => {
            // 上锁失败
        }
    }
}

source

pub fn trylock(&self) -> Result<MutexGuard<'_, T>, MutexError>

尝试获取互斥锁，若线程无法获取互斥锁，立即返回错误

若成功获取互斥锁，将返回 RAII Guard ： MutexGuard ，用于提供 Scoped Lock 机制。
- MutexGuard 中包含 Mutex 的引用，当 MutexGuard 生命周期结束时，会在 drop() 方法中自动解锁互斥锁。
若失败，将返回错误码 MutexError 。

§上下文

线程

§错误码

MutexError::NotInit 互斥锁未被初始化
MutexError::WouldBlock 尝试获取锁失败
MutexError::NotThreadContext 不在线程上下文中

§示例

use xwrust::xwos::lock::mtx::*;
static GLOBAL_MUTEX: Mutex<u32> = Mutex::new(0);

pub fn xwrust_example_mutex() {
    // ...省略...
    GLOBAL_MUTEX.init();
    match GLOBAL_MUTEX.trylock() {
        Ok(mut guard) => { // 上锁成功
            *guard = 1; // 访问共享变量
        } // guard 生命周期结束，自动解锁
        Err(e) => {
            // 上锁失败
        }
    }
}

source

pub fn lock_to(&self, to: XwTm) -> Result<MutexGuard<'_, T>, MutexError>

获取互斥锁，若线程无法获取互斥锁，就限时阻塞等待

若成功获取互斥锁，将返回 RAII Guard ： MutexGuard ，用于提供 Scoped Lock 机制。
- MutexGuard 中包含 Mutex 的引用，当 MutexGuard 生命周期结束时，会在 drop() 方法中自动解锁互斥锁。
若失败，将返回错误码 MutexError 。

§参数说明

to: 期望唤醒的时间点

§上下文

线程

§错误码

MutexError::NotInit 互斥锁未被初始化
MutexError::Interrupt 等待被中断
MutexError::Timedout 等待超时
MutexError::NotThreadContext 不在线程上下文中
MutexError::DisPmpt 抢占被关闭
MutexError::DisBh 中断底半部被关闭
MutexError::DisIrq 中断被关闭

§示例

use xwrust::xwtm;
use xwrust::xwos::lock::mtx::*;
static GLOBAL_MUTEX: Mutex<u32> = Mutex::new(0);

pub fn xwrust_example_mutex() {
    // ...省略...
    GLOBAL_MUTEX.init();
    match GLOBAL_MUTEX.lock_to(xwtm::ft(xwtm::s(10))) { // 最多等待10s
        Ok(mut guard) => { // 上锁成功
            *guard = 1; // 访问共享变量
        } // guard 生命周期结束，自动解锁
        Err(e) => {
            // 上锁失败
        }
    }
}

source

pub fn lock_unintr(&self) -> Result<MutexGuard<'_, T>, MutexError>

获取互斥锁，若线程无法获取互斥锁，就阻塞等待，且不可中断，直到能获得锁为止

若成功获取互斥锁，将返回 RAII Guard ： MutexGuard ，用于提供 Scoped Lock 机制。
- MutexGuard 中包含 Mutex 的引用，当 MutexGuard 生命周期结束时，会在 drop() 方法中自动解锁互斥锁。
若失败，将返回错误码 MutexError 。

§上下文

线程

§错误码

MutexError::NotInit 互斥锁未被初始化
MutexError::NotThreadContext 不在线程上下文中
MutexError::DisPmpt 抢占被关闭
MutexError::DisBh 中断底半部被关闭
MutexError::DisIrq 中断被关闭

§示例

use xwrust::xwos::lock::mtx::*;
static GLOBAL_MUTEX: Mutex<u32> = Mutex::new(0);

pub fn xwrust_example_mutex() {
    // ...省略...
    GLOBAL_MUTEX.init();
    match GLOBAL_MUTEX.lock_unintr() {
        Ok(mut guard) => { // 上锁成功
            *guard = 1; // 访问共享变量
        } // guard 生命周期结束，自动解锁
        Err(e) => {
            // 上锁失败
        }
    }
}

source

pub fn unlock(guard: MutexGuard<'_, T>)

释放 MutexGuard，并在 drop() 方法中解锁互斥锁

§上下文

线程

§示例

use xwrust::xwos::lock::mtx::*;
static GLOBAL_MUTEX: Mutex<u32> = Mutex::new(0);

pub fn xwrust_example_mutex() {
    // ...省略...
    GLOBAL_MUTEX.init();
    match GLOBAL_MUTEX.lock() {
        Ok(mut guard) => { // 上锁成功
            *guard = 1; // 访问共享变量
            Mutex::unlock(guard); // 主动解锁
        }
        Err(e) => {
            // 上锁失败
        }
    }
}