xwos::sync::Sem类 参考

信号量基类 更多...

#include <Sem.hxx>

类 xwos::sync::Sem 继承关系图:

xwos::sync::Sem 的协作图:

Public 类型
enum	WaitMode : xwu32_t { SemWait = 0 , SemWaitTimed , SemWaitUninterruptable , SemTryWait }
	静态信号量的等待模式 更多...

Public 成员函数
xwer_t	post ()
	发布信号量
xwer_t	wait (enum WaitMode mode=WaitMode::SemWait, xwtm_t to=((xwtm_t)((~(xwu64_t) 0) > > 1)))
	等待并获取信号量
xwer_t	freeze ()
	冻结信号量
xwer_t	thaw ()
	解冻信号量
xwssq_t	max ()
	获取信号量计数器的最大值
xwssq_t	value ()
	获取信号量计数器的值
template<xwsz_t TSelNum>
xwer_t	bind (Sel< TSelNum > *sel, long pos)
	绑定信号量对象到信号选择器
template<xwsz_t TSelNum>
xwer_t	bind (Sel< TSelNum > &sel, long pos)
	绑定信号量对象到信号选择器
template<xwsz_t TSelNum>
xwer_t	unbind (Sel< TSelNum > *sel)
	从信号选择器上解绑信号量对象
template<xwsz_t TSelNum>
xwer_t	unbind (Sel< TSelNum > &sel)
	从信号选择器上解绑信号量对象
struct xwos_sem *	getXwosObj ()
	获取XWOS对象指针

Protected 成员函数
	Sem ()
	~Sem ()

Protected 属性
struct xwos_sem *	mSemPtr

详细描述

信号量基类

在文件 Sem.hxx 第 59 行定义.

成员枚举类型说明

WaitMode

enum xwos::sync::Sem::WaitMode : xwu32_t

静态信号量的等待模式

枚举值
SemWait	等待模式
SemWaitTimed	定时等待模式
SemWaitUninterruptable	不可中断等待模式
SemTryWait	尝试模式（只测试不等待）

在文件 Sem.hxx 第 65 行定义.

                  : xwu32_t {
        SemWait = 0, 
        SemWaitTimed, 
        SemWaitUninterruptable, 
        SemTryWait, 
    };

构造及析构函数说明

Sem()

xwos::sync::Sem::Sem ( )

inlineprotected

在文件 Sem.hxx 第 76 行定义.

: mSemPtr(nullptr) {}

~Sem()

xwos::sync::Sem::~Sem ( )

inlineprotected

在文件 Sem.hxx 第 77 行定义.

{ mSemPtr = nullptr; }

成员函数说明

post()

xwer_t xwos::sync::Sem::post ( )

inline

发布信号量

返回

错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-ENEGATIVE	信号量对象已被冻结
-ERANGE	信号量对象的值已经最大

注解

• 上下文：任意

• 此C++API只对未冻结的信号量对象起作用，对已冻结的信号量对象调用此C++API将 返回错误码 -ENEGATIVE 。

在文件 Sem.hxx 第 93 行定义.

{ return xwos_sem_post(mSemPtr); }

函数调用图:

wait()

xwer_t xwos::sync::Sem::wait ( enum WaitMode  mode = WaitMode::SemWait, xwtm_t  to = ((xwtm_t)((~(xwu64_t)0) >> 1))  )

inline

等待并获取信号量

参数

[in]	mode	锁模式，取值 Sem::WaitMode Sem::WaitMode::SemWait Sem::WaitMode::SemWaitTimed Sem::WaitMode::SemWaitUninterruptable Sem::WaitMode::SemTryWait
[in]	to	期望唤醒的时间点， 仅当 mode == Sem::WaitMode::SemWaitTimed 时有效。

返回

错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-ETIMEDOUT	超时
-EINTR	等待被中断
-ENOTTHDCTX	不在线程上下文中
-EDSPMPT	抢占被关闭
-EDSBH	中断底半部被关闭

注解

• 上下文：
  • mode == Sem::WaitMode::SemTryWait : 任意
  • mode != Sem::WaitMode::SemTryWait : 线程

• 等待分为下列几种模式：
  • Sem::WaitMode::SemWait: 调用线程会阻塞等待上锁。
  • Sem::WaitMode::SemWaitTimed 定时等待模式， to 表示等待超时的时间点：
    • to 通常是未来时间点，即 当前系统时间 + delta ， 可以使用 xwtm_ft(delta) 表示；
    • 如果 to 是过去的时间点，将直接返回 -ETIMEDOUT 。
  • Sem::WaitMode::SemWaitUninterruptable 不可中断等待模式。
  • Sem::WaitMode::SemTryWait 尝试模式（只测试不等待）。

在文件 Sem.hxx 第 126 行定义.

    {
        xwer_t rc;
        switch (mode) {
            case WaitMode::SemWait:
                rc = xwos_sem_wait(mSemPtr);
                break;
            case WaitMode::SemWaitTimed:
                rc = xwos_sem_wait_to(mSemPtr, to);
                break;
            case WaitMode::SemWaitUninterruptable:
                rc = xwos_sem_wait_unintr(mSemPtr);
                break;
            case WaitMode::SemTryWait:
                rc = xwos_sem_trywait(mSemPtr);
                break;
            default:
                rc = xwos_sem_wait(mSemPtr);
                break;
        }
        return rc;
    }

