diff --git a/README.cn.md b/README.cn.md new file mode 100644 index 0000000000000000000000000000000000000000..53f4712fe8ac8962fc7259abab2828d24b598431 --- /dev/null +++ b/README.cn.md @@ -0,0 +1,64 @@ +# 延迟任务调度 + +- [简介](#section11660541593) +- [目录](#section161941989596) +- [延迟任务调度](#section1312121216216) + - [接口说明](#section114564657874) + - [使用说明](#section129654513264) + - [延迟任务调度使用约束](#section1551164914237) + +- [相关仓](#section1371113476307) + +## 简介 + +在资源调度子系统中，延迟任务调度部件，给应用提供了一个机制，用以执行对实时性要求低的任务。当满足设定条件时，会被放入可执行队列，系统根据设备情况，延迟触发可执行队列内的任务。 + +## 目录 + +``` + +├── frameworks # 接口实现 +├── interfaces +│ ├── innerkits # 对内接口目录 +│ └── kits # 对外接口目录 +├── sa_profile # 组件服务配置 +├── services # 组件服务实现 +└── utils # 组件工具实现 + +``` +## 延迟任务调度 + +### 接口说明 + +接口名 | 接口描述 +---------------------------------------------------------|----------------------------------------- +function startWork(work: WorkInfo): boolean; | 延迟调度任务申请 +function stopWork(work: WorkInfo, needCancel?: boolean): boolean; | 延迟调度任务取消 +function getWorkStatus(workId: number, callback: AsyncCallback): void;| 获取延迟调度任务状态（Callback形式） +function getWorkStatus(workId: number): Promise; | 获取延迟调度任务状态（Promise形式） +function obtainAllWorks(callback: AsyncCallback): Array;| 获取所有延迟调度任务（Callback形式） +function obtainAllWorks(): Promise>;| 获取所有延迟调度任务（Promise形式） +function stopAndClearWorks(): boolean;| 停止并清除任务 +function isLastWorkTimeOut(workId: number, callback: AsyncCallback): boolean;| 获取上次任务是否超时（Callback形式） +function isLastWorkTimeOut(workId: number): Promise;| 获取上次任务是否超时（Promise形式） + +### 使用说明 +应用要执行实时性不高的任务的时，可以使用延迟调度任务，该机制在满足应用设定条件的时候，会根据系统当前的状态，如内存、功耗、热等统一决策调度时间。 + +#### 延迟调度任务使用约束 + +延迟调度任务的使用需要遵从如下约束和规则： + +- **超时**：每次最长运行120s。 + +## 相关仓 + +资源调度子系统 + +**work\_scheduler** + +notification_ces_standard + +appexecfwk_standard + +powermgr_battery_manager \ No newline at end of file diff --git a/README.en.md b/README.en.md deleted file mode 100644 index 79441b64fc662a3fcca4d47f20400518f379c055..0000000000000000000000000000000000000000 --- a/README.en.md +++ /dev/null @@ -1,65 +0,0 @@ -# Work Scheduler - -- [Introduction](#section11660541593) -- [Directory Structure](#section161941989596) -- [Work Scheduler](#section1312121216216) - - [Available APIs](#section114564657874) - - [Usage Guidelines](#section129654513264) - - [Restrictions on Using Work Scheduler](#section1551164914237) - -- [Repositories Involved](#section1371113476307) - -## Introduction - -In the resource scheduling subsystem, the work scheduler component provides a mechanism for applications to perform tasks that require low real-time performance. When the set conditions are met, it will be put into the executable queue, and the system will delay triggering tasks in the executable queue according to the equipment situation. - -## Directory Structure - -``` - -├── frameworks # Frameworks -├── interfaces -│ ├── innerkits # Internal APIs -│ └── kits # External APIs -├── sa_profile # SA profile -├── services # Services -└── utils # Utilities - -``` -## Work Scheduler - -### Available APIs - -API | Description ----------------------------------------------------------|----------------------------------------- -function startWork(work: WorkInfo): boolean; | work scheduler application -function stopWork(work: WorkInfo, needCancel?: boolean): boolean; | work scheduler cancel -function getWorkStatus(workId: number, callback: AsyncCallback): void;| get the status of work（Callback form） -function getWorkStatus(workId: number): Promise; | get the status of work（Promise form） -function obtainAllWorks(callback: AsyncCallback): Array;| get all works（Callback form） -function obtainAllWorks(): Promise>;| get all works（Promise form） -function stopAndClearWorks(): boolean;| stop and clear work -function isLastWorkTimeOut(workId: number, callback: AsyncCallback): boolean;| Get whether the last task has timed out（Callback form） -function isLastWorkTimeOut(workId: number): Promise;| Get whether the last task has timed out（Promise form） - -### Usage Guidelines - -When an application needs to perform tasks with low real-time performance, work scheduler can be used. When the conditions set by the application are met, the mechanism will make a unified decision and scheduling time based on the current state of the system, such as memory, power consumption, and heat. - -#### Restrictions on Using Work Scheduler - -Adhere to the following constraints and rules when using work scheduler: - -- **Timeout**：The longest running time is 120s each time. - -## Repositories Involved - -Resource Schedule subsystem - -**work\_scheduler** - -notification_ces_standard - -appexecfwk_standard - -powermgr_battery_manager \ No newline at end of file diff --git a/README.md b/README.md index 53f4712fe8ac8962fc7259abab2828d24b598431..79441b64fc662a3fcca4d47f20400518f379c055 100644 --- a/README.md +++ b/README.md @@ -1,64 +1,65 @@ -# 延迟任务调度 - -- [简介](#section11660541593) -- [目录](#section161941989596) -- [延迟任务调度](#section1312121216216) - - [接口说明](#section114564657874) - - [使用说明](#section129654513264) - - [延迟任务调度使用约束](#section1551164914237) - -- [相关仓](#section1371113476307) - -## 简介 - -在资源调度子系统中，延迟任务调度部件，给应用提供了一个机制，用以执行对实时性要求低的任务。当满足设定条件时，会被放入可执行队列，系统根据设备情况，延迟触发可执行队列内的任务。 - -## 目录 - -``` - -├── frameworks # 接口实现 -├── interfaces -│ ├── innerkits # 对内接口目录 -│ └── kits # 对外接口目录 -├── sa_profile # 组件服务配置 -├── services # 组件服务实现 -└── utils # 组件工具实现 - -``` -## 延迟任务调度 - -### 接口说明 - -接口名 | 接口描述 ----------------------------------------------------------|----------------------------------------- -function startWork(work: WorkInfo): boolean; | 延迟调度任务申请 -function stopWork(work: WorkInfo, needCancel?: boolean): boolean; | 延迟调度任务取消 -function getWorkStatus(workId: number, callback: AsyncCallback): void;| 获取延迟调度任务状态（Callback形式） -function getWorkStatus(workId: number): Promise; | 获取延迟调度任务状态（Promise形式） -function obtainAllWorks(callback: AsyncCallback): Array;| 获取所有延迟调度任务（Callback形式） -function obtainAllWorks(): Promise>;| 获取所有延迟调度任务（Promise形式） -function stopAndClearWorks(): boolean;| 停止并清除任务 -function isLastWorkTimeOut(workId: number, callback: AsyncCallback): boolean;| 获取上次任务是否超时（Callback形式） -function isLastWorkTimeOut(workId: number): Promise;| 获取上次任务是否超时（Promise形式） - -### 使用说明 -应用要执行实时性不高的任务的时，可以使用延迟调度任务，该机制在满足应用设定条件的时候，会根据系统当前的状态，如内存、功耗、热等统一决策调度时间。 - -#### 延迟调度任务使用约束 - -延迟调度任务的使用需要遵从如下约束和规则： - -- **超时**：每次最长运行120s。 - -## 相关仓 - -资源调度子系统 - -**work\_scheduler** - -notification_ces_standard - -appexecfwk_standard - +# Work Scheduler + +- [Introduction](#section11660541593) +- [Directory Structure](#section161941989596) +- [Work Scheduler](#section1312121216216) + - [Available APIs](#section114564657874) + - [Usage Guidelines](#section129654513264) + - [Restrictions on Using Work Scheduler](#section1551164914237) + +- [Repositories Involved](#section1371113476307) + +## Introduction + +In the resource scheduling subsystem, the work scheduler component provides a mechanism for applications to perform tasks that require low real-time performance. When the set conditions are met, it will be put into the executable queue, and the system will delay triggering tasks in the executable queue according to the equipment situation. + +## Directory Structure + +``` + +├── frameworks # Frameworks +├── interfaces +│ ├── innerkits # Internal APIs +│ └── kits # External APIs +├── sa_profile # SA profile +├── services # Services +└── utils # Utilities + +``` +## Work Scheduler + +### Available APIs + +API | Description +---------------------------------------------------------|----------------------------------------- +function startWork(work: WorkInfo): boolean; | work scheduler application +function stopWork(work: WorkInfo, needCancel?: boolean): boolean; | work scheduler cancel +function getWorkStatus(workId: number, callback: AsyncCallback): void;| get the status of work（Callback form） +function getWorkStatus(workId: number): Promise; | get the status of work（Promise form） +function obtainAllWorks(callback: AsyncCallback): Array;| get all works（Callback form） +function obtainAllWorks(): Promise>;| get all works（Promise form） +function stopAndClearWorks(): boolean;| stop and clear work +function isLastWorkTimeOut(workId: number, callback: AsyncCallback): boolean;| Get whether the last task has timed out（Callback form） +function isLastWorkTimeOut(workId: number): Promise;| Get whether the last task has timed out（Promise form） + +### Usage Guidelines + +When an application needs to perform tasks with low real-time performance, work scheduler can be used. When the conditions set by the application are met, the mechanism will make a unified decision and scheduling time based on the current state of the system, such as memory, power consumption, and heat. + +#### Restrictions on Using Work Scheduler + +Adhere to the following constraints and rules when using work scheduler: + +- **Timeout**：The longest running time is 120s each time. + +## Repositories Involved + +Resource Schedule subsystem + +**work\_scheduler** + +notification_ces_standard + +appexecfwk_standard + powermgr_battery_manager \ No newline at end of file