xwos::sync::SCond类 参考

静态条件量 更多...

#include <SCond.hxx>

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

xwos::sync::SCond 的协作图:

Public 成员函数
	SCond ()
	构造函数
	~SCond ()
xwer_t	getCtorRc ()
xwer_t	unicast ()
	单播条件量
xwer_t	broadcast ()
	广播条件量
xwer_t	freeze ()
	冻结条件量
xwer_t	thaw ()
	解冻条件量
xwer_t	grab ()
xwer_t	put ()
Public 成员函数 继承自 xwos::sync::Cond
struct xwos_cond *	getXwosObj ()

Private 成员函数
void	operator delete (void *obj)=delete

静态 Private 成员函数
static void *	operator new (xwsz_t sz)=delete

Private 属性
struct xwos_cond	mCond
xwer_t	mCtorRc

额外继承的成员函数
Protected 成员函数 继承自 xwos::sync::Cond
	Cond (xwos_cond *cond)
	~Cond ()
xwer_t	unicast ()
xwer_t	broadcast ()
xwer_t	freeze ()
xwer_t	thaw ()
Protected 属性 继承自 xwos::sync::Cond
struct xwos_cond *	mCondPtr

详细描述

静态条件量

在文件 SCond.hxx 第 37 行定义.

构造及析构函数说明

SCond()

xwos::sync::SCond::SCond ( )

inline

构造函数

在文件 SCond.hxx 第 48 行定义.

            : Cond(nullptr) {
        mCtorRc = xwos_cond_init(&mCond);
        if (XWOK == mCtorRc) {
            Cond::mCondPtr = &mCond;
        }
    }

函数调用图:

~SCond()

xwos::sync::SCond::~SCond ( )

inline

析构函数

在文件 SCond.hxx 第 54 行定义.

函数调用图:

成员函数说明

broadcast()

xwer_t xwos::sync::SCond::broadcast ( )

inline

广播条件量

返回

错误码

返回值

XWOK	没有错误
-EFAULT	无效的指针或空指针
-ENEGATIVE	条件量对象已被冻结

注解

• 上下文：任意

• 广播条件量会唤醒所有等待的线程。
• 此C++API只对未冻结的条件量对象起作用，已冻结的条件量对象将返回 错误码 -ENEGATIVE 。

在文件 SCond.hxx 第 85 行定义.

{ return Cond::broadcast(); }

函数调用图:

freeze()

xwer_t xwos::sync::SCond::freeze ( )

inline

冻结条件量

返回

错误码

返回值

XWOK	没有错误
-EFAULT	无效的指针或空指针
-EALREADY	条件量对象已被冻结

注解

• 上下文：任意

• 已冻结的条件量不允许单播或广播，但可以被线程等待。
• 对已经冻结的条件量再次冻结，将返回 -EALREADY 。

在文件 SCond.hxx 第 99 行定义.

{ return Cond::freeze(); }

函数调用图:

getCtorRc()

xwer_t xwos::sync::SCond::getCtorRc ( )

inline

获取静态条件量构造的结果

在文件 SCond.hxx 第 55 行定义.

grab()

xwer_t xwos::sync::SCond::grab ( )

inline

增加引用计数

在文件 SCond.hxx 第 116 行定义.

函数调用图:

operator delete()

void xwos::sync::SCond::operator delete ( void *  obj )

privatedelete

operator new()

static void * xwos::sync::SCond::operator new ( xwsz_t  sz )

staticprivatedelete

put()

xwer_t xwos::sync::SCond::put ( )

inline

减少引用计数

在文件 SCond.hxx 第 117 行定义.

函数调用图:

thaw()

xwer_t xwos::sync::SCond::thaw ( )

inline

解冻条件量

返回

错误码

返回值

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

注解

• 上下文：任意

• 此函数只对已冻结的条件量对象起作用， 对未冻结的条件量对象调用此函数将返回错误码 -EALREADY 。

在文件 SCond.hxx 第 113 行定义.

{ return Cond::thaw(); }

函数调用图:

unicast()

xwer_t xwos::sync::SCond::unicast ( )

inline

单播条件量

返回

错误码

返回值

XWOK	没有错误
-EFAULT	无效的指针或空指针
-ENEGATIVE	条件量对象已被冻结

注解

• 上下文：任意

• 单播条件量会唤醒第一个等待的线程。
• 此C++API只对未冻结的条件量对象起作用，已冻结的条件量对象将返回 错误码 -ENEGATIVE 。

在文件 SCond.hxx 第 70 行定义.

{ return Cond::unicast(); }

函数调用图:

结构体成员变量说明

mCond

struct xwos_cond xwos::sync::SCond::mCond

private

条件量结构体

在文件 SCond.hxx 第 41 行定义.

mCtorRc

xwer_t xwos::sync::SCond::mCtorRc

private

条件量构造的结果

在文件 SCond.hxx 第 42 行定义.

---

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

• xwos/cxx/sync/SCond.hxx