aiot_task_api.h

浏览该文件的文档.

#ifndef __AIOT_TASK_API_H__
#define __AIOT_TASK_API_H__

#if defined(__cplusplus)
extern "C" {
#endif

#include <stdint.h>

#define STATE_TASK_BASE                                             (-0x0B00)

#define STATE_TASK_DEINIT_HANDLE_IS_NULL                            (-0x0B01)

#define STATE_TASK_SETOPT_HANDLE_IS_NULL                            (-0x0B02)

#define STATE_TASK_RECV_NOTIFY                                      (-0x0B03)

#define STATE_TASK_PARSE_NOTIFY_FAILED                              (-0x0B04)

#define STATE_TASK_PARSE_JSON_MALLOC_FAILED                         (-0x0B05)

#define STATE_TASK_PARSE_JSON_ERROR                                 (-0x0B06)

#define STATE_TASK_QUERY_TASK_ID_IS_NULL                            (-0x0B07)

#define STATE_TASK_RECV_GET_LIST_REPLY                              (-0x0B08)

#define STATE_TASK_SETOPT_DATA_IS_NULL                              (-0x0B09)

#define STATE_TASK_UPDATE_STATUS_INVALID                            (-0x0B0A)

#define STATE_TASK_UPDATE_STATUS_DETAILS_INVALID                     (-0x0B0B)

typedef enum {
    AIOT_TASKOPT_MQTT_HANDLE,

    AIOT_TASKOPT_RECV_HANDLER,

    AIOT_TASKOPT_USERDATA,
    AIOT_TASKOPT_MAX
} aiot_task_option_t;

typedef enum {
    AIOT_TASK_STATUS_QUEUED,             /* 服务端设置的状态: 任务处于队列中, 还没有推送 */
    AIOT_TASK_STATUS_SENT,               /* 服务端设置的状态: 任务已推送 */
    AIOT_TASK_STATUS_IN_PROGRESS,        /* 设备端设置的状态: 任务进行中. 设备端开始执行一个任务后, 将 */
    AIOT_TASK_STATUS_SUCCEEDED,          /* 设备端设置的状态: 任务完成 */
    AIOT_TASK_STATUS_FAILED,             /* 设备端设置的状态: 任务执行失败 */
    AIOT_TASK_STATUS_REJECTED,           /* 设备端设置的状态: 设备端拒绝执行任务 */
    AIOT_TASK_STATUS_CANCELLED,          /* 服务端设置的状态: 任务被服务端取消 */
    AIOT_TASK_STATUS_REMOVED,            /* 服务端设置的状态: 任务从服务端删除 */
    AIOT_TASK_STATUS_TIMED_OUT,          /* 服务端设置的状态: 任务执行超时 */
    AIOT_TASK_STATUS_NOT_FOUND           /* 服务端设置的状态: 没有找到此任务相关信息 */
} aiot_task_status_t;

typedef enum {
    AIOT_TASKRECV_NOTIFY,               /* 对应/sys/{productKey}/{deviceName}/thing/job/notify 这个下行topic, 云端主动下推, 带任务详情 */
    AIOT_TASKRECV_GET_DETAIL_REPLY,     /* 对应/sys/{productKey}/{deviceName}/thing/job/get_reply 这个下行topic, 可以是单个任务的详情, 也可以是任务列表的简单描述 */
    AIOT_TASKRECV_GET_LIST_REPLY,       /* 对应/sys/{productKey}/{deviceName}/thing/job/get_reply 这个下行topic, 可以是单个任务的详情, 也可以是任务列表的简单描述 */
    AIOT_TASKRECV_UPDATE_REPLY          /* 对应/sys/{productKey}/{deviceName}/thing/job/update_reply 这个下行topic, 里面包含某个任务的update的结果, 即是否成功 */
} aiot_task_recv_type_t;

typedef struct {
    char *task_id;                      /* 任务ID */
    aiot_task_status_t status;          /* 任务的状态 */
    char *job_document;                 /* 任务执行规则 */
    char *sign_method;                  /* 文件签名的方法 */
    char *sign;                         /* 文件的签名 */
    char *document_file_url;            /* 任务文件下载的url */
    char *status_details;               /* 客户自定义状态，透传到云端, 注意格式为json对象，例如 "{\"key\": \"value\"", strlen("\"key\": \"value\"}"*/
    uint8_t progress;                   /* 任务处理的进度，数字从0-100 */
    void *handle;                       /* 任务处理的句柄 */
} task_desc_t;

typedef struct {
    char *task_id;                      /* 任务ID */
    aiot_task_status_t status;          /* 任务的状态 */
} task_summary_t;

typedef struct {
    uint32_t number;                    /* 从云端拉取的任务list的大小 */
    task_summary_t *tasks;              /* 拉取的任务数组指针 */
} task_get_list_reply_t;

typedef struct {
    uint32_t code;                      /* 云端返回的code */
    task_desc_t task;                   /* 任务描述的详细信息 */
} task_get_detail_reply_t;

typedef struct {
    uint32_t code;                      /* 云端返回的code */
    char *task_id;                      /* 更新任务后返回的任务id */
    aiot_task_status_t status;          /* 更新任务后返回的状态 */
} task_update_reply_t;

typedef struct {
    aiot_task_recv_type_t type;                     /* 返回的数据类型 */
    union {
        task_desc_t notify;                         /* 云端主动推送任务的数据 */
        task_get_list_reply_t get_list_reply;       /* 请求任务list返回的数据 */
        task_get_detail_reply_t get_detail_reply;   /* 请求任务详细状态返回的数据 */
        task_update_reply_t update_reply;           /* 更新任务状态返回的数据 */
    } data;
} aiot_task_recv_t;

typedef void (* aiot_task_recv_handler_t)(void *handle, const aiot_task_recv_t *recv, void *userdata);

void   *aiot_task_init(void);

int32_t aiot_task_deinit(void **handle);

int32_t aiot_task_setopt(void *handle, aiot_task_option_t option, void *data);

int32_t aiot_task_get_task_list(void *handle);

/* 发送报文到/sys/{productKey}/{deviceName}/thing/job/get. 若函数入参user_task_id不为空, 则上行报文的payload为 "taskId": user_task_id, 返回该任务的详情; */
/* 若user_task_id为空, 则上行报文的payload为 "taskId": "$next", 云端返回未处于终态的任务队列中时间排在最前面一个任务, 该任务状态为QUEUED、SENT、IN_PROGRESS三者之一 */

int32_t aiot_task_get_task_detail(void *handle, char *user_task_id);

int32_t aiot_task_update(void *handle, task_desc_t *task);
#if defined(__cplusplus)
}
#endif

#endif  /* #ifndef __AIOT_TASK_API_H__ */