#include <SThd.hxx>

xwos::SThd< TCpu > 的协作图:

[图例]

Public 成员函数
	SThd (const char name, xwstk_t stack, xwsz_t stack_size, xwsz_t stack_guard_size=XWOS_STACK_GUARD_SIZE_DEFAULT, xwpr_t priority=XWOS_SKD_PRIORITY_RT_MIN, bool detached=false, bool privileged=true)
	静态线程构造函数

virtual	~SThd ()
	静态线程析构函数

xwer_t	launch ()
	加载线程

xwer_t	getStackInfo (struct xwos_thd_stack_info *stack)
	获取当前线程的栈信息

xwer_t	intr ()
	中断线程的阻塞态和睡眠态

xwer_t	quit ()
	通知线程退出

xwer_t	join (xwer_t *trc)
	等待线程结束并获取它的返回值

xwer_t	stop (xwer_t *trc)
	通知线程退出，等待线程结束并获取它的返回值

xwer_t	detach ()
	终止线程并等待它退出

struct xwos_thd *	getXwosObj ()
	获取XWOS对象指针

xwer_t	grab ()

xwer_t	put ()

Protected 成员函数
virtual xwer_t	thdMainFunction ()
	线程主函数，用户需要重新实现此函数

void	yield ()
	当前线程通知调度器重新调度

void	exit (xwer_t rc)
	退出当前线程

bool	shouldFreeze ()
	判断当前线程是否可被冻结

bool	shouldStop ()
	判断当前线程是否可以退出

xwer_t	sleep (xwtm_t dur)
	当前线程睡眠一段时间

xwer_t	sleepTo (xwtm_t to)
	当前线程睡眠到一个时间点

xwer_t	sleepFrom (xwtm_t *from, xwtm_t dur)
	当前线程从一个时间起点睡眠到另一个时间点

xwer_t	freeze (void)
	冻结当前线程

静态 Private 成员函数
static xwer_t	sThdMainFunction (SThd *thd)

Private 属性
xwos_thd_d	mThdDesc

struct xwos_thd	mThd

详细描述

template<xwid_t TCpu = 0UL>
class xwos::SThd< TCpu >

静态线程

参数

[in] TCpu 目标CPU

在文件 SThd.hxx 第 39 行定义.

构造及析构函数说明

◆ SThd()

template<xwid_t TCpu = 0UL>

xwos::SThd< TCpu >::SThd	(	const char *	name,
		xwstk_t *	stack,
		xwsz_t	stack_size,
		xwsz_t	stack_guard_size = `XWOS_STACK_GUARD_SIZE_DEFAULT`,
		xwpr_t	priority = `XWOS_SKD_PRIORITY_RT_MIN`,
		bool	detached = `false`,
		bool	privileged = `true`
	)

inline

静态线程构造函数

参数

[in]	name	线程名
[in]	stack	线程栈内存
[in]	stack_size	线程栈的大小
[in]	stack_guard_size	栈内存警戒线位置
[in]	priority	优先级
[in]	detached	是否为分离态
[in]	privileged	是否为特权线程

在文件 SThd.hxx 第 56 行定义.

        : mThdDesc{ nullptr, 0 }
    {
        struct xwos_thd_attr attr({
            .name = name,
            .stack = stack,
            .stack_size = stack_size,
            .stack_guard_size = stack_guard_size,
            .priority = priority,
            .detached = detached,
            .privileged = privileged,
            });
        xwos_thd_init(&mThd, &mThdDesc, &attr, nullptr, nullptr);
    }

函数调用图:

◆ ~SThd()

template<xwid_t TCpu = 0UL>

virtual xwos::SThd< TCpu >::~SThd ( )

inlinevirtual

静态线程析构函数

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

76{ xwos_thd_detach(mThdDesc); }

xwos_thd_detach

static xwer_t xwos_thd_detach(xwos_thd_d thdd)

XWMP API：分离线程

Definition thd.h:622

函数调用图:

成员函数说明

◆ launch()

template<xwid_t TCpu = 0UL>

xwer_t xwos::SThd< TCpu >::launch ( )

inline

加载线程

返回: 错误码

返回值

XWOK	没有错误
-EHOSTUNREACH	CPU不匹配