函数调用图:

freeze()

xwer_t xwos::sync::Sem::freeze ( )

inline

冻结信号量

返回

错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-EALREADY	信号量对象已被冻结

注解

• 上下文：任意

• 被冻结的信号量对象不允许增加(V操作)，但可以被测试(P操作)。 测试信号量对象的线程会被加入到信号量对象的等待队列。
• 对已经冻结的信号量再次冻结，将返回 -EALREADY 。

在文件 Sem.hxx 第 162 行定义.

{ return xwos_sem_freeze(mSemPtr); }

函数调用图:

thaw()

xwer_t xwos::sync::Sem::thaw ( )

inline

解冻信号量

返回

错误码

返回值

XWOK	没有错误
-EFAULT	无效的指针或空指针
-EALREADY	信号量对象未被冻结

注解

• 上下文：任意

• 此C++API只对已冻结的信号量对象起作用， 对未冻结的信号量对象调用此函数将返回错误码 -EALREADY 。

在文件 Sem.hxx 第 176 行定义.

{ return xwos_sem_thaw(mSemPtr); }

函数调用图:

max()

xwssq_t xwos::sync::Sem::max ( )

inline

获取信号量计数器的最大值

返回

最大值

注解

• 上下文：任意

在文件 Sem.hxx 第 184 行定义.

    {
        xwssq_t max;
        xwos_sem_get_max(mSemPtr, &max);
        return max;
    }

函数调用图:

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

value()

xwssq_t xwos::sync::Sem::value ( )

inline

获取信号量计数器的值

返回

最大值

注解

• 上下文：任意

在文件 Sem.hxx 第 197 行定义.

    {
        xwssq_t value;
        xwos_sem_get_value(mSemPtr, &value);
        return value;
    }

函数调用图:

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

bind() [1/2]

template<xwsz_t TSelNum>

xwer_t xwos::sync::Sem::bind ( Sel< TSelNum > *  sel, long  pos  )

inline

绑定信号量对象到信号选择器

参数

[in]	sel	信号选择器的指针
[in]	pos	信号量对象映射到信号选择器位图中的位置

返回

错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-ECHRNG	位置超出范围
-EALREADY	同步对象已经绑定到事件对象
-EBUSY	通道已经被其他同步对象独占

注解

• 上下文：任意
• 绑定方式：独占绑定

在文件 Sem.hxx 第 219 行定义.

    {
        return xwos_sem_bind(mSemPtr, sel->getXwosObj(), (xwsq_t)pos);
    }

函数调用图:

bind() [2/2]

template<xwsz_t TSelNum>

xwer_t xwos::sync::Sem::bind ( Sel< TSelNum > &  sel, long  pos  )

inline

绑定信号量对象到信号选择器

参数

[in]	sel	信号选择器的引用
[in]	pos	信号量对象映射到信号选择器位图中的位置

返回

错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-ECHRNG	位置超出范围
-EALREADY	同步对象已经绑定到事件对象
-EBUSY	通道已经被其他同步对象独占

注解

• 上下文：任意
• 绑定方式：独占绑定

在文件 Sem.hxx 第 239 行定义.

    {
        return xwos_sem_bind(mSemPtr, sel.getXwosObj(), (xwsq_t)pos);
    }

函数调用图:

unbind() [1/2]

template<xwsz_t TSelNum>

xwer_t xwos::sync::Sem::unbind ( Sel< TSelNum > *  sel )

inline

从信号选择器上解绑信号量对象

参数

[in]

sel

信号选择器的引用

返回

错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-ENOTCONN	同步对象没有绑定到事件对象上

注解

• 上下文：任意

在文件 Sem.hxx 第 255 行定义.

    {
        return xwos_sem_unbind(mSemPtr, sel->getXwosObj());
    }

函数调用图:

unbind() [2/2]

template<xwsz_t TSelNum>

xwer_t xwos::sync::Sem::unbind ( Sel< TSelNum > &  sel )

inline

从信号选择器上解绑信号量对象

参数

[in]

sel

信号选择器的引用

返回

错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-ENOTCONN	同步对象没有绑定到事件对象上

注解

• 上下文：任意

在文件 Sem.hxx 第 271 行定义.

    {
        return xwos_sem_unbind(mSemPtr, sel.getXwosObj());
    }

函数调用图:

getXwosObj()

struct xwos_sem * xwos::sync::Sem::getXwosObj ( )

inline

获取XWOS对象指针

在文件 Sem.hxx 第 279 行定义.

{ return mSemPtr; }

结构体成员变量说明

mSemPtr

struct xwos_sem* xwos::sync::Sem::mSemPtr

protected

在文件 Sem.hxx 第 73 行定义.

---

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

• xwos/cxx/sync/Sem.hxx