xwos::sync::Br< TNum > 模板类 参考

线程栅栏基类 更多...

#include <Br.hxx>

类 xwos::sync::Br< TNum > 继承关系图:

xwos::sync::Br< TNum > 的协作图:

Public 类型
enum	WaitMode : xwu32_t { BrWait = 0 , BrWaitTimed , BrWaitUninterruptable }
	等待模式枚举 更多...

Public 成员函数
xwsz_t	num ()
	获取事件的最大数量
xwer_t	wait (enum WaitMode mode, xwtm_t to)
	等待所有线程到达栅栏
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_br *	getXwosObj ()
	获取XWOS对象指针

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

Protected 属性
struct xwos_br *	mBrPtr

详细描述

template<xwsz_t TNum>
class xwos::sync::Br< TNum >

线程栅栏基类

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

成员枚举类型说明

WaitMode

template<xwsz_t TNum>

enum xwos::sync::Br::WaitMode : xwu32_t

等待模式枚举

枚举值
BrWait	等待模式
BrWaitTimed	定时等待模式
BrWaitUninterruptable	不可中断等待模式

在文件 Br.hxx 第 60 行定义.

                  : xwu32_t {
        BrWait = 0, 
        BrWaitTimed, 
        BrWaitUninterruptable, 
    };

构造及析构函数说明

Br()

template<xwsz_t TNum>

xwos::sync::Br< TNum >::Br ( )

inlineprotected

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

: mBrPtr(nullptr) {}

~Br()

template<xwsz_t TNum>

xwos::sync::Br< TNum >::~Br ( )

inlineprotected

在文件 Br.hxx 第 71 行定义.

{ mBrPtr = nullptr; }

成员函数说明

num()

template<xwsz_t TNum>

xwsz_t xwos::sync::Br< TNum >::num ( )

inline

获取事件的最大数量

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

{ return TNum; }

wait()

template<xwsz_t TNum>

xwer_t xwos::sync::Br< TNum >::wait ( enum WaitMode  mode, xwtm_t  to  )

inline

等待所有线程到达栅栏

参数

[in]	mode	等待模式，取值 Br::WaitMode Br::WaitMode::BrWait Br::WaitMode::BrWaitTimed Br::WaitMode::BrWaitUninterruptable
[in]	to	期望唤醒的时间点，仅当 mode == Br::WaitMode::BrWaitTimed 时有效。

返回

错误码

返回值

XWOK	没有错误
-EFAULT	无效的指针或空指针
-ECHRNG	线程数量超出范围
-ETIMEDOUT	超时
-EINTR	等待被中断
-ENOTTHDCTX：不在线程上下文中

注解

• 上下文：线程

• 等待分为下列几种模式：
  • Br::WaitMode::BrWait: 调用线程会阻塞等待。
  • Br::WaitMode::BrWaitTimed 定时等待模式， to 表示等待超时的时间点：
    • to 通常是未来时间点，即 当前系统时间 + delta ， 可以使用 xwtm_ft(delta) 表示；
    • 如果 to 是过去的时间点，将直接返回 -ETIMEDOUT 。
  • Br::WaitMode::BrWaitUninterruptable 不可中断等待模式。

在文件 Br.hxx 第 104 行定义.

    {
        xwer_t rc;
        switch (mode) {
            case WaitMode::BrWait:
                rc = xwos_br_wait(mBrPtr);
                break;
            case WaitMode::BrWaitTimed:
                rc = xwos_br_wait_to(mBrPtr, to);
                break;
            case WaitMode::BrWaitUninterruptable:
                rc = xwos_br_wait_unintr(mBrPtr);
                break;
            default:
                rc = xwos_br_wait(mBrPtr);
                break;
        }
        return rc;
    }

函数调用图:

bind() [1/2]

template<xwsz_t TNum>

template<xwsz_t TSelNum>

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

inline

绑定线程栅栏对象到信号选择器

参数

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

返回

错误码

返回值

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

注解

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

• 当所有线程到达线程栅栏时，线程栅栏将向信号选择器发送信号。

在文件 Br.hxx 第 141 行定义.

    {
        return xwos_br_bind(mBrPtr, sel->getXwosObj(), (xwsq_t)pos);
    }

函数调用图:

bind() [2/2]

template<xwsz_t TNum>

template<xwsz_t TSelNum>

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

inline

绑定线程栅栏对象到信号选择器

参数

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

返回

错误码

返回值

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

注解

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

• 当所有线程到达线程栅栏时，线程栅栏将向信号选择器发送信号。

在文件 Br.hxx 第 163 行定义.

    {
        return xwos_br_bind(mBrPtr, sel.getXwosObj(), (xwsq_t)pos);
    }

函数调用图:

unbind() [1/2]

template<xwsz_t TNum>

template<xwsz_t TSelNum>

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

inline

从信号选择器上解绑线程栅栏对象

参数

[in]

sel

信号选择器的引用

返回

错误码

返回值

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

注解

• 上下文：任意

在文件 Br.hxx 第 179 行定义.

    {
        return xwos_br_unbind(mBrPtr, sel->getXwosObj());
    }

函数调用图:

unbind() [2/2]

template<xwsz_t TNum>

template<xwsz_t TSelNum>

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

inline

从信号选择器上解绑线程栅栏对象

参数

[in]

sel

信号选择器的引用

返回

错误码

返回值

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

注解

• 上下文：任意

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

    {
        return xwos_br_unbind(mBrPtr, sel.getXwosObj());
    }

函数调用图:

getXwosObj()

template<xwsz_t TNum>

struct xwos_br * xwos::sync::Br< TNum >::getXwosObj ( )

inline

获取XWOS对象指针

在文件 Br.hxx 第 203 行定义.

{ return mBrPtr; }

结构体成员变量说明

mBrPtr

template<xwsz_t TNum>

struct xwos_br* xwos::sync::Br< TNum >::mBrPtr

protected

在文件 Br.hxx 第 67 行定义.

---

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

• xwos/cxx/sync/Br.hxx