xf_task_kernel.h

浏览该文件的文档.

 
#ifndef __XF_TASK_KERNEL_H__
#define __XF_TASK_KERNEL_H__
 
/* ==================== [Includes] ========================================== */
 
#include "xf_task_manager.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ==================== [Defines] =========================================== */
 
/* ==================== [Typedefs] ========================================== */
 
typedef void (*xf_task_func_t)(xf_task_t task);
 
typedef enum _xf_task_state_t {
    _XF_TASK_STATE_NONE = -1,
    XF_TASK_STATE_READY,    
    XF_TASK_STATE_RUNNING,  
    XF_TASK_STATE_BLOCKED,  
    XF_TASK_STATE_SUSPEND,  
    XF_TASK_STATE_DELETE,   
} xf_task_state_t;
 
typedef enum _xf_task_type_t {
    _XF_TASK_TYPE_NONE = -1,
#define XF_TASK_REG_ENUM
#include "../task/xf_task_reg.inc"
    _XF_TASK_TYPE_MAX,
} xf_task_type_t;
 
/* ==================== [Global Prototypes] ================================= */
 
xf_task_t xf_task_create_with_manager(xf_task_manager_t manager, xf_task_type_t type, xf_task_func_t func,
                                      void *func_arg, uint16_t priority, void *config);
 
void xf_task_delete(xf_task_t task);
 
void xf_task_reset(xf_task_t task);
 
void *xf_task_get_arg(xf_task_t task);
 
int32_t xf_task_get_timeout(xf_task_t task);
 
xf_task_manager_t xf_task_get_manager(xf_task_t task);
 
#if XF_TASK_HUNGER_IS_ENABLE
 
void xf_task_feel_hungery_enable(xf_task_t task, uint32_t hunger_time);
 
void xf_task_feel_hungery_disable(xf_task_t task);
 
#endif // XF_TASK_HUNGER_IS_ENABLE
 
xf_err_t xf_task_suspend(xf_task_t task);
 
xf_err_t xf_task_resume(xf_task_t task);
 
xf_err_t xf_task_trigger(xf_task_t task);
 
xf_task_type_t xf_task_get_type(xf_task_t task);
 
xf_task_state_t xf_task_get_state(xf_task_t task);
 
uint16_t xf_task_get_priority(xf_task_t task);
 
xf_err_t xf_task_set_priority(xf_task_t task, uint16_t priority);
 
xf_err_t xf_task_set_delay(xf_task_t task, uint32_t delay_ms);
 
xf_err_t xf_task_set_func(xf_task_t task, xf_task_func_t func, void *arg);
 
#if XF_TASK_USER_DATA_IS_ENABLE
 
xf_err_t xf_task_set_user_data(xf_task_t task, void *user_data);
 
void *xf_task_get_user_data(xf_task_t task);
 
#endif // XF_TASK_USER_DATA_IS_ENABLE
 
/* ==================== [Macros] ============================================ */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif // __XF_TASK_KERNEL_H__