注解

上下文：任意

线程会在调用此C++API的CPU上开始运行。

在文件 SThd.hxx 第 87 行定义.

    {
        xwer_t rc;
 
        if (TCpu == Cpu::getLocalCpuId()) {
            rc = xwos_thd_launch(mThdDesc, (xwos_thd_f)sThdMainFunction, this);
        } else {
            rc = -EHOSTUNREACH;
        }
        return rc;
    }

函数调用图:

◆ getStackInfo()

template<xwid_t TCpu = 0UL>

xwer_t xwos::SThd< TCpu >::getStackInfo ( struct xwos_thd_stack_info * stack )

inline

获取当前线程的栈信息

参数

[out] stack 用于返回线程栈信息的缓冲区

在文件 SThd.hxx 第 102 行定义.

    {
        return xwos_thd_get_stack_info(mThdDesc, stack);
    }

函数调用图:

◆ intr()

template<xwid_t TCpu = 0UL>

xwer_t xwos::SThd< TCpu >::intr ( )

inline

中断线程的阻塞态和睡眠态

在文件 SThd.hxx 第 109 行定义.

109{ return xwos_thd_intr(mThdDesc); }

xwos_thd_intr

static xwer_t xwos_thd_intr(xwos_thd_d thdd)

XWOS API：中断线程的阻塞态和睡眠态

Definition thd.h:511

函数调用图:

◆ quit()

template<xwid_t TCpu = 0UL>

xwer_t xwos::SThd< TCpu >::quit ( )

inline

通知线程退出

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

113{ return xwos_thd_quit(mThdDesc); }

xwos_thd_quit

static xwer_t xwos_thd_quit(xwos_thd_d thdd)

XWOS API：通知线程退出

Definition thd.h:542

函数调用图:

◆ join()

template<xwid_t TCpu = 0UL>

xwer_t xwos::SThd< TCpu >::join ( xwer_t * trc )

inline

等待线程结束并获取它的返回值

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

    {
        return xwos_thd_join(mThdDesc, trc);
    }

函数调用图:

◆ stop()

template<xwid_t TCpu = 0UL>

xwer_t xwos::SThd< TCpu >::stop ( xwer_t * trc )

inline

通知线程退出，等待线程结束并获取它的返回值

在文件 SThd.hxx 第 124 行定义.

    {
        return xwos_thd_stop(mThdDesc, trc);
    }

函数调用图:

◆ detach()

template<xwid_t TCpu = 0UL>

xwer_t xwos::SThd< TCpu >::detach ( )

inline

终止线程并等待它退出

在文件 SThd.hxx 第 131 行定义.

131{ return xwos_thd_detach(mThdDesc); }

函数调用图:

◆ getXwosObj()

template<xwid_t TCpu = 0UL>

struct xwos_thd * xwos::SThd< TCpu >::getXwosObj ( )

inline

获取XWOS对象指针

在文件 SThd.hxx 第 135 行定义.

135{ return mThdDesc.thd; }

xwos_thd_d::thd

struct xwos_thd * thd

Definition thd.h:159

◆ grab()

template<xwid_t TCpu = 0UL>

xwer_t xwos::SThd< TCpu >::grab ( )

inline

增加引用计数

在文件 SThd.hxx 第 138 行定义.

函数调用图:

◆ put()

template<xwid_t TCpu = 0UL>

xwer_t xwos::SThd< TCpu >::put ( )

inline

减少引用计数

在文件 SThd.hxx 第 139 行定义.

函数调用图:

◆ thdMainFunction()

template<xwid_t TCpu = 0UL>

virtual xwer_t xwos::SThd< TCpu >::thdMainFunction ( )

inlineprotectedvirtual

线程主函数，用户需要重新实现此函数

在文件 SThd.hxx 第 146 行定义.

146{ return XWOK; }

XWOK

#define XWOK

No error

Definition errno.h:182

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

◆ yield()

template<xwid_t TCpu = 0UL>

void xwos::SThd< TCpu >::yield ( )

inlineprotected

当前线程通知调度器重新调度

在文件 SThd.hxx 第 152 行定义.

    {
        xwos_cthd_yield();
    }

函数调用图:

◆ exit()

