xwos::lock::Seqlock::WrLkBhGrd类 参考

独占写中断底半部上锁模式下的顺序锁RAII机制守卫 更多...

#include <Seqlock.hxx>

类 xwos::lock::Seqlock::WrLkBhGrd 继承关系图:

xwos::lock::Seqlock::WrLkBhGrd 的协作图:

Public 成员函数
	WrLkBhGrd (Seqlock *seqlock)
	构造顺序锁的RAII机制守卫
	WrLkBhGrd (Seqlock &seqlock)
	构造顺序锁的RAII机制守卫
	~WrLkBhGrd ()
	析构顺序锁的RAII机制守卫
void	unlock ()
	解锁顺序锁
enum LockStatus	getStatus ()
	获取锁状态
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)
	限时等待条件量

Protected 成员函数
	WrLkBhGrd ()

Protected 属性
Seqlock *	mSeqlock
enum LockStatus	mStatus

详细描述

独占写中断底半部上锁模式下的顺序锁RAII机制守卫

• 构造函数关闭当前CPU调度器的抢占，关闭本地CPU的中断底半部，然后上锁顺序锁。 上锁失败会自旋等待，直到上锁成功为止。
• 析构函数解锁顺序锁，开启本地CPU的中断底半部，开启当前CPU调度器的抢占。

  注解

• 上下文：线程、中断底半部

在文件 Seqlock.hxx 第 1638 行定义.

构造及析构函数说明

WrLkBhGrd() [1/3]

xwos::lock::Seqlock::WrLkBhGrd::WrLkBhGrd

(

Seqlock *

seqlock

)

构造顺序锁的RAII机制守卫

参数

[in]

seqlock

顺序锁对象指针

WrLkBhGrd() [2/3]

xwos::lock::Seqlock::WrLkBhGrd::WrLkBhGrd

(

Seqlock &

seqlock

)

构造顺序锁的RAII机制守卫

参数

[in]

seqlock

顺序锁对象引用

~WrLkBhGrd()

xwos::lock::Seqlock::WrLkBhGrd::~WrLkBhGrd

(

)

析构顺序锁的RAII机制守卫

WrLkBhGrd() [3/3]

xwos::lock::Seqlock::WrLkBhGrd::WrLkBhGrd ( )

inlineprotected

在文件 Seqlock.hxx 第 1749 行定义.

            : mSeqlock(nullptr)
            , mStatus(SeqlockUnlocked)
        {
        }

成员函数说明

unlock()

void xwos::lock::Seqlock::WrLkBhGrd::unlock

(

)

解锁顺序锁

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

getStatus()

enum LockStatus xwos::lock::Seqlock::WrLkBhGrd::getStatus ( )

inline

获取锁状态

在文件 Seqlock.hxx 第 1672 行定义.

{ return mStatus; }

wait() [1/4]

xwer_t xwos::lock::Seqlock::WrLkBhGrd::wait

(

sync::Cond *

cond

)

等待条件量

参数

[in]

cond

条件量对象的指针

返回

错误码

返回值

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

注解

• 上下文：线程

• 调用此C++API的线程会阻塞等待条件量，等待的同时会解锁顺序锁。
• 条件量被单播 sync::Cond::unicast() 或广播 sync::Cond::broadcast() 时，会唤醒正在等待的线程。
• 线程被唤醒后，会重新用之前的上锁方式上锁顺序锁。
• 重新上锁成功后将返回 XWOK 。
• 线程的等待被中断后，此C++API返回 -EINTR 。
• 如果此C++API返回 非 XWOK 的错误码后，应该 使用 getStatus() 确认是否上锁成功。

wait() [2/4]

xwer_t xwos::lock::Seqlock::WrLkBhGrd::wait ( sync::Cond &  cond )

inline

等待条件量

参数

[in]

cond

条件量对象的引用

返回

错误码

注解

• 上下文：线程

• 同 wait(sync::Cond * cond) 。

在文件 Seqlock.hxx 第 1707 行定义.

{ return wait(&cond); }

函数调用图:

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

wait() [3/4]

xwer_t xwos::lock::Seqlock::WrLkBhGrd::wait	(	sync::Cond *	cond,
		xwtm_t	to
	)

限时等待条件量

参数

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

返回

错误码

返回值

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

注解

• 上下文：线程

• 调用此C++API的线程会限时阻塞等待条件量，等待的同时会解锁顺序锁。
• 条件量被单播 sync::Cond::unicast() 或广播 sync::Cond::broadcast() 时，会唤醒正在等待的线程。
• 线程被唤醒后，会重新用之前的上锁方式上锁顺序锁 。
• 重新上锁成功后将返回 XWOK 。
• 线程的等待被中断后，此C++API返回 -EINTR 。
• 线程的等待超时后，此C++API返回 -ETIMEDOUT 。
• 如果此C++API返回 非 XWOK 的错误码，应该 使用 getStatus() 确认是否上锁成功。

wait() [4/4]

xwer_t xwos::lock::Seqlock::WrLkBhGrd::wait ( sync::Cond &  cond, xwtm_t  to  )

inline

限时等待条件量

参数

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

返回

错误码

注解

• 上下文：线程

• 同 wait(sync::Cond * cond, xwtm_t to) 。

在文件 Seqlock.hxx 第 1746 行定义.

{ return wait(&cond, to); }

函数调用图:

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

结构体成员变量说明

mSeqlock

Seqlock* xwos::lock::Seqlock::WrLkBhGrd::mSeqlock

protected

在文件 Seqlock.hxx 第 1641 行定义.

mStatus

enum LockStatus xwos::lock::Seqlock::WrLkBhGrd::mStatus

protected

在文件 Seqlock.hxx 第 1642 行定义.

---

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

• xwos/cxx/lock/Seqlock.hxx