xf_task_port.h 文件参考

xf_task 对接总头文件。 更多...

#include "xf_task_port_config.h"
#include "xf_utils.h"

xf_task_port.h 的引用(Include)关系图:

浏览源代码.

typedef void *	xf_task_manager_t
	任务管理器句柄。
typedef void(*	xf_context_func_t) (void *arg)
	上下文切换函数原型。
typedef xf_task_time_t(*	xf_task_clock_t) (void)
	task 时钟对接，为调度器提供心跳。
typedef void(*	xf_task_create_context_t) (xf_task_manager_t manager, xf_context_func_t context_entry, void *context, void *stack, size_t stack_size)
	创建上下文的函数指针。
typedef void(*	xf_task_swap_context_t) (xf_task_manager_t manager, void *old_context, void *new_context)
	切换上席文的函数指针。
xf_err_t	xf_task_tick_init (xf_task_clock_t clock)
	设置当前任务的心跳。
xf_err_t	xf_task_context_init (xf_task_create_context_t create_context, xf_task_swap_context_t swap_context)
	对接保存任务上下文函数。

详细描述

xf_task 对接总头文件。

作者

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

版本

0.1

日期

2024-03-05

版权所有

Copyright (c) 2024, CorAL. All rights reserved.

在文件 xf_task_port.h 中定义.

类型定义说明

xf_task_manager_t

typedef void* xf_task_manager_t

任务管理器句柄。

在文件 xf_task_port.h 第 38 行定义.

xf_context_func_t

typedef void(* xf_context_func_t) (void *arg)

上下文切换函数原型。

参数

arg	通常为任务管理器句柄。

在文件 xf_task_port.h 第 45 行定义.

xf_task_clock_t

typedef xf_task_time_t(* xf_task_clock_t) (void)

task 时钟对接，为调度器提供心跳。

返回

返回时钟的时间戳

在文件 xf_task_port.h 第 52 行定义.

xf_task_create_context_t

typedef void(* xf_task_create_context_t) (xf_task_manager_t manager, xf_context_func_t context_entry, void *context, void *stack, size_t stack_size)

创建上下文的函数指针。

参数

manager	当前任务管理器（用于获取上下文句柄）。
context_entry	上下文。
context	上下文函数。
stack	上下文堆栈。
stack_size	上下文堆栈大小。

在文件 xf_task_port.h 第 65 行定义.

xf_task_swap_context_t

typedef void(* xf_task_swap_context_t) (xf_task_manager_t manager, void *old_context, void *new_context)

切换上席文的函数指针。

参数

manager	当前任务管理器（用于获取上下文句柄）。
old_context	当前上下文。
new_context	要切换到的上下文。

在文件 xf_task_port.h 第 75 行定义.

函数说明

xf_task_tick_init()

xf_err_t xf_task_tick_init

(

xf_task_clock_t

clock

)

设置当前任务的心跳。

参数

clock

获取心跳的数值。

返回

xf_err_t

• XF_ERR_INVALID_ARG 参数错误
• XF_OK 参数设置成功

在文件 xf_task_port.c 第 38 行定义.

xf_task_context_init()

xf_err_t xf_task_context_init	(	xf_task_create_context_t	create_context,
		xf_task_swap_context_t	swap_context
	)

对接保存任务上下文函数。

参数

create_context	创建保存上下文。
swap_context	切换上下文。

返回

xf_err_t

• XF_ERR_INVALID_ARG 参数错误
• XF_OK 参数设置成功

在文件 xf_task_port.c 第 56 行定义.