template<xwid_t TCpu = 0UL>

void xwos::SThd< TCpu >::exit ( xwer_t rc )

inlineprotected

退出当前线程

参数

[in] rc 线程退出时抛出的返回值

在文件 SThd.hxx 第 160 行定义.

    {
        xwos_cthd_exit(rc);
    }

函数调用图:

◆ shouldFreeze()

template<xwid_t TCpu = 0UL>

bool xwos::SThd< TCpu >::shouldFreeze ( )

inlineprotected

判断当前线程是否可被冻结

在文件 SThd.hxx 第 167 行定义.

    {
        return xwos_cthd_shld_frz();
    }

函数调用图:

◆ shouldStop()

template<xwid_t TCpu = 0UL>

bool xwos::SThd< TCpu >::shouldStop ( )

inlineprotected

判断当前线程是否可以退出

在文件 SThd.hxx 第 174 行定义.

    {
        return xwos_cthd_shld_stop();
    }

函数调用图:

◆ sleep()

template<xwid_t TCpu = 0UL>

xwer_t xwos::SThd< TCpu >::sleep ( xwtm_t dur )

inlineprotected

当前线程睡眠一段时间

参数

[in] dur 期望睡眠的时间

在文件 SThd.hxx 第 182 行定义.

    {
        return xwos_cthd_sleep(dur);
    }

函数调用图:

◆ sleepTo()

template<xwid_t TCpu = 0UL>

xwer_t xwos::SThd< TCpu >::sleepTo ( xwtm_t to )

inlineprotected

当前线程睡眠到一个时间点

参数

[in] to 期望唤醒的时间点

在文件 SThd.hxx 第 190 行定义.

    {
        return xwos_cthd_sleep_to(to);
    }

函数调用图:

◆ sleepFrom()

template<xwid_t TCpu = 0UL>

xwer_t xwos::SThd< TCpu >::sleepFrom	(	xwtm_t *	from,
		xwtm_t	dur
	)

inlineprotected

当前线程从一个时间起点睡眠到另一个时间点

参数

[in,out]	from	指向缓冲区的指针，此缓冲区： (I) 输入时，作为时间起点 (O) 输出时，返回线程被唤醒的时间（可作为下一次时间起点）
[in]	dur	期望被唤醒的时间增量（相对于时间原点）

在文件 SThd.hxx 第 201 行定义.

    {
        return xwos_cthd_sleep_from(from, dur);
    }

函数调用图:

◆ freeze()

template<xwid_t TCpu = 0UL>

xwer_t xwos::SThd< TCpu >::freeze ( void )

inlineprotected

冻结当前线程

在文件 SThd.hxx 第 208 行定义.

    {
        return xwos_cthd_freeze();
    }

函数调用图:

◆ sThdMainFunction()

template<xwid_t TCpu = 0UL>

static xwer_t xwos::SThd< TCpu >::sThdMainFunction ( SThd< TCpu > * thd )

inlinestaticprivate

在文件 SThd.hxx 第 214 行定义.

214{ return thd->thdMainFunction(); }

函数调用图:

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

结构体成员变量说明

◆ mThdDesc

template<xwid_t TCpu = 0UL>

xwos_thd_d xwos::SThd< TCpu >::mThdDesc

private

线程描述符

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

◆ mThd

template<xwid_t TCpu = 0UL>

struct xwos_thd xwos::SThd< TCpu >::mThd

private

线程结构体

在文件 SThd.hxx 第 43 行定义.

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

xwos/cxx/SThd.hxx

Public 成员函数

Protected 成员函数

静态 Private 成员函数

Private 属性

详细描述

构造及析构函数说明

◆ SThd()

◆ ~SThd()

成员函数说明

◆ launch()

◆ getStackInfo()

◆ intr()

◆ quit()

◆ join()

◆ stop()

◆ detach()

◆ getXwosObj()

◆ grab()

◆ put()

◆ thdMainFunction()

◆ yield()

◆ exit()

◆ shouldFreeze()

◆ shouldStop()

◆ sleep()

◆ sleepTo()

◆ sleepFrom()

◆ freeze()

◆ sThdMainFunction()

结构体成员变量说明

◆ mThdDesc

◆ mThd