#include "xf_task_base.h"
#include "xf_task.h"
#include "xf_task_manager.h"

xf_task_base.c 的引用(Include)关系图:

宏定义
#define	TAG "task_base"

函数
xf_err_t	xf_task_vfunc_register (xf_task_type_t type, const xf_task_vfunc_t *vfunc)
	task 的虚函数注册。

xf_err_t	xf_task_vfunc_unregister (xf_task_type_t type)
	task 注销虚函数注册（一般用不到的函数）。

const xf_task_vfunc_t *	xf_task_get_vfunc (xf_task_type_t type)
	task 获取虚函数。

void	xf_task_base_init (xf_task_base_t task_base, xf_task_manager_t manager, xf_task_type_t type, uint16_t priority, xf_task_func_t func, void arg)
	task 初始化。

void	xf_task_base_reset (xf_task_base_t *task_base)
	重置 task base 部分内容

xf_err_t	xf_task_base_set_state (xf_task_t task, xf_task_state_t state)
	task 设置状态。

void	xf_task_destructor (xf_task_t task)
	任务销毁。回收任务资源

变量
static const xf_task_vfunc_t *	_xf_task_vfunc_group [_XF_TASK_TYPE_MAX] = {0}

详细描述

作者: cangyu (sky.k.nosp@m.irto.nosp@m.@qq.c.nosp@m.om)

版本: 0.1

日期: 2024-07-05

版权所有: Copyright (c) 2024, CorAL. All rights reserved.

在文件 xf_task_base.c 中定义.

宏定义说明

◆ TAG

#define TAG "task_base"

在文件 xf_task_base.c 第 20 行定义.

函数说明

◆ xf_task_vfunc_register()

xf_err_t xf_task_vfunc_register	(	xf_task_type_t	type,
		const xf_task_vfunc_t *	vfunc
	)

task 的虚函数注册。

参数

type	任务类型，该类型通过注册表 xf_task_reg.inc 实现静态注册任务类型。
vfunc	用于调用子任务功能的虚函数。

返回

xf_err_t

XF_ERR_INVALID_ARG 参数错误
XF_ERR_INITED 已初始化
XF_OK 注册完成

在文件 xf_task_base.c 第 34 行定义.

◆ xf_task_vfunc_unregister()

xf_err_t xf_task_vfunc_unregister ( xf_task_type_t type )

task 注销虚函数注册（一般用不到的函数）。

参数

type	任务类型，该类型通过注册表 xf_task_reg.inc 实现静态注册任务类型。

返回

xf_err_t

XF_ERR_INVALID_ARG 参数错误
XF_OK 注销完成

在文件 xf_task_base.c 第 44 行定义.

◆ xf_task_get_vfunc()

const xf_task_vfunc_t * xf_task_get_vfunc ( xf_task_type_t type )

task 获取虚函数。

参数

type	任务，该类型通过注册表 xf_task_reg.inc 实现静态注册任务类型。

返回: const xf_task_vfunc_t* 返回虚函数结构体地址

在文件 xf_task_base.c 第 53 行定义.

◆ xf_task_base_init()

void xf_task_base_init	(	xf_task_base_t *	task_base,
		xf_task_manager_t	manager,
		xf_task_type_t	type,
		uint16_t	priority,
		xf_task_func_t	func,
		void *	arg
	)

task 初始化。

参数

task_base	task base 对象。
manager	task 所从属的任务管理器。
type	task 子任务类型，该类型通过注册表 xf_task_reg.inc 实现静态注册任务类型。
priority	任务优先级。
func	任务执行函数。
arg	任务自定义参数。

在文件 xf_task_base.c 第 61 行定义.

◆ xf_task_base_reset()

void xf_task_base_reset ( xf_task_base_t * task_base )

重置 task base 部分内容

参数

task_base task base 对象

在文件 xf_task_base.c 第 89 行定义.

◆ xf_task_base_set_state()

xf_err_t xf_task_base_set_state	(	xf_task_t	task,
		xf_task_state_t	state
	)

task 设置状态。

参数

task	task 任务对象。
state	task 任务状态。

返回

xf_err_t

XF_ERR_NOT_SUPPORTED 当任务出于删除态或者挂起态，此时设置状态无用
XF_OK 设置成功

在文件 xf_task_base.c 第 105 行定义.

◆ xf_task_destructor()

void xf_task_destructor ( xf_task_t task )

任务销毁。回收任务资源

参数

task 任务对象

在文件 xf_task_base.c 第 135 行定义.

变量说明

◆ _xf_task_vfunc_group

const xf_task_vfunc_t* _xf_task_vfunc_group[_XF_TASK_TYPE_MAX] = {0}

static

在文件 xf_task_base.c 第 28 行定义.