From e58c74571f1f32719a61e0aea377fa67fd72f9e8 Mon Sep 17 00:00:00 2001 From: pdf001 <1626385780@qq.com> Date: Fri, 4 Jul 2025 06:21:41 +0000 Subject: [PATCH 1/9] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E9=93=BE=E6=8E=A5=20Sign?= =?UTF-8?q?ed-off-by:=20pdf001=20<1626385780@qq.com>?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../apis-backgroundtasks-kit/Readme-CN.md | 14 +++++++------- zh-cn/application-dev/website.md | 14 +++++++------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/zh-cn/application-dev/reference/apis-backgroundtasks-kit/Readme-CN.md b/zh-cn/application-dev/reference/apis-backgroundtasks-kit/Readme-CN.md index 3bcc8f75d1a..cbd601cd52e 100644 --- a/zh-cn/application-dev/reference/apis-backgroundtasks-kit/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis-backgroundtasks-kit/Readme-CN.md @@ -27,15 +27,15 @@ - C API - 模块 - - [TransientTask](_transient_task.md) - - [BackgroundProcessManager](_background_process_manager.md) + - [BackgroundProcessManager](capi-backgroundprocessmanager.md) + - [TransientTask](capi-transienttask.md) - 头文件 - - [transient_task_api.h](transient__task__api_8h.md) - - [transient_task_type.h](transient__task__type_8h.md) - - [background_process_manager.h](background__process__manager_8h.md) + - [background_process_manager.h](capi-background-process-manager-h.md) + - [transient_task_api.h](capi-transient-task-api-h.md) + - [transient_task_type.h](capi-transient-task-type-h.md) - 结构体 - - [TransientTask_DelaySuspendInfo](_transient_task___delay_suspend_info.md) - - [TransientTask_TransientTaskInfo](_transient_task___transient_task_info.md) + - [TransientTask_DelaySuspendInfo](capi-transienttask-transienttask-delaysuspendinfo.md) + - [TransientTask_TransientTaskInfo](capi-transienttask-transienttask-transienttaskinfo.md) - 错误码 - [backgroundTaskManager错误码](errorcode-backgroundTaskMgr.md) diff --git a/zh-cn/application-dev/website.md b/zh-cn/application-dev/website.md index 6d2e0bba77f..eb75376c4df 100644 --- a/zh-cn/application-dev/website.md +++ b/zh-cn/application-dev/website.md @@ -3399,15 +3399,15 @@ - C API - 模块 - - [TransientTask](reference/apis-backgroundtasks-kit/_transient_task.md) - - [BackgroundProcessManager](reference/apis-backgroundtasks-kit/_background_process_manager.md) + - [BackgroundProcessManager](reference/apis-backgroundtasks-kit/capi-backgroundprocessmanager.md) + - [TransientTask](reference/apis-backgroundtasks-kit/capi-transienttask.md) - 头文件 - - [transient_task_api.h](reference/apis-backgroundtasks-kit/transient__task__api_8h.md) - - [transient_task_type.h](reference/apis-backgroundtasks-kit/transient__task__type_8h.md) - - [background_process_manager.h](reference/apis-backgroundtasks-kit/background__process__manager_8h.md) + - [background_process_manager.h](reference/apis-backgroundtasks-kit/capi-background-process-manager-h.md) + - [transient_task_api.h](reference/apis-backgroundtasks-kit/capi-transient-task-api-h.md) + - [transient_task_type.h](reference/apis-backgroundtasks-kit/capi-transient-task-type-h.md) - 结构体 - - [TransientTask_DelaySuspendInfo](reference/apis-backgroundtasks-kit/_transient_task___delay_suspend_info.md) - - [TransientTask_TransientTaskInfo](reference/apis-backgroundtasks-kit/_transient_task___transient_task_info.md) + - [TransientTask_DelaySuspendInfo](reference/apis-backgroundtasks-kit/capi-transienttask-transienttask-delaysuspendinfo.md) + - [TransientTask_TransientTaskInfo](reference/apis-backgroundtasks-kit/capi-transienttask-transienttask-transienttaskinfo.md) - 错误码 - [backgroundTaskManager错误码](reference/apis-backgroundtasks-kit/errorcode-backgroundTaskMgr.md) -- Gitee From 2001ed07b674428713f2b85c7784aee68ed5eca9 Mon Sep 17 00:00:00 2001 From: pdf001 <1626385780@qq.com> Date: Fri, 4 Jul 2025 06:08:23 +0000 Subject: [PATCH 2/9] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E7=BB=93=E6=9E=84?= =?UTF-8?q?=E4=BD=93=E3=80=90TransientTask=5FTransientTaskInfo=E3=80=91=20?= =?UTF-8?q?Signed-off-by:=20pdf001=20<1626385780@qq.com>?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../_transient_task___transient_task_info.md | 44 ------------------- ...enttask-transienttask-transienttaskinfo.md | 22 ++++++++++ 2 files changed, 22 insertions(+), 44 deletions(-) delete mode 100644 zh-cn/application-dev/reference/apis-backgroundtasks-kit/_transient_task___transient_task_info.md create mode 100644 zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-transienttask-transienttask-transienttaskinfo.md diff --git a/zh-cn/application-dev/reference/apis-backgroundtasks-kit/_transient_task___transient_task_info.md b/zh-cn/application-dev/reference/apis-backgroundtasks-kit/_transient_task___transient_task_info.md deleted file mode 100644 index 44b8dc6a402..00000000000 --- a/zh-cn/application-dev/reference/apis-backgroundtasks-kit/_transient_task___transient_task_info.md +++ /dev/null @@ -1,44 +0,0 @@ -# TransientTask_TransientTaskInfo - - -## 概述 - -定义所有短时任务返回信息结构体。 - -**起始版本：** 20 - -**相关模块：**[TransientTask](_transient_task.md) - - -## 汇总 - - -### 成员变量 - -| 名称 | 描述 | -|------------------------------------------------------------------------------------------------|----------------| -| int32_t [remainingQuota](#remainingquota) | 当日剩余总配额。单位：毫秒。 | -| TransientTask_DelaySuspendInfo [transientTaskInfo[]](#transienttaskinfo) | 已申请的所有短时任务信息。包括短时任务请求ID、剩余时间（单位：毫秒）。 | - - -## 结构体成员变量说明 - - -### remainingQuota - -``` -int32_t TransientTask_TransientTaskInfo::remainingQuota -``` -**描述** - -当日剩余总配额。单位：毫秒。 - - -### transientTaskInfo[] - -``` -TransientTask_DelaySuspendInfo TransientTask_TransientTaskInfo::transientTaskInfo[] -``` -**描述** - -已申请的所有短时任务信息。包括短时任务请求ID、剩余时间（单位：毫秒）。 \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-transienttask-transienttask-transienttaskinfo.md b/zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-transienttask-transienttask-transienttaskinfo.md new file mode 100644 index 00000000000..23302a5f37f --- /dev/null +++ b/zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-transienttask-transienttask-transienttaskinfo.md @@ -0,0 +1,22 @@ +# TransientTask_TransientTaskInfo + +## 概述 + +定义所有短时任务信息结构体。 + +**起始版本：** 20 + +**相关模块：** [TransientTask](capi-transienttask.md) + +**所在头文件：** [transient_task_type.h](capi-transient-task-type-h.md) + +## 汇总 + +### 成员变量 + +| 名称 | 描述 | +|-------------------------------------------------------------------------------------------------------------------------------| -- | +| int32_t remainingQuota | 当日剩余总配额。单位：毫秒。 | +| [TransientTask_DelaySuspendInfo](capi-transienttask-transienttask-delaysuspendinfo.md) transientTasks[TRANSIENT_TASK_MAX_NUM] | 已申请的所有短时任务信息。包括短时任务请求ID、剩余时间（单位：毫秒）。 | + + -- Gitee From 58dfdce2ca38022cdeae8c3521b4628df5cee996 Mon Sep 17 00:00:00 2001 From: pdf001 <1626385780@qq.com> Date: Fri, 4 Jul 2025 06:07:33 +0000 Subject: [PATCH 3/9] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E7=BB=93=E6=9E=84?= =?UTF-8?q?=E4=BD=93=E3=80=90TransientTask=5FDelaySuspendInfo=E3=80=91=20S?= =?UTF-8?q?igned-off-by:=20pdf001=20<1626385780@qq.com>?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../_transient_task___delay_suspend_info.md | 45 ------------------- ...ienttask-transienttask-delaysuspendinfo.md | 22 +++++++++ 2 files changed, 22 insertions(+), 45 deletions(-) delete mode 100644 zh-cn/application-dev/reference/apis-backgroundtasks-kit/_transient_task___delay_suspend_info.md create mode 100644 zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-transienttask-transienttask-delaysuspendinfo.md diff --git a/zh-cn/application-dev/reference/apis-backgroundtasks-kit/_transient_task___delay_suspend_info.md b/zh-cn/application-dev/reference/apis-backgroundtasks-kit/_transient_task___delay_suspend_info.md deleted file mode 100644 index bb53ddc51d6..00000000000 --- a/zh-cn/application-dev/reference/apis-backgroundtasks-kit/_transient_task___delay_suspend_info.md +++ /dev/null @@ -1,45 +0,0 @@ -# TransientTask_DelaySuspendInfo - - -## 概述 - -定义短时任务返回信息结构体。 - -**起始版本：** 13 - -**相关模块：**[TransientTask](_transient_task.md) - -**所在头文件：**[transient_task_type.h](transient__task__type_8h.md) - -## 汇总 - - -### 成员变量 - -| 名称 | 描述 | -| -------- | -------- | -| int32_t [requestId](#requestid) | 短时任务请求ID。 | -| int32_t [actualDelayTime](#actualdelaytime) | 剩余时间（单位：毫秒）。 | - - -## 结构体成员变量说明 - - -### actualDelayTime - -``` -int32_t TransientTask_DelaySuspendInfo::actualDelayTime -``` -**描述** - -剩余时间（单位：毫秒）。 - - -### requestId - -``` -int32_t TransientTask_DelaySuspendInfo::requestId -``` -**描述** - -短时任务请求ID。 diff --git a/zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-transienttask-transienttask-delaysuspendinfo.md b/zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-transienttask-transienttask-delaysuspendinfo.md new file mode 100644 index 00000000000..864ee7a2cd0 --- /dev/null +++ b/zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-transienttask-transienttask-delaysuspendinfo.md @@ -0,0 +1,22 @@ +# TransientTask_DelaySuspendInfo + +## 概述 + +定义短时任务返回信息结构体。 + +**起始版本：** 13 + +**相关模块：** [TransientTask](capi-transienttask.md) + +**所在头文件：** [transient_task_type.h](capi-transient-task-type-h.md) + +## 汇总 + +### 成员变量 + +| 名称 | 描述 | +| -- | -- | +| int32_t requestId | 短时任务请求ID。 | +| int32_t actualDelayTime | 剩余时间（单位：毫秒）。 | + + -- Gitee From c9bf1d432755610384a9efcb9616b2ca4a076d25 Mon Sep 17 00:00:00 2001 From: pdf001 <1626385780@qq.com> Date: Fri, 4 Jul 2025 06:06:21 +0000 Subject: [PATCH 4/9] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E5=A4=B4=E6=96=87?= =?UTF-8?q?=E4=BB=B6=E3=80=90background=5Fprocess=5Fmanager.h=E3=80=91=20S?= =?UTF-8?q?igned-off-by:=20pdf001=20<1626385780@qq.com>?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../background__process__manager_8h.md | 41 ------ .../capi-background-process-manager-h.md | 124 ++++++++++++++++++ 2 files changed, 124 insertions(+), 41 deletions(-) delete mode 100644 zh-cn/application-dev/reference/apis-backgroundtasks-kit/background__process__manager_8h.md create mode 100644 zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-background-process-manager-h.md diff --git a/zh-cn/application-dev/reference/apis-backgroundtasks-kit/background__process__manager_8h.md b/zh-cn/application-dev/reference/apis-backgroundtasks-kit/background__process__manager_8h.md deleted file mode 100644 index cf2e4af497f..00000000000 --- a/zh-cn/application-dev/reference/apis-backgroundtasks-kit/background__process__manager_8h.md +++ /dev/null @@ -1,41 +0,0 @@ -# background_process_manager.h - - -## 概述 - -本模块提供了后台子进程管控接口。开发者可以通过本模块接口对子进程进行压制、解压制，避免子进程过多占用系统资源，导致系统使用卡顿。 本模块接口仅对通过[OH_Ability_StartNativeChildProcess](../apis-ability-kit/c-apis-ability-childprocess.md#oh_ability_startnativechildprocess)接口创建的子进程生效。 - -**库：** libbackground_process_manager.z.so - -**系统能力：** SystemCapability.Resourceschedule.BackgroundProcessManager - -**起始版本：** 17 - -**相关模块：**[BackgroundProcessManager](_background_process_manager.md) - - -## 汇总 - - -### 类型定义 - -| 名称 | 描述 | -| -------- | -------- | -| typedef enum [BackgroundProcessManager_ProcessPriority](_background_process_manager.md#backgroundprocessmanager_processpriority) [BackgroundProcessManager_ProcessPriority](_background_process_manager.md#backgroundprocessmanager_processpriority) | 子进程压制档位。 | -| typedef enum [BackgroundProcessManager_ErrorCode](_background_process_manager.md#backgroundprocessmanager_errorcode) [BackgroundProcessManager_ErrorCode](_background_process_manager.md#backgroundprocessmanager_errorcode) | 定义后台子进程管控错误码。 | - - -### 枚举 - -| 名称 | 描述 | -| -------- | -------- | -| [BackgroundProcessManager_ProcessPriority](_background_process_manager.md#backgroundprocessmanager_processpriority) { [PROCESS_BACKGROUND](_background_process_manager.md) = 1, [PROCESS_INACTIVE](_background_process_manager.md) = 2 } | 子进程压制档位。 | -| [BackgroundProcessManager_ErrorCode](_background_process_manager.md#backgroundprocessmanager_errorcode) { [ERR_BACKGROUND_PROCESS_MANAGER_SUCCESS](_background_process_manager.md) = 0, [ERR_BACKGROUND_PROCESS_MANAGER_INVALID_PARAM](_background_process_manager.md) = 401, [ERR_BACKGROUND_PROCESS_MANAGER_REMOTE_ERROR](_background_process_manager.md) = 31800001 } | 定义后台子进程管控错误码。 | - - -### 函数 - -| 名称 | 描述 | -| -------- | -------- | -| int [OH_BackgroundProcessManager_SetProcessPriority](_background_process_manager.md#oh_backgroundprocessmanager_setprocesspriority) (int pid, [BackgroundProcessManager_ProcessPriority](_background_process_manager.md#backgroundprocessmanager_processpriority) priority) | 设置子进程的压制档位，子进程被压制后可获得的CPU资源将会受到限制。如果主进程调度策略发生变化，如从后台切至前台等， 子进程会跟随主进程一同变化，子进程如需继续压制，需要重新调用本接口。 | -| int [OH_BackgroundProcessManager_ResetProcessPriority](_background_process_manager.md#oh_backgroundprocessmanager_resetprocesspriority) (int pid) | 为子进程解压制，即子进程策略恢复为主进程调度策略。若主进程调度策略发生变化，如从后台切至前台等， 子进程会跟随主进程一同变化，等效于执行一次resetProcessPriority动作。 | diff --git a/zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-background-process-manager-h.md b/zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-background-process-manager-h.md new file mode 100644 index 00000000000..bde696560b8 --- /dev/null +++ b/zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-background-process-manager-h.md @@ -0,0 +1,124 @@ +# background_process_manager.h + +## 概述 + +本模块提供了后台子进程管控接口。开发者可以通过本模块接口对子进程进行压制、解压制，避免子进程过多占用系统资源，导致系统使用卡顿。本模块接口仅对通过OH_Ability_StartNativeChildProcess接口创建的子进程生效。 + +**引用文件：** + +**库：** libbackground_process_manager.z.so + +**系统能力：** SystemCapability.Resourceschedule.BackgroundProcessManager + +**起始版本：** 17 + +**相关模块：** [BackgroundProcessManager](capi-backgroundprocessmanager.md) + +## 汇总 + +### 枚举 + +| 名称 | typedef关键字 | 描述 | +| -- | -- | -- | +| [BackgroundProcessManager_ProcessPriority](#backgroundprocessmanager_processpriority) | BackgroundProcessManager_ProcessPriority | 子进程压制档位。 | +| [BackgroundProcessManager_ErrorCode](#backgroundprocessmanager_errorcode) | BackgroundProcessManager_ErrorCode | 定义后台子进程管控错误码。 | + +### 函数 + +| 名称 | 描述 | +| -- | -- | +| [int OH_BackgroundProcessManager_SetProcessPriority(int pid, BackgroundProcessManager_ProcessPriority priority)](#oh_backgroundprocessmanager_setprocesspriority) | 设置子进程的压制档位，子进程被压制后可获得的CPU资源将会受到限制。如果主进程调度策略发生变化，如从后台切至前台等，子进程会跟随主进程一同变化，子进程如需继续压制，需要重新调用本接口。 | +| [int OH_BackgroundProcessManager_ResetProcessPriority(int pid)](#oh_backgroundprocessmanager_resetprocesspriority) | 为子进程解压制，即子进程策略恢复为主进程调度策略。若主进程调度策略发生变化，如从后台切至前台等，子进程会跟随主进程一同变化，等效于执行一次resetProcessPriority动作。 | + +## 枚举类型说明 + +### BackgroundProcessManager_ProcessPriority + +``` +enum BackgroundProcessManager_ProcessPriority +``` + +**描述** + +子进程压制档位。 + +**起始版本：** 17 + +| 枚举项 | 描述 | +| -- | -- | +| PROCESS_BACKGROUND = 1 | 该档位相较PROCESS_INACTIVE压制效果更显著，获取到的CPU资源更少。推荐执行处于后台的图文页面等用户无感知业务的后台子进程时设置该档位。 | +| PROCESS_INACTIVE = 2 | 推荐正在执行播放音频、导航等用户可感知业务的后台子进程时设置该档位。 | + +### BackgroundProcessManager_ErrorCode + +``` +enum BackgroundProcessManager_ErrorCode +``` + +**描述** + +定义后台子进程管控错误码。 + +**起始版本：** 17 + +| 枚举项 | 描述 | +| -- | -- | +| ERR_BACKGROUND_PROCESS_MANAGER_SUCCESS = 0 | 压制参数发送成功。 | +| ERR_BACKGROUND_PROCESS_MANAGER_INVALID_PARAM = 401 | 参数检查失败。 | +| ERR_BACKGROUND_PROCESS_MANAGER_REMOTE_ERROR = 31800001 | 客户端进程请求系统服务进程，获取系统服务操作失败。 | + + +## 函数说明 + +### OH_BackgroundProcessManager_SetProcessPriority() + +``` +int OH_BackgroundProcessManager_SetProcessPriority(int pid, BackgroundProcessManager_ProcessPriority priority) +``` + +**描述** + +设置子进程的压制档位，子进程被压制后可获得的CPU资源将会受到限制。如果主进程调度策略发生变化，如从后台切至前台等，子进程会跟随主进程一同变化，子进程如需继续压制，需要重新调用本接口。 + +**起始版本：** 17 + + +**参数：** + +| 参数项 | 描述 | +| -- | -- | +| int pid | 需要被压制子进程的进程号，OH_Ability_StartNativeChildProcess接口创建子进程后的pid参数，即为子进程进程号。 | +| [BackgroundProcessManager_ProcessPriority](capi-background-process-manager-h.md#backgroundprocessmanager_processpriority) priority | 压制档位。 | + +**返回：** + +| 类型 | 说明 | +| -- | -- | +| int | 返回 [ERR_BACKGROUND_PROCESS_MANAGER_SUCCESS](capi-background-process-manager-h.md#backgroundprocessmanager_errorcode)，表示压制参数发送成功。
返回 [ERR_BACKGROUND_PROCESS_MANAGER_INVALID_PARAM](capi-background-process-manager-h.md#backgroundprocessmanager_errorcode)，表示参数检查失败。 | + +### OH_BackgroundProcessManager_ResetProcessPriority() + +``` +int OH_BackgroundProcessManager_ResetProcessPriority(int pid) +``` + +**描述** + +为子进程解压制，即子进程策略恢复为主进程调度策略。若主进程调度策略发生变化，如从后台切至前台等，子进程会跟随主进程一同变化，等效于执行一次resetProcessPriority动作。 + +**起始版本：** 17 + + +**参数：** + +| 参数项 | 描述 | +| -- | -- | +| int pid | 子进程的进程号，OH_Ability_StartNativeChildProcess接口创建子进程后的pid参数，即为子进程进程号。 | + +**返回：** + +| 类型 | 说明 | +| -- | -- | +| int | 返回 [ERR_BACKGROUND_PROCESS_MANAGER_SUCCESS](capi-background-process-manager-h.md#backgroundprocessmanager_errorcode)，表示压制参数发送成功。 | + + -- Gitee From 8ddb24a8aa5550557840f6c4b685b29361e9d893 Mon Sep 17 00:00:00 2001 From: pdf001 <1626385780@qq.com> Date: Fri, 4 Jul 2025 06:05:20 +0000 Subject: [PATCH 5/9] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E5=A4=B4=E6=96=87?= =?UTF-8?q?=E4=BB=B6=E3=80=90transient=5Ftask=5Ftype.h=E3=80=91=20Signed-o?= =?UTF-8?q?ff-by:=20pdf001=20<1626385780@qq.com>?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../capi-transient-task-type-h.md | 79 +++++++++++++++++++ .../transient__task__type_8h.md | 49 ------------ 2 files changed, 79 insertions(+), 49 deletions(-) create mode 100644 zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-transient-task-type-h.md delete mode 100644 zh-cn/application-dev/reference/apis-backgroundtasks-kit/transient__task__type_8h.md diff --git a/zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-transient-task-type-h.md b/zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-transient-task-type-h.md new file mode 100644 index 00000000000..6be304790f0 --- /dev/null +++ b/zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-transient-task-type-h.md @@ -0,0 +1,79 @@ +# transient_task_type.h + +## 概述 + +定义短时任务的错误码和结构体。 + +**引用文件：** + +**库：** libtransient_task.so + +**系统能力：** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask + +**起始版本：** 13 + +**相关模块：** [TransientTask](capi-transienttask.md) + +## 汇总 + +### 结构体 + +| 名称 | typedef关键字 | 描述 | +|------------------------------------------------------------------------------------------| -- | -- | +| [TransientTask_DelaySuspendInfo](capi-transienttask-transienttask-delaysuspendinfo.md) | TransientTask_DelaySuspendInfo | 定义短时任务返回信息结构体。 | +| [TransientTask_TransientTaskInfo](capi-transienttask-transienttask-transienttaskinfo.md) | TransientTask_TransientTaskInfo | 定义所有短时任务信息结构体。 | + +### 枚举 + +| 名称 | typedef关键字 | 描述 | +| -- | -- | -- | +| [TransientTask_ErrorCode](#transienttask_errorcode) | TransientTask_ErrorCode | 定义短时任务错误码。 | + +### 函数 + +| 名称 | typedef关键字 | 描述 | +| -- | -- | -- | +| [typedef void (\*TransientTask_Callback)(void)](#transienttask_callback) | TransientTask_Callback | 定义短时任务超时回调类型。 | + +## 枚举类型说明 + +### TransientTask_ErrorCode + +``` +enum TransientTask_ErrorCode +``` + +**描述** + +定义短时任务错误码。 + +**起始版本：** 13 + +| 枚举项 | 描述 | +| -- | -- | +| ERR_TRANSIENT_TASK_OK = 0 | 成功。 | +| ERR_TRANSIENT_TASK_INVALID_PARAM = 401 | 参数检查失败。可能原因：1.必选参数没有传入。2.参数类型错误。 | +| ERR_TRANSIENT_TASK_PARCEL_FAILED = 9800002 | Parcel读写操作失败。 | +| ERR_TRANSIENT_TASK_TRANSACTION_FAILED = 9800003 | IPC通信失败。 | +| ERR_TRANSIENT_TASK_SYS_NOT_READY = 9800004 | 系统服务失败。 | +| ERR_TRANSIENT_TASK_CLIENT_INFO_VERIFICATION_FAILED = 9900001 | 短时任务客户端信息校验失败。 | +| ERR_TRANSIENT_TASK_SERVICE_VERIFICATION_FAILED = 9900002 | 短时任务服务端校验失败。 | +| ERR_TRANSIENT_TASK_PARCELABLE_FAILED = 9900003 | 短时任务Parcel读写操作失败。可能原因：1.参数非法。2.申请内存失败。 | +| ERR_TRANSIENT_TASK_SERVICE_NOT_READY = 9900004 | 短时任务系统服务失败。 | + + +## 函数说明 + +### TransientTask_Callback() + +``` +typedef void (*TransientTask_Callback)(void) +``` + +**描述** + +定义短时任务超时回调类型。 + +**起始版本：** 13 + + diff --git a/zh-cn/application-dev/reference/apis-backgroundtasks-kit/transient__task__type_8h.md b/zh-cn/application-dev/reference/apis-backgroundtasks-kit/transient__task__type_8h.md deleted file mode 100644 index 1738afd38f5..00000000000 --- a/zh-cn/application-dev/reference/apis-backgroundtasks-kit/transient__task__type_8h.md +++ /dev/null @@ -1,49 +0,0 @@ -# transient_task_type.h - - -## 概述 - -定义短时任务的错误码和结构体。 - -**库：** libtransient_task.so - -**系统能力：** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask - -**起始版本：** 13 - -**相关模块：**[TransientTask](_transient_task.md) - - -## 汇总 - - -### 宏定义 - -| 名称 | 描述 | -| -------- | -------- | -| struct  [TRANSIENT_TASK_MAX_NUM](_transient_task.md#transient_task_max_num) | 同一时刻最大短时任务数量。 | - - -### 结构体 - -| 名称 | 描述 | -| -------- | -------- | -| struct  [TransientTask_DelaySuspendInfo](_transient_task___delay_suspend_info.md) | 定义短时任务返回信息结构体。 | -| struct  [TransientTask_TransientTaskInfo](_transient_task___transient_task_info.md) | 定义短时任务返回信息结构体。 | - - -### 类型定义 - -| 名称 | 描述 | -| -------- | -------- | -| typedef enum [TransientTask_ErrorCode](_transient_task.md#transienttask_errorcode) [TransientTask_ErrorCode](_transient_task.md#transienttask_errorcode) | 定义短时任务错误码。 | -| typedef struct [TransientTask_DelaySuspendInfo](_transient_task___delay_suspend_info.md) [TransientTask_DelaySuspendInfo](_transient_task.md#transienttask_delaysuspendinfo) | 定义短时任务返回信息结构体。 | -| typedef void(\* [TransientTask_Callback](_transient_task.md#transienttask_callback)) (void) | 定义短时任务超时回调类型。 | -| typedef struct [TransientTask_TransientTaskInfo](_transient_task___transient_task_info.md) [TransientTask_TransientTaskInfo](_transient_task.md#transienttask_transienttaskinfo) | 定义所有短时任务信息结构体。 | - - -### 枚举 - -| 名称 | 描述 | -| -------- | -------- | -| [TransientTask_ErrorCode](_transient_task.md#transienttask_errorcode) {
[ERR_TRANSIENT_TASK_OK](_transient_task.md) = 0, [ERR_TRANSIENT_TASK_INVALID_PARAM](_transient_task.md) = 401, [ERR_TRANSIENT_TASK_PARCEL_FAILED](_transient_task.md) = 9800002, [ERR_TRANSIENT_TASK_TRANSACTION_FAILED](_transient_task.md) = 9800003,
[ERR_TRANSIENT_TASK_SYS_NOT_READY](_transient_task.md) = 9800004, [ERR_TRANSIENT_TASK_CLIENT_INFO_VERIFICATION_FAILED](_transient_task.md) = 9900001, [ERR_TRANSIENT_TASK_SERVICE_VERIFICATION_FAILED](_transient_task.md) = 9900002, [ERR_TRANSIENT_TASK_PARCELABLE_FAILED](_transient_task.md) = 9900003, [ERR_TRANSIENT_TASK_SERVICE_NOT_READY](_transient_task.md) = 9900004
} | 定义短时任务错误码。 | -- Gitee From c147b915210656fe25d7b7b4f5768e4eb616be39 Mon Sep 17 00:00:00 2001 From: pdf001 <1626385780@qq.com> Date: Fri, 4 Jul 2025 06:04:16 +0000 Subject: [PATCH 6/9] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E5=A4=B4=E6=96=87?= =?UTF-8?q?=E4=BB=B6=E3=80=90transient=5Ftask=5Fapi.h=E3=80=91=20Signed-of?= =?UTF-8?q?f-by:=20pdf001=20<1626385780@qq.com>?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../capi-transient-task-api-h.md | 139 ++++++++++++++++++ .../transient__task__api_8h.md | 27 ---- 2 files changed, 139 insertions(+), 27 deletions(-) create mode 100644 zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-transient-task-api-h.md delete mode 100644 zh-cn/application-dev/reference/apis-backgroundtasks-kit/transient__task__api_8h.md diff --git a/zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-transient-task-api-h.md b/zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-transient-task-api-h.md new file mode 100644 index 00000000000..d9662920465 --- /dev/null +++ b/zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-transient-task-api-h.md @@ -0,0 +1,139 @@ +# transient_task_api.h + +## 概述 + +提供短时任务申请、查询、取消功能。 + +**引用文件：** + +**库：** libtransient_task.so + +**系统能力：** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask + +**起始版本：** 13 + +**相关模块：** [TransientTask](capi-transienttask.md) + +## 汇总 + +### 函数 + +| 名称 | 描述 | +| -- | -- | +| [int32_t OH_BackgroundTaskManager_RequestSuspendDelay(const char* reason,TransientTask_Callback callback, TransientTask_DelaySuspendInfo *info)](#oh_backgroundtaskmanager_requestsuspenddelay) | 申请短时任务。 | +| [int32_t OH_BackgroundTaskManager_GetRemainingDelayTime(int32_t requestId, int32_t *delayTime)](#oh_backgroundtaskmanager_getremainingdelaytime) | 获取本次短时任务的剩余时间。 | +| [int32_t OH_BackgroundTaskManager_CancelSuspendDelay(int32_t requestId)](#oh_backgroundtaskmanager_cancelsuspenddelay) | 取消短时任务。 | +| [int32_t OH_BackgroundTaskManager_GetTransientTaskInfo(TransientTask_TransientTaskInfo *transientTaskInfo)](#oh_backgroundtaskmanager_gettransienttaskinfo) | 获取所有短时任务信息，如当日剩余总配额等。 | + +## 函数说明 + +### OH_BackgroundTaskManager_RequestSuspendDelay() + +``` +int32_t OH_BackgroundTaskManager_RequestSuspendDelay(const char* reason,TransientTask_Callback callback, TransientTask_DelaySuspendInfo *info) +``` + +**描述** + +申请短时任务。 + +**系统能力：** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask + +**起始版本：** 13 + + +**参数：** + +| 参数项 | 描述 | +|----------------------------------------------------------------------------------------------| -- | +| const char* reason | 申请短时任务的原因。 | +| [TransientTask_Callback](capi-transient-task-type-h.md#transienttask_callback) callback | 短时任务即将超时的回调，一般在超时前6秒，通过此回调通知应用。 | +| [TransientTask_DelaySuspendInfo](capi-transienttask-transienttask-delaysuspendinfo.md) *info | 返回短时任务信息。 | + +**返回：** + +| 类型 | 说明 | +| -- | -- | +| int32_t | 返回0，表示申请成功。
返回401，表示入参错误。
返回9800002，表示Parcel读写操作失败。
返回9800003，表示IPC通信失败。
返回9800004，表示系统服务失败。
返回9900001，表示短时任务客户端信息校验失败。
返回9900002，表示短时任务服务端校验失败。
错误码的具体信息请参考[TransientTask_ErrorCode](capi-transient-task-type-h.md#transienttask_errorcode)。 | + +### OH_BackgroundTaskManager_GetRemainingDelayTime() + +``` +int32_t OH_BackgroundTaskManager_GetRemainingDelayTime(int32_t requestId, int32_t *delayTime) +``` + +**描述** + +获取本次短时任务的剩余时间。 + +**系统能力：** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask + +**起始版本：** 13 + + +**参数：** + +| 参数项 | 描述 | +| -- | -- | +| int32_t requestId | 短时任务的请求ID。 | +| int32_t *delayTime | 短时任务的剩余时间。 | + +**返回：** + +| 类型 | 说明 | +| -- | -- | +| int32_t | 返回0，表示查询成功。
返回401，表示入参错误。
返回9800002，表示Parcel读写操作失败。
返回9800003，表示IPC通信失败。
返回9800004，表示系统服务失败。
返回9900001，表示短时任务客户端信息校验失败。
返回9900002，表示短时任务服务端校验失败。
错误码的具体信息请参考[TransientTask_ErrorCode](capi-transient-task-type-h.md#transienttask_errorcode)。 | + +### OH_BackgroundTaskManager_CancelSuspendDelay() + +``` +int32_t OH_BackgroundTaskManager_CancelSuspendDelay(int32_t requestId) +``` + +**描述** + +取消短时任务。 + +**系统能力：** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask + +**起始版本：** 13 + + +**参数：** + +| 参数项 | 描述 | +| -- | -- | +| int32_t requestId | 短时任务的请求ID。 | + +**返回：** + +| 类型 | 说明 | +| -- | -- | +| int32_t | 返回0，表示取消成功。
返回401，表示入参错误。
返回9800002，表示Parcel读写操作失败。
返回9800003，表示IPC通信失败。
返回9800004，表示系统服务失败。
返回9900001，表示短时任务客户端信息校验失败。
返回9900002，表示短时任务服务端校验失败。
错误码的具体信息请参考[TransientTask_ErrorCode](capi-transient-task-type-h.md#transienttask_errorcode)。 | + +### OH_BackgroundTaskManager_GetTransientTaskInfo() + +``` +int32_t OH_BackgroundTaskManager_GetTransientTaskInfo(TransientTask_TransientTaskInfo *transientTaskInfo) +``` + +**描述** + +获取所有短时任务信息，如当日剩余总配额等。 + +**起始版本：** 20 + + +**参数：** + +| 参数项 | 描述 | +|--------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------| +| [TransientTask_TransientTaskInfo ](capi-transienttask-transienttask-transienttaskinfo.md) *transientTaskInfo | 所有短时任务信息，具体请参考[TransientTask_TransientTaskInfo](capi-transienttask-transienttask-transienttaskinfo.md)。 | + +**返回：** + +| 类型 | 说明 | +| -- | -- | +| int32_t | 返回0，表示获取成功。
返回9900001，表示短时任务客户端信息校验失败。
返回9900003，表示Parcel读写操作失败。
返回9900004，表示系统服务失败。
错误码的具体信息请参考[TransientTask_ErrorCode](capi-transient-task-type-h.md#transienttask_errorcode)。 | + + diff --git a/zh-cn/application-dev/reference/apis-backgroundtasks-kit/transient__task__api_8h.md b/zh-cn/application-dev/reference/apis-backgroundtasks-kit/transient__task__api_8h.md deleted file mode 100644 index d3e14344d56..00000000000 --- a/zh-cn/application-dev/reference/apis-backgroundtasks-kit/transient__task__api_8h.md +++ /dev/null @@ -1,27 +0,0 @@ -# transient_task_api.h - - -## 概述 - -提供短时任务申请、查询、取消功能。 - -**库：** libtransient_task.so - -**系统能力：** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask - -**起始版本：** 13 - -**相关模块：**[TransientTask](_transient_task.md) - - -## 汇总 - - -### 函数 - -| 名称 | 描述 | -| -------- | -------- | -| int32_t [OH_BackgroundTaskManager_RequestSuspendDelay](_transient_task.md#oh_backgroundtaskmanager_requestsuspenddelay) (const char \*reason, [TransientTask_Callback](_transient_task.md#transienttask_callback) callback, [TransientTask_DelaySuspendInfo](_transient_task___delay_suspend_info.md) \*info) | 申请短时任务。 | -| int32_t [OH_BackgroundTaskManager_GetRemainingDelayTime](_transient_task.md#oh_backgroundtaskmanager_getremainingdelaytime) (int32_t requestId, int32_t \*delayTime) | 获取本次短时任务的剩余时间。 | -| int32_t [OH_BackgroundTaskManager_CancelSuspendDelay](_transient_task.md#oh_backgroundtaskmanager_cancelsuspenddelay) (int32_t requestId) | 取消短时任务。 | -| int32_t [OH_BackgroundTaskManager_GetTransientTaskInfo](_transient_task.md#oh_backgroundtaskmanager_gettransienttaskinfo) ([TransientTask_TransientTaskInfo](_transient_task.md#transienttask_transienttaskinfo) \*transientTaskInfo) | 获取所有短时任务信息。 | \ No newline at end of file -- Gitee From 9378c8472b1dd4fabbda1031a3f4051fe4e1ef27 Mon Sep 17 00:00:00 2001 From: pdf001 <1626385780@qq.com> Date: Fri, 4 Jul 2025 06:02:38 +0000 Subject: [PATCH 7/9] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E6=A8=A1=E5=9D=97?= =?UTF-8?q?=E3=80=90BackgroundProcessManager=E3=80=91=20Signed-off-by:=20p?= =?UTF-8?q?df001=20<1626385780@qq.com>?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../_background_process_manager.md | 155 ------------------ .../capi-backgroundprocessmanager.md | 12 ++ 2 files changed, 12 insertions(+), 155 deletions(-) delete mode 100644 zh-cn/application-dev/reference/apis-backgroundtasks-kit/_background_process_manager.md create mode 100644 zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-backgroundprocessmanager.md diff --git a/zh-cn/application-dev/reference/apis-backgroundtasks-kit/_background_process_manager.md b/zh-cn/application-dev/reference/apis-backgroundtasks-kit/_background_process_manager.md deleted file mode 100644 index 63a69455ffb..00000000000 --- a/zh-cn/application-dev/reference/apis-backgroundtasks-kit/_background_process_manager.md +++ /dev/null @@ -1,155 +0,0 @@ -# BackgroundProcessManager - - -## 概述 - -提供后台子进程调度策略管控C接口。 - -**起始版本：** 17 - - -## 汇总 - - -### 文件 - -| 名称 | 描述 | -| -------- | -------- | -| [background_process_manager.h](background__process__manager_8h.md) | 本模块提供了后台子进程管控接口。开发者可以通过本模块接口对子进程进行压制、解压制，避免子进程过多占用系统资源，导致系统使用卡顿。 本模块接口仅对通过[OH_Ability_StartNativeChildProcess](../apis-ability-kit/c-apis-ability-childprocess.md#oh_ability_startnativechildprocess)接口创建的子进程生效。 | - - -### 类型定义 - -| 名称 | 描述 | -| -------- | -------- | -| typedef enum [BackgroundProcessManager_ProcessPriority](#backgroundprocessmanager_processpriority) [BackgroundProcessManager_ProcessPriority](#backgroundprocessmanager_processpriority) | 子进程压制档位。 | -| typedef enum [BackgroundProcessManager_ErrorCode](#backgroundprocessmanager_errorcode) [BackgroundProcessManager_ErrorCode](#backgroundprocessmanager_errorcode) | 定义后台子进程管控错误码。 | - - -### 枚举 - -| 名称 | 描述 | -| -------- | -------- | -| [BackgroundProcessManager_ProcessPriority](#backgroundprocessmanager_processpriority) { PROCESS_BACKGROUND = 1, PROCESS_INACTIVE = 2 } | 子进程压制档位。 | -| [BackgroundProcessManager_ErrorCode](#backgroundprocessmanager_errorcode) { ERR_BACKGROUND_PROCESS_MANAGER_SUCCESS = 0, ERR_BACKGROUND_PROCESS_MANAGER_INVALID_PARAM = 401, ERR_BACKGROUND_PROCESS_MANAGER_REMOTE_ERROR = 31800001 } | 定义后台子进程管控错误码。 | - - -### 函数 - -| 名称 | 描述 | -| -------- | -------- | -| int [OH_BackgroundProcessManager_SetProcessPriority](#oh_backgroundprocessmanager_setprocesspriority) (int pid, [BackgroundProcessManager_ProcessPriority](#backgroundprocessmanager_processpriority) priority) | 设置子进程的压制档位，子进程被压制后可获得的CPU资源将会受到限制。如果主进程调度策略发生变化，如从后台切至前台等，子进程会跟随主进程一同变化，子进程如需继续压制，需要重新调用本接口。 | -| int [OH_BackgroundProcessManager_ResetProcessPriority](#oh_backgroundprocessmanager_resetprocesspriority) (int pid) | 为子进程解压制，即子进程策略恢复为主进程调度策略。若主进程调度策略发生变化，如从后台切至前台等，子进程会跟随主进程一同变化，等效于执行一次resetProcessPriority动作。 | - - -## 类型定义说明 - - -### BackgroundProcessManager_ErrorCode - -``` -typedef enum BackgroundProcessManager_ErrorCodeBackgroundProcessManager_ErrorCode -``` -**描述** - -定义后台子进程管控错误码。 - -**起始版本：** 17 - - -### BackgroundProcessManager_ProcessPriority - -``` -typedef enum BackgroundProcessManager_ProcessPriorityBackgroundProcessManager_ProcessPriority -``` -**描述** - -子进程压制档位。 - -**起始版本：** 17 - - -## 枚举类型说明 - - -### BackgroundProcessManager_ErrorCode - -``` -enum BackgroundProcessManager_ErrorCode -``` -**描述** - -定义后台子进程管控错误码。 - -**起始版本：** 17 - -| 枚举值 | 描述 | -| -------- | -------- | -| ERR_BACKGROUND_PROCESS_MANAGER_SUCCESS | 压制参数发送成功。 | -| ERR_BACKGROUND_PROCESS_MANAGER_INVALID_PARAM | 参数检查失败。 | -| ERR_BACKGROUND_PROCESS_MANAGER_REMOTE_ERROR | 客户端进程请求系统服务进程，获取系统服务操作失败。 | - - -### BackgroundProcessManager_ProcessPriority - -``` -enum BackgroundProcessManager_ProcessPriority -``` -**描述** - -子进程压制档位。 - -**起始版本：** 17 - -| 枚举值 | 描述 | -| -------- | -------- | -| PROCESS_BACKGROUND | 该档位相较PROCESS_INACTIVE压制效果更显著，获取到的CPU资源更少。推荐执行处于后台的图文页面等用户无感知业务的后台子进程时设置该档位。   | -| PROCESS_INACTIVE | 推荐正在执行播放音频、导航等用户可感知业务的后台子进程时设置该档位。   | - - -## 函数说明 - - -### OH_BackgroundProcessManager_ResetProcessPriority() - -``` -int OH_BackgroundProcessManager_ResetProcessPriority (int pid) -``` -**描述** - -为子进程解压制，即子进程策略恢复为主进程调度策略。若主进程调度策略发生变化，如从后台切至前台等， 子进程会跟随主进程一同变化，等效于执行一次resetProcessPriority动作。 - -**起始版本：** 17 - -**参数:** - -| 名称 | 描述 | -| -------- | -------- | -| pid | 子进程的进程号，[OH_Ability_StartNativeChildProcess](../apis-ability-kit/c-apis-ability-childprocess.md#oh_ability_startnativechildprocess)接口创建子进程后的pid参数，即为子进程进程号。 | - -**返回：** - -返回执行的错误码。错误码定义详见[BackgroundProcessManager_ErrorCode](#backgroundprocessmanager_errorcode)。返回 ERR_BACKGROUND_PROCESS_MANAGER_SUCCESS，表示压制参数发送成功。 返回 ERR_BACKGROUND_PROCESS_MANAGER_REMOTE_ERROR，表示客户端进程请求系统服务进程，获取系统服务操作失败。 - - -### OH_BackgroundProcessManager_SetProcessPriority() - -``` -int OH_BackgroundProcessManager_SetProcessPriority (int pid, BackgroundProcessManager_ProcessPriority priority ) -``` -**描述** - -设置子进程的压制档位，子进程被压制后可获得的CPU资源将会受到限制。如果主进程调度策略发生变化，如从后台切至前台等，子进程会跟随主进程一同变化，子进程如需继续压制，需要重新调用本接口。 - -**起始版本：** 17 - -**参数:** - -| 名称 | 描述 | -| -------- | -------- | -| pid | 需要被压制子进程的进程号，[OH_Ability_StartNativeChildProcess](../apis-ability-kit/c-apis-ability-childprocess.md#oh_ability_startnativechildprocess)接口创建子进程后的pid参数，即为子进程进程号。 | -| priority | 压制档位。 | - -**返回：** - -返回执行的错误码。错误码定义详见[BackgroundProcessManager_ErrorCode](#backgroundprocessmanager_errorcode)。返回 ERR_BACKGROUND_PROCESS_MANAGER_SUCCESS，表示压制参数发送成功。 返回 ERR_BACKGROUND_PROCESS_MANAGER_INVALID_PARAM，表示参数检查失败。 返回 ERR_BACKGROUND_PROCESS_MANAGER_REMOTE_ERROR，表示客户端进程请求系统服务进程，获取系统服务操作失败。 diff --git a/zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-backgroundprocessmanager.md b/zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-backgroundprocessmanager.md new file mode 100644 index 00000000000..4932328954a --- /dev/null +++ b/zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-backgroundprocessmanager.md @@ -0,0 +1,12 @@ +# BackgroundProcessManager + +## 概述 + +提供后台子进程调度策略管控C接口。 + +**起始版本：** 17 +## 文件汇总 + +| 名称 | 描述 | +| -- | -- | +| [background_process_manager.h](capi-background-process-manager-h.md) | 本模块提供了后台子进程管控接口。开发者可以通过本模块接口对子进程进行压制、解压制，避免子进程过多占用系统资源，导致系统使用卡顿。本模块接口仅对通过OH_Ability_StartNativeChildProcess接口创建的子进程生效。 | -- Gitee From 77ac52f630b3d44345fc059f2fc4c173ce55cd6f Mon Sep 17 00:00:00 2001 From: pdf001 <1626385780@qq.com> Date: Fri, 4 Jul 2025 06:01:11 +0000 Subject: [PATCH 8/9] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E6=A8=A1=E5=9D=97?= =?UTF-8?q?=E3=80=90TransientTask=E3=80=91=20Signed-off-by:=20pdf001=20<16?= =?UTF-8?q?26385780@qq.com>?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../_transient_task.md | 238 ------------------ .../capi-transienttask.md | 13 + 2 files changed, 13 insertions(+), 238 deletions(-) delete mode 100644 zh-cn/application-dev/reference/apis-backgroundtasks-kit/_transient_task.md create mode 100644 zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-transienttask.md diff --git a/zh-cn/application-dev/reference/apis-backgroundtasks-kit/_transient_task.md b/zh-cn/application-dev/reference/apis-backgroundtasks-kit/_transient_task.md deleted file mode 100644 index 7de9ec4c8c1..00000000000 --- a/zh-cn/application-dev/reference/apis-backgroundtasks-kit/_transient_task.md +++ /dev/null @@ -1,238 +0,0 @@ -# TransientTask - -## 概述 - -提供短时任务C接口。 - -**起始版本：** 13 - -## 汇总 - - -### 文件 - -| 名称 | 描述 | -| -------- | -------- | -| [transient_task_api.h](transient__task__api_8h.md) | 提供短时任务申请、查询、取消功能。 | -| [transient_task_type.h](transient__task__type_8h.md) | 定义短时任务的错误码和结构体。 | - - -### 结构体 - -| 名称 | 描述 | -| -------- | -------- | -| struct  [TransientTask_DelaySuspendInfo](_transient_task___delay_suspend_info.md) | 定义短时任务返回信息结构体。 | -| struct  [TransientTask_TransientTaskInfo](_transient_task___transient_task_info.md) | 定义所有短时任务信息结构体。 | - - -### 类型定义 - -| 名称 | 描述 | -| -------- | -------- | -| typedef enum [TransientTask_ErrorCode](#transienttask_errorcode) [TransientTask_ErrorCode](#transienttask_errorcode) | 定义短时任务错误码。 | -| typedef struct [TransientTask_DelaySuspendInfo](_transient_task___delay_suspend_info.md) [TransientTask_DelaySuspendInfo](_transient_task___delay_suspend_info.md)| 定义短时任务返回信息结构体。 | -| typedef void(\* [TransientTask_Callback](#transienttask_callback)) (void) | 定义短时任务超时回调类型。 | -| typedef struct [TransientTask_TransientTaskInfo](_transient_task___transient_task_info.md) [TransientTask_TransientTaskInfo](_transient_task___transient_task_info.md)| 定义所有短时任务信息结构体。 | - - -### 枚举 - -| 名称 | 描述 | -| -------- | -------- | -| [TransientTask_ErrorCode](#transienttask_errorcode) {
ERR_TRANSIENT_TASK_OK = 0, ERR_TRANSIENT_TASK_INVALID_PARAM = 401, ERR_TRANSIENT_TASK_PARCEL_FAILED = 9800002, ERR_TRANSIENT_TASK_TRANSACTION_FAILED = 9800003,
ERR_TRANSIENT_TASK_SYS_NOT_READY = 9800004, ERR_TRANSIENT_TASK_CLIENT_INFO_VERIFICATION_FAILED = 9900001, ERR_TRANSIENT_TASK_SERVICE_VERIFICATION_FAILED = 9900002, ERR_TRANSIENT_TASK_PARCELABLE_FAILED = 9900003, ERR_TRANSIENT_TASK_SERVICE_NOT_READY = 9900004
} | 定义短时任务错误码。 | - - -### 函数 - -| 名称 | 描述 | -| -------- | -------- | -| int32_t [OH_BackgroundTaskManager_RequestSuspendDelay](#oh_backgroundtaskmanager_requestsuspenddelay) (const char \*reason, [TransientTask_Callback](#transienttask_callback) callback, [TransientTask_DelaySuspendInfo](_transient_task___delay_suspend_info.md) \*info) | 申请短时任务。 | -| int32_t [OH_BackgroundTaskManager_GetRemainingDelayTime](#oh_backgroundtaskmanager_getremainingdelaytime) (int32_t requestId, int32_t \*delayTime) | 获取本次短时任务的剩余时间。 | -| int32_t [OH_BackgroundTaskManager_CancelSuspendDelay](#oh_backgroundtaskmanager_cancelsuspenddelay) (int32_t requestId) | 取消短时任务。 | -| int32_t [OH_BackgroundTaskManager_GetTransientTaskInfo](#oh_backgroundtaskmanager_gettransienttaskinfo) ([TransientTask_TransientTaskInfo](_transient_task___transient_task_info.md) \*transientTaskInfo) - -## 宏定义说明 - -### TRANSIENT_TASK_MAX_NUM - -``` -#define TRANSIENT_TASK_MAX_NUM 3 -``` -**描述** - -同一时刻最大短时任务数量。 - -**起始版本：** 20 - -## 类型定义说明 - - -### TransientTask_Callback - -``` -typedef void(* TransientTask_Callback) (void) -``` -**描述** -定义短时任务超时回调类型。 - -**起始版本：** 13 - - -### TransientTask_DelaySuspendInfo - -``` -typedef struct TransientTask_DelaySuspendInfo TransientTask_DelaySuspendInfo -``` -**描述** -定义短时任务返回信息结构体。 - -**起始版本：** 13 - - -### TransientTask_ErrorCode - -``` -typedef enum TransientTask_ErrorCode TransientTask_ErrorCode -``` -**描述** -定义短时任务错误码。 - -**起始版本：** 13 - - -### TransientTask_TransientTaskInfo - -``` -typedef struct TransientTask_TransientTaskInfo TransientTask_TransientTaskInfo -``` -**描述** - - -定义所有短时任务返回信息结构体。 - -**起始版本**： 20 - - -## 枚举类型说明 - - -### TransientTask_ErrorCode - -``` -enum TransientTask_ErrorCode -``` -**描述** -定义短时任务错误码。 - -**起始版本：** 13 - -| 枚举值 | 描述 | -| -------- | -------- | -| ERR_TRANSIENT_TASK_OK | \@error 成功。   | -| ERR_TRANSIENT_TASK_INVALID_PARAM | \@error 参数检查失败。可能原因：1.必选参数没有传入。2.参数类型错误。   | -| ERR_TRANSIENT_TASK_PARCEL_FAILED | \@error Parcel读写操作失败。   | -| ERR_TRANSIENT_TASK_TRANSACTION_FAILED | \@error IPC通信失败。   | -| ERR_TRANSIENT_TASK_SYS_NOT_READY | \@error 系统服务失败。   | -| ERR_TRANSIENT_TASK_CLIENT_INFO_VERIFICATION_FAILED | \@error 短时任务客户端信息校验失败。   | -| ERR_TRANSIENT_TASK_SERVICE_VERIFICATION_FAILED | \@error 短时任务服务端校验失败。   | -| ERR_TRANSIENT_TASK_PARCELABLE_FAILED | \@error 短时任务Parcel读写操作失败。可能原因：1.参数非法。2.申请内存失败。   | -| ERR_TRANSIENT_TASK_SERVICE_NOT_READY | \@error 短时任务系统服务失败。   | - - -## 函数说明 - - -### OH_BackgroundTaskManager_CancelSuspendDelay() - -``` -int32_t OH_BackgroundTaskManager_CancelSuspendDelay (int32_t requestId) -``` -**描述** -取消短时任务。 - -**系统能力：** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask - -**起始版本：** 13 - -**参数:** - -| 名称 | 描述 | -| -------- | -------- | -| requestId | 短时任务的请求ID。 | - -**返回：** - -返回0，表示取消成功。
返回401，表示入参错误。
返回9800002，表示Parcel读写操作失败。
返回9800003，表示IPC通信失败。
返回9800004，表示系统服务失败。
返回9900001，表示短时任务客户端信息校验失败。
返回9900002，表示短时任务服务端校验失败。
错误码的具体信息请参考[TransientTask_ErrorCode](#transienttask_errorcode)。 - - -### OH_BackgroundTaskManager_GetRemainingDelayTime() - -``` -int32_t OH_BackgroundTaskManager_GetRemainingDelayTime (int32_t requestId, int32_t * delayTime ) -``` -**描述** -获取本次短时任务的剩余时间。 - -**系统能力：** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask - -**起始版本：** 13 - -**参数:** - -| 名称 | 描述 | -| -------- | -------- | -| requestId | 短时任务的请求ID。 | -| delayTime | 短时任务的剩余时间。 | - -**返回：** - -返回0，表示查询成功。
返回401，表示入参错误。
返回9800002，表示Parcel读写操作失败。
返回9800003，表示IPC通信失败。
返回9800004，表示系统服务失败。
返回9900001，表示短时任务客户端信息校验失败。
返回9900002，表示短时任务服务端校验失败。
错误码的具体信息请参考[TransientTask_ErrorCode](#transienttask_errorcode)。 - - -### OH_BackgroundTaskManager_RequestSuspendDelay() - -``` -int32_t OH_BackgroundTaskManager_RequestSuspendDelay (const char * reason, TransientTask_Callback callback, TransientTask_DelaySuspendInfo * info ) -``` -**描述** -申请短时任务。 - -**系统能力：** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask - -**起始版本：** 13 - -**参数:** - -| 名称 | 描述 | -| -------- | -------- | -| reason | 申请短时任务的原因。 | -| callback | 短时任务即将超时的回调，一般在超时前6秒，通过此回调通知应用。 | -| info | 返回短时任务信息。 | - -**返回：** - -返回0，表示申请成功。
返回401，表示入参错误。
返回9800002，表示Parcel读写操作失败。
返回9800003，表示IPC通信失败。
返回9800004，表示系统服务失败。
返回9900001，表示短时任务客户端信息校验失败。
返回9900002，表示短时任务服务端校验失败。
错误码的具体信息请参考[TransientTask_ErrorCode](#transienttask_errorcode)。 - - -### OH_BackgroundTaskManager_GetTransientTaskInfo() - -``` -int32_t OH_BackgroundTaskManager_GetTransientTaskInfo (TransientTask_TransientTaskInfo *transientTaskInfo) -``` -**描述** - -获取所有短时任务信息，如当日剩余总配额等。 - -**系统能力：** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask - -**起始版本：** 20 - -**参数：** - -| 名称 | 描述 | -| -------- |-------------| -| transientTaskInfo | 返回所有短时任务信息，具体请参考[TransientTask_TransientTaskInfo](_transient_task___transient_task_info.md)。 | - -**返回：** - -返回0，表示申请成功。
返回9900001，表示短时任务客户端信息校验失败。
返回9900003，表示短时任务Parcel读写操作失败。
返回9900004，表示短时任务系统服务失败。
错误码的具体信息请参考[TransientTask_ErrorCode](#transienttask_errorcode)。 \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-transienttask.md b/zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-transienttask.md new file mode 100644 index 00000000000..478c6c16f66 --- /dev/null +++ b/zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-transienttask.md @@ -0,0 +1,13 @@ +# TransientTask + +## 概述 + +提供短时任务C接口。 + +**起始版本：** 13 +## 文件汇总 + +| 名称 | 描述 | +| -- | -- | +| [transient_task_api.h](capi-transient-task-api-h.md) | 提供短时任务申请、查询、取消功能。 | +| [transient_task_type.h](capi-transient-task-type-h.md) | 定义短时任务的错误码和结构体。 | -- Gitee From 380a6172ccc0899ea555e82a42045c2189bfdd5f Mon Sep 17 00:00:00 2001 From: pdf001 <1626385780@qq.com> Date: Fri, 4 Jul 2025 07:37:11 +0000 Subject: [PATCH 9/9] =?UTF-8?q?=E6=B7=BB=E5=8A=A0=E5=B8=B8=E9=87=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: pdf001 <1626385780@qq.com> --- ...transienttask-transienttask-transienttaskinfo.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-transienttask-transienttask-transienttaskinfo.md b/zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-transienttask-transienttask-transienttaskinfo.md index 23302a5f37f..b12ba0ceea0 100644 --- a/zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-transienttask-transienttask-transienttaskinfo.md +++ b/zh-cn/application-dev/reference/apis-backgroundtasks-kit/capi-transienttask-transienttask-transienttaskinfo.md @@ -17,6 +17,17 @@ | 名称 | 描述 | |-------------------------------------------------------------------------------------------------------------------------------| -- | | int32_t remainingQuota | 当日剩余总配额。单位：毫秒。 | -| [TransientTask_DelaySuspendInfo](capi-transienttask-transienttask-delaysuspendinfo.md) transientTasks[TRANSIENT_TASK_MAX_NUM] | 已申请的所有短时任务信息。包括短时任务请求ID、剩余时间（单位：毫秒）。 | +| [TransientTask_DelaySuspendInfo](capi-transienttask-transienttask-delaysuspendinfo.md) transientTasks [TRANSIENT_TASK_MAX_NUM](#transient_task_max_num) | 已申请的所有短时任务信息。包括短时任务请求ID、剩余时间（单位：毫秒）。 | +## 宏定义说明 +### TRANSIENT_TASK_MAX_NUM + +``` +#define TRANSIENT_TASK_MAX_NUM 3 +``` +**描述** + +同一时刻最大短时任务数量。 + +**起始版本：** 20 -- Gitee