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

信号选择器基类 更多...

#include <Sel.hxx>

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

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

Public 类型
enum	WaitMode : xwu32_t { SelWait = 0 , SelWaitTimed , SelWaitUninterruptable , SelTryWait }
	等待模式枚举 更多...

Public 成员函数
xwsz_t	num ()
	获取信号选择器中的信号槽的数量
xwer_t	select (xwos::Bmp< TNum > *msk, xwos::Bmp< TNum > *trigger, enum WaitMode mode, xwtm_t to)
	等待信号选择器
template<xwsz_t TSelNum>
xwer_t	bind (Sel< TSelNum > *src, long pos)
	绑定源信号选择器到本信号选择器
template<xwsz_t TSelNum>
xwer_t	bind (Sel< TSelNum > &src, long pos)
template<xwsz_t TSelNum>
xwer_t	unbind (Sel< TSelNum > *src)
	从目的信号选择器上解绑源信号选择器
template<xwsz_t TSelNum>
xwer_t	unbind (Sel< TSelNum > &src)
struct xwos_sel *	getXwosObj ()
	获取XWOS对象指针

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

Protected 属性
struct xwos_sel *	mSelPtr

详细描述

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

信号选择器基类

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

成员枚举类型说明

WaitMode

template<xwsz_t TNum>

enum xwos::sync::Sel::WaitMode : xwu32_t

等待模式枚举

枚举值
SelWait	等待模式
SelWaitTimed	定时等待模式
SelWaitUninterruptable	不可中断等待模式
SelTryWait	尝试模式（只测试不等待）

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

                  : xwu32_t {
        SelWait = 0, 
        SelWaitTimed, 
        SelWaitUninterruptable, 
        SelTryWait, 
    };

构造及析构函数说明

Sel()

template<xwsz_t TNum>

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

inlineprotected

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

        : mSelPtr(nullptr)
    {
    }

~Sel()

template<xwsz_t TNum>

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

inlineprotected

在文件 Sel.hxx 第 75 行定义.

{ mSelPtr = nullptr; }

成员函数说明

num()

template<xwsz_t TNum>

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

inline

获取信号选择器中的信号槽的数量

在文件 Sel.hxx 第 81 行定义.

{ return TNum; }

select()

template<xwsz_t TNum>

xwer_t xwos::sync::Sel< TNum >::select ( xwos::Bmp< TNum > *  msk, xwos::Bmp< TNum > *  trigger, enum WaitMode  mode, xwtm_t  to  )

inline

等待信号选择器

参数

[in]	msk	同步对象位图掩码，表示只关注掩码内的同步对象
[out]	trigger	指向缓冲区的指针，通过此缓冲区返回已触发的同步对象位图掩码
[in]	mode	等待模式，取值 Sel::WaitMode Sel::WaitMode::SelWait Sel::WaitMode::SelWaitTimed Sel::WaitMode::SelWaitUninterruptable Sel::WaitMode::SelTryWait
[in]	to	期望唤醒的时间点，仅当 mode == Sel::WaitMode::SelWaitTimed 时有效。

返回

错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-ETIMEDOUT	超时
-ENODATA	没有任何同步对象向信号选择器发送 选择信号
-EINTR	等待被中断
-ENOTTHDCTX	不在线程上下文中

注解

• 上下文：
  • mode == Sel::WaitMode::SelTryWait : 任意
  • mode != Sel::WaitMode::SelTryWait : 线程

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

在文件 Sel.hxx 第 114 行定义.

    {
        xwer_t rc;
        switch (mode) {
            case WaitMode::SelWait:
                rc = xwos_sel_select(mSelPtr, msk->mData, trigger->mData);
                break;
            case WaitMode::SelWaitTimed:
                rc = xwos_sel_select_to(mSelPtr, msk->mData, trigger->mData, to);
                break;
            case WaitMode::SelWaitUninterruptable:
                rc = xwos_sel_select_unintr(mSelPtr, msk->mData, trigger->mData);
                break;
            case WaitMode::SelTryWait:
                rc = xwos_sel_tryselect(mSelPtr, msk->mData, trigger->mData);
                break;
            default:
                rc = xwos_sel_select(mSelPtr, msk->mData, trigger->mData);
                break;
        }
        return rc;
    }

函数调用图:

bind() [1/2]

template<xwsz_t TNum>

template<xwsz_t TSelNum>

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

inline

绑定源信号选择器到本信号选择器

参数

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

返回

错误码

返回值

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

注解

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

• 多个信号选择器可以依次绑定，形成信号传递链。 但不可循环绑定，否则会造成无限循环传递。

在文件 Sel.hxx 第 156 行定义.

    {
        return xwos_sel_bind(src->getXwosObj(), mSelPtr, (xwsq_t)pos);
    }

函数调用图:

bind() [2/2]

template<xwsz_t TNum>

template<xwsz_t TSelNum>

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

inline

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

在文件 Sel.hxx 第 164 行定义.

    {
        return xwos_sel_bind(src.getXwosObj(), mSelPtr, (xwsq_t)pos);
    }

函数调用图:

unbind() [1/2]

template<xwsz_t TNum>

template<xwsz_t TSelNum>

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

inline

从目的信号选择器上解绑源信号选择器

参数

[in]

src

源信号选择器对象的指针

返回

错误码

返回值

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

注解

• 上下文：任意

在文件 Sel.hxx 第 180 行定义.

    {
        return xwos_sel_unbind(src->getXwosObj(), mSelPtr);
    }

函数调用图:

unbind() [2/2]

template<xwsz_t TNum>

template<xwsz_t TSelNum>

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

inline

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

在文件 Sel.hxx 第 188 行定义.

    {
        return xwos_sel_unbind(src.getXwosObj(), mSelPtr);
    }

函数调用图:

getXwosObj()

template<xwsz_t TNum>

struct xwos_sel * xwos::sync::Sel< TNum >::getXwosObj ( )

inline

获取XWOS对象指针

在文件 Sel.hxx 第 196 行定义.

{ return mSelPtr; }

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

结构体成员变量说明

mSelPtr

template<xwsz_t TNum>

struct xwos_sel* xwos::sync::Sel< TNum >::mSelPtr

protected

在文件 Sel.hxx 第 68 行定义.

---

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

• xwos/cxx/sync/Sel.hxx