etask使用指南

事件任务框架是是一种用于处理异步事件和任务的编程模型。它提供了一种结构化的方式来管理和调度事件和任务，以便在单线程、多线程或多任务环境中实现高效的并发处理。

使用事件任务框架，可以将复杂的并发处理逻辑进行抽象和管理，提高代码的可维护性和可扩展性。它使得开发人员能够更加专注于事件的处理逻辑，而无需过多关注底层的并发细节。

事件任务框架支持动态添加和移除事件任务的能力。当系统需要新增功能或修改业务逻辑时，可以通过添加或替换相应的事件任务来实现，而无需修改其他部分的代码。这种可插拔性使得系统更加灵活，能够快速响应变化的需求。

初始化 etask

void mr_etask_init(void *pool, size_t size);

参数	描述
pool	队列内存池
size	缓存队列大小

缓冲队列将对发生的任务进行缓存，当出现任务丢失，请增加缓冲队列大小或提高任务循环处理频率。

反初始化 etask

void mr_etask_uninit(void);

初始化时添加的内存池将在此时解除占用，请在未反初始化时不要访问分配给etask队列的内存。

更新时钟

void mr_etask_tick_update(void);

etask时基更新，硬件定时任务将在此处执行。

处理任务

void mr_etask_handle(void);

任务按发生顺序处理（FIFO），仅会处理进入处理函数前已发生的任务，防止单一任务循环触发阻塞系统。

状态机任务将在每次任务处理结束后运行。

启动任务

int mr_etask_start(uint32_t id, uint8_t sflags, size_t time, int (*cb)(void *args), void *args);

参数	描述
id	任务ID
sflags	启动标志
time	定时时间
cb	任务回调函数
args	回调函数参数
返回
MR_EOK	启动成功
错误码	启动失败

sflags: 任务分为普通任务与定时任务。定时任务可分为单次/周期和软件/硬件，单次定时任务在处理完成后将释放任务块，周期定时任务在处理完成后将自动重启直至用户停止该任务。软件定时任务在超时发生时将任务加入队列中等待处理，而硬件定时任务将在时钟更新处直接处理。

MR_ETASK_SFLAG_EVENT                                                /* 普通任务 */
MR_ETASK_SFLAG_TIMER                                                /* 定时任务（周期、软件） */
MR_ETASK_SFLAG_TIMER | MR_ETASK_SFLAG_HARD                          /* 定时任务（周期、硬件） */
MR_ETASK_SFLAG_TIMER | MR_ETASK_SFLAG_ONESHOT                       /* 定时任务（单次、软件） */
MR_ETASK_SFLAG_TIMER | MR_ETASK_SFLAG_ONESHOT | MR_ETASK_SFLAG_HARD /* 定时任务（单次、硬件） */

任务内存块将由 mr_malloc 申请。

当与RTOS线程组合使用时，当任务回调中将线程挂起，可能会导致其余所有任务无法响应（等同于所有任务被挂起等待），因此任务处理函数中不因使用类似功能（任务回调应能直接处理无需等待）。任务回调函数禁止阻塞（while死循环等）。一旦有任务阻塞，etask将无法正常响应其余任务。

停止任务

int mr_etask_stop(uint32_t id);

参数	描述
id	任务ID
返回
MR_EOK	停止成功
错误码	停止失败

任务内存块将在此释放。

唤醒任务

int mr_etask_wakeup(uint32_t id, uint8_t wflag);

参数	描述
id	任务ID
wflag	唤醒标志
返回
MR_EOK	唤醒成功
错误码	唤醒失败

wflag：任务唤醒标志可分为立即唤醒、延迟唤醒和状态机唤醒，立即唤醒将在调用处直接处理，延迟唤醒加入队列中等待处理，状态机唤醒将转换为etask状态机任务。

MR_ETASK_WFLAG_NOW                                                  /* 立即唤醒 */
MR_ETASK_WFLAG_DELAY                                                /* 延迟唤醒 */
MR_ETASK_WFLAG_STATE                                                /* 状态唤醒 */

状态任务将在每次任务处理结束后运行（有且仅有一个状态任务，默认无状态任务）。

当唤醒任务发生失败（错误码 -5）时，请增加缓冲队列大小或提高任务处理频率（缓冲队列已满，无法及时响应任务，导致任务丢失）。

使用示例：

/* 定义任务 */

enum
{
	TASK_1,
	TASK_2,
	TASK_3,
};

/* 定义任务回调 */
mr_err_t task1_cb(void *args)
{
    printf("task1_cb\r\n");
    return MR_EOK;
}

mr_err_t task2_cb(void *args)
{
    printf("task2_cb\r\n");
    return MR_EOK;
}

mr_err_t task3_cb(void *args)
{
    printf("task3_cb\r\n");
    return MR_EOK;
}

uint8_t task_pool[1024] = {0};

int main(void)
{
    /* 初始化 etask */
    mr_etask_init(task_pool, sizeof(task_pool);
    
    /* 启动普通任务 */
    mr_etask_start(TASK_1, MR_ETASK_SFLAG_EVENT, 0, task1_cb, MR_NULL);
    mr_etask_start(TASK_2, MR_ETASK_SFLAG_EVENT, 0, task2_cb, MR_NULL);
    
    /* 启动定时任务 */
    mr_etask_start(TASK_3, MR_ETASK_SFLAG_TIMER | MR_ETASK_SFLAG_HARD, 5, task3_cb, MR_NULL);
    
    /* 延迟唤醒任务1 */
    mr_etask_wakeup(TASK_1, MR_ETASK_WFLAG_DELAY);
    /* 立即唤醒任务2 */
    mr_etask_wakeup(TASK_2, MR_ETASK_WFLAG_NOW);
    /* 状态唤醒任务2 */
    mr_etask_wakeup(TASK_3, MR_ETASK_WFLAG_STATE);

    while (1)
    {
        /* 更新时钟 */
        mr_etask_tick_update();
        /* 处理任务 */
        mr_etask_handle();
    }
}

----------

## etask 底层支持多分支处理，将不同类型的task交由不同的etask处理，有兴趣的可以研究源码。

MacRsh / mr-etask

etask使用指南

初始化 etask

反初始化 etask

更新时钟

处理任务

启动任务

停止任务

唤醒任务

简介

发行版

贡献者

近期动态

MacRsh / mr-etask .gitee-modal { width: 500px !important; }

etask使用指南

初始化 etask

反初始化 etask

更新时钟

处理任务

启动任务

停止任务

唤醒任务

简介

发行版

贡献者

近期动态

搜索帮助

MacRsh / mr-etask