互斥锁的RAII机制守卫更多...

#include <Mtx.hxx>

xwos::lock::Mtx::Grd 的协作图:

[图例]

Public 成员函数
	Grd ()=delete

	Grd (Mtx *mtx, enum LockMode mode=LockMode::MtxLock, xwtm_t to=((xwtm_t)((~(xwu64_t) 0) > > 1)))
	构造互斥锁的RAII机制守卫并上锁互斥锁

	Grd (Mtx &mtx, enum LockMode mode=LockMode::MtxLock, xwtm_t to=((xwtm_t)((~(xwu64_t) 0) > > 1)))
	构造互斥锁的RAII机制守卫并上锁互斥锁

	~Grd ()
	析构互斥锁的RAII机制守卫并解锁互斥锁

void	unlock ()
	解锁互斥锁

xwer_t	getRc ()
	获取上锁结果错误码

enum LockMode	getLockMode ()
	获取上锁模式

xwer_t	wait (sync::Cond *cond)
	等待条件量

xwer_t	wait (sync::Cond &cond)

xwer_t	wait (sync::Cond *cond, xwtm_t to)
	限时等待条件量

xwer_t	wait (sync::Cond &cond, xwtm_t to)

Private 属性
Mtx *	mMtx

xwer_t	mRc

enum LockMode	mLockMode

详细描述

互斥锁的RAII机制守卫

在文件 Mtx.hxx 第 106 行定义.

构造及析构函数说明

◆ Grd() [1/3]

xwos::lock::Mtx::Grd::Grd ( )

delete

◆ Grd() [2/3]

xwos::lock::Mtx::Grd::Grd	(	Mtx *	mtx,
		enum LockMode	mode = `LockMode::MtxLock`,
		xwtm_t	to = `((xwtm_t)((~(xwu64_t) 0) > > 1))`
	)

构造互斥锁的RAII机制守卫并上锁互斥锁

参数

[in]	mtx	互斥锁对象指针
[in]	mode	锁模式，取值 Mtx::LockMode Mtx::LockMode::MtxLock Mtx::LockMode::MtxLockTimed Mtx::LockMode::MtxLockUninterruptable Mtx::LockMode::MtxLockTry
[in]	to	期望唤醒的时间点，仅当 `mode == Mtx::LockMode::MtxLockTimed` 时有效。

注解

上下文：线程

上锁分为下列几种模式：
- Mtx::LockMode::MtxunLock 未上锁。
- Mtx::LockMode::MtxLock 如果无法上锁，调用线程会阻塞等待上锁。
- Mtx::LockMode::MtxLockTimed 定时等待模式，如果无法上锁，调用线程会定时阻塞等待上锁。
- Mtx::LockMode::MtxLockUninterruptable 不可中断等待模式，如果无法上锁，调用线程会阻塞等待上锁，且不可被中断。
- Mtx::LockMode::MtxLockTry 尝试上锁模式，如果无法上锁，调用线程不会阻塞等待，尝试失败立即返回。
此C++API返回的是 Mtx::Grd 的对象。 Mtx::Grd 是互斥锁的RAII机制守卫。
如果上锁成功( Mtx::Grd 内部的 mRc == XWOK )， Mtx::Grd 对象析构时会自动解锁互斥锁。
如果上锁失败，错误码存放在 Mtx::Grd 内部的 mRc ，可通过 Mtx::Grd::getRc() 获取。此时 Mtx::Grd 析构时不会解锁互斥锁。
当 mode 为 Mtx::LockMode::MtxLock 或 Mtx::LockMode::MtxLockTimed ,等待被中断时， mRc == -EINTR 。
当 mode 为 Mtx::LockMode::MtxLockTimed ,等待超时时， mRc == -ETIMEDOUT 。
当 mode 为 Mtx::LockMode::MtxLockTry ,上锁失败时， mRc == -EWOULDBLOCK 。

◆ Grd() [3/3]

xwos::lock::Mtx::Grd::Grd	(	Mtx &	mtx,
		enum LockMode	mode = `LockMode::MtxLock`,
		xwtm_t	to = `((xwtm_t)((~(xwu64_t) 0) > > 1))`
	)

构造互斥锁的RAII机制守卫并上锁互斥锁

参数

[in]	mode	锁模式，取值 Mtx::LockMode Mtx::LockMode::MtxLock Mtx::LockMode::MtxLockTimed Mtx::LockMode::MtxLockUninterruptable Mtx::LockMode::MtxLockTry
[in]	to	期望唤醒的时间点，仅当 `mode == Mtx::LockMode::MtxLockTimed` 时有效。

◆ ~Grd()

xwos::lock::Mtx::Grd::~Grd ( )

析构互斥锁的RAII机制守卫并解锁互斥锁

成员函数说明

◆ unlock()

void xwos::lock::Mtx::Grd::unlock ( )

解锁互斥锁

主动解锁后，析构函数将不再解锁。

◆ getRc()

xwer_t xwos::lock::Mtx::Grd::getRc ( )

inline

获取上锁结果错误码

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	无效的指针或空指针
-EOBJDEAD	互斥锁对象无效
-EINTR	等待被中断
-ETIMEDOUT	超时
-ENOTTHDCTX	不在线程上下文中
-EDSPMPT	抢占被关闭
-EDSBH	中断底半部被关闭

在文件 Mtx.hxx 第 190 行定义.

190{ return mRc; }

xwos::lock::Mtx::Grd::mRc

xwer_t mRc

Definition Mtx.hxx:110

◆ getLockMode()

enum LockMode xwos::lock::Mtx::Grd::getLockMode ( )

inline

获取上锁模式

在文件 Mtx.hxx 第 195 行定义.

195{ return mLockMode; }

xwos::lock::Mtx::Grd::mLockMode

enum LockMode mLockMode

Definition Mtx.hxx:111

◆ wait() [1/4]

xwer_t xwos::lock::Mtx::Grd::wait ( sync::Cond * cond )

等待条件量

参数

[in] cond 条件量对象的指针

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	无效的指针或空指针
-EINVAL	参数无效
-ENOTTHDCTX	不在线程上下文中
-ENOLCK	未上锁
-EINTR	等待被中断

注解

上下文：线程

调用此C++API的线程会阻塞等待条件量，等待的同时会解锁互斥锁。
如果构造 Mtx::Grd 时使用的模式是 Mtx::LockMode::MtxLockUninterruptable ，那么等待模式也是不可中断的。
条件量被单播 sync::Cond::unicast() 或广播 sync::Cond::broadcast() 时，会唤醒正在等待的线程。
线程被唤醒后，会重新上锁互斥锁，如果构造 Mtx::Grd 时使用的模式是 Mtx::LockMode::MtxLockUninterruptable ，那么重新上锁的模式也是 Mtx::LockMode::MtxLockUninterruptable 。
重新上锁成功后将返回 XWOK 。
线程的等待被中断后，此C++API返回 -EINTR 。
如果此C++API返回非 XWOK 的错误码，应该使用 Mtx::Grd::getLockMode() 确认是否上锁成功。

◆ wait() [2/4]

xwer_t xwos::lock::Mtx::Grd::wait ( sync::Cond & cond )

inline

这是为便于使用而提供的一个重载成员函数.与上面的函数相比，它接受不同类型的参数.

在文件 Mtx.hxx 第 227 行定义.

227{ return wait(&cond); }

xwos::lock::Mtx::Grd::wait

xwer_t wait(sync::Cond *cond)

等待条件量

函数调用图:

这是这个函数的调用关系图:

◆ wait() [3/4]

xwer_t xwos::lock::Mtx::Grd::wait	(	sync::Cond *	cond,
		xwtm_t	to
	)

限时等待条件量

参数

[in]	cond	条件量对象的指针
[in]	to	期望唤醒的时间点

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	无效的指针或空指针
-EINVAL	参数无效
-ENOTTHDCTX	不在线程上下文中
-ENOLCK	未上锁
-EINTR	等待被中断
-ETIMEDOUT	超时

注解

上下文：线程

调用此C++API的线程会限时阻塞等待条件量，等待的同时会解锁互斥锁。
如果构造 Mtx::Grd 时使用的模式是 Mtx::LockMode::MtxLockUninterruptable ，那么等待模式也是不可中断的，此时参数 to 无效，等待将不会超时。
条件量被单播 sync::Cond::unicast() 或广播 sync::Cond::broadcast() 时，会唤醒正在等待的线程。
线程被唤醒后，会重新上锁互斥锁，如果构造 Mtx::Grd 时使用的模式是 Mtx::LockMode::MtxLockUninterruptable ，那么重新上锁的模式也是 Mtx::LockMode::MtxLockUninterruptable 。
如果构造 Mtx::Grd 时使用的模式不是 Mtx::LockMode::MtxLockUninterruptable ，线程被唤醒时，若互斥锁被其他线程占用，线程也最多等待互斥锁到时间点 to 。
重新上锁成功后将返回 XWOK 。
线程的等待被中断后，此C++API返回 -EINTR 。
线程的等待超时后，此C++API返回 -ETIMEDOUT 。
如果此C++API返回非 XWOK 的错误码，应该使用 Mtx::Grd::getLockMode() 确认是否上锁成功。

◆ wait() [4/4]

xwer_t xwos::lock::Mtx::Grd::wait	(	sync::Cond &	cond,
		xwtm_t	to
	)

inline

这是为便于使用而提供的一个重载成员函数.与上面的函数相比，它接受不同类型的参数.

在文件 Mtx.hxx 第 266 行定义.

266{ return wait(&cond, to); }

函数调用图:

这是这个函数的调用关系图:

结构体成员变量说明

◆ mMtx

Mtx* xwos::lock::Mtx::Grd::mMtx

private

在文件 Mtx.hxx 第 109 行定义.

◆ mRc

xwer_t xwos::lock::Mtx::Grd::mRc

private

内部上锁CAPI的返回值

在文件 Mtx.hxx 第 110 行定义.

◆ mLockMode

enum LockMode xwos::lock::Mtx::Grd::mLockMode

private

在文件 Mtx.hxx 第 111 行定义.

该类的文档由以下文件生成:

xwos/cxx/lock/Mtx.hxx

Public 成员函数

Private 属性

详细描述

构造及析构函数说明

◆ Grd() [1/3]

◆ Grd() [2/3]

◆ Grd() [3/3]

◆ ~Grd()

成员函数说明

◆ unlock()

◆ getRc()

◆ getLockMode()

◆ wait() [1/4]

◆ wait() [2/4]

◆ wait() [3/4]

◆ wait() [4/4]

结构体成员变量说明

◆ mMtx

◆ mRc

◆ mLockMode