46 Star 173 Fork 4.7K

OpenHarmony/interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.taskpool.d.ts 75.67 KB
一键复制 编辑 原始数据 按行查看 历史
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977
/*
* Copyright (c) 2022 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit ArkTS
*/
/**
* JS cross-thread task executor.
*
* @namespace taskpool
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* JS cross-thread task executor.
*
* @namespace taskpool
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* JS cross-thread task executor.
*
* @namespace taskpool
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
declare namespace taskpool {
/**
* The Priority defines the task priority.
*
* @enum { number } Priority
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The Priority defines the task priority.
*
* @enum { number } Priority
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Enumerates the priorities available for created tasks.
*
* @enum { number } Priority
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
enum Priority {
/**
* set task priority to high.
*
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* set task priority to high.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The task has a high priority.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
HIGH = 0,
/**
* set task priority to medium.
*
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* set task priority to medium.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The task has a medium priority.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
MEDIUM = 1,
/**
* set task priority to low.
*
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* set task priority to low.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The task has a low priority.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
LOW = 2,
/**
* The task is a background task.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
IDLE = 3
}
/**
* Describes a callback function.
*
* @typedef { function } CallbackFunction
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
type CallbackFunction = () => void;
/**
* Describes a callback function with an error message.
*
* @typedef { function } CallbackFunctionWithError
* @param { Error } e - Error message.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
type CallbackFunctionWithError = (e: Error) => void;
/**
* The Task class provides an interface to create a task.
*
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The Task class provides an interface to create a task.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Implements a task. Before calling any APIs in Task, you must use constructor to create a Task instance.
* A task can be executed for multiple times, placed in a task group, serial queue, or asynchronous queue for execution,
* or added with dependencies for execution.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
class Task {
/**
* Create a Task instance.
*
* @param { Function } func - func func Concurrent function to execute in taskpool.
* @param { unknown[] } args - args args The concurrent function arguments.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Create a Task instance.
*
* @param { Function } func - func func Concurrent function to execute in taskpool.
* @param { unknown[] } args - args args The concurrent function arguments.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* A constructor used to create a Task instance.
*
* @param { Function } func - Function to be executed. The function must be decorated using @Concurrent.
* For details about the supported return value types of the function, see Sequenceable Data Types.
* @param { Object[] } args - Arguments of the function. For details about the supported parameter types,
* see Sequenceable Data Types. The default value is undefined.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
constructor(func: Function, ...args: Object[]);
/**
* A constructor used to create a Task instance, with the task name specified.
*
* @param { string } name - Task name.
* @param { Function } func - Function to be executed. The function must be decorated using @Concurrent.
* For details about the supported return value types of the function, see Sequenceable Data Types.
* @param { Object[] } args - Arguments of the function. For details about the supported parameter types,
* see Sequenceable Data Types. The default value is undefined.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
constructor(name: string, func: Function, ...args: Object[]);
/**
* Check current running Task is canceled or not.
*
* @returns { boolean } Returns {@code true} if current running task is canceled; returns {@code false} otherwise.
* @static
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Checks whether the running task is canceled. Before using this API, you must create a Task instance.
* isCanceled must be used together with taskpool.cancel. If cancel is not called, isCanceled returns false by default.
*
* @returns { boolean } Returns {@code true} if current running task is canceled; returns {@code false} otherwise.
* @static
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
static isCanceled(): boolean;
/**
* Sends data to the host thread and triggers the registered callback. Before using this API, you must create a Task instance.
* NOTE:
* 1.The API is called in the TaskPool thread.
* 2.Do not use this API in a callback function.
* 3.Before calling this API, ensure that the callback function for processing data has been registered in the host thread.
*
* @param { Object[] } args - Data to be used as the input parameter of the registered callback. For details about
* the supported parameter types, see Sequenceable Data Types. The default value is undefined.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200022 - The function is not called in the TaskPool thread.
* @throws { BusinessError } 10200023 - The function is not called in the concurrent function.
* @throws { BusinessError } 10200024 - The callback is not registered on the host side.
* @static
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
static sendData(...args: Object[]): void;
/**
* Set transfer list for this task.
*
* @param { ArrayBuffer[] } [transfer] - transfer Transfer list of this task, empty array is default.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Sets the task transfer list. Before using this API, you must create a Task instance. If this API is not called,
* the ArrayBuffer in the data is transferred by default.
* NOTE:
* This API is used to set the task transfer list in the form of ArrayBuffer in the task pool.
* The ArrayBuffer instance does not copy the content in the task to the worker thread during transfer.
* Instead, it transfers the buffer control right to the worker thread. After the transfer, the ArrayBuffer instance
* becomes invalid. An empty ArrayBuffer will not be transferred.
*
* @param { ArrayBuffer[] } [transfer] - ArrayBuffer instance holding the objects to transfer. The default value is an empty array.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @throws { BusinessError } 10200029 - An ArrayBuffer cannot be set as both a transfer list and a clone list.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
setTransferList(transfer?: ArrayBuffer[]): void;
/**
* Sets the task clone list. Before using this API, you must create a Task instance.
* NOTE:
* This API must be used together with the @Sendable decorator. Otherwise, an exception is thrown.
*
* @param { Object[] | ArrayBuffer[] } cloneList - The type of the passed-in array must be sendable data types or ArrayBuffer.
* All Sendable class instances or ArrayBuffer objects passed in to cloneList are transferred in copy mode between threads.
* This means that any modification to the destination objects does not affect the original objects.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200029 - An ArrayBuffer cannot be set as both a transfer list and a clone list.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
setCloneList(cloneList: Object[] | ArrayBuffer[]): void;
/**
* Registers a callback for a task to receive and process data from the worker thread. Before using this API, you must create a Task instance.
* NOTE:
* If multiple callbacks are registered for the same task, only the last registration takes effect.
*
* @param { Function } [callback] - Callback function for processing the data received. The data sent to the host
* thread is transferred to the callback as an input parameter. If no value is passed in, all the registered callbacks are canceled.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
onReceiveData(callback?: Function): void;
/**
* Add dependencies on the task array for this task.
*
* @param { Task[] } tasks - tasks tasks An array of dependent tasks.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200026 - There is a circular dependency.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Add dependencies on the task array for this task.
*
* @param { Task[] } tasks - An array of dependent tasks.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 10200026 - There is a circular dependency.
* @throws { BusinessError } 10200052 - The periodic task cannot have a dependency.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
/**
* Adds dependent tasks for this task. Before using this API, you must create a Task instance.
* The task and its dependent tasks cannot be a task in a task group, serial queue, or asynchronous queue,
* a task that has been executed, or a periodic task. A task with a dependency relationship (a task that depends
* on another task or a task that is depended on) cannot be executed multiple times.
*
* @param { Task[] } tasks - Array of tasks on which the current task depends. The default value is undefined.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 10200026 - There is a circular dependency.
* @throws { BusinessError } 10200052 - The periodic task cannot have a dependency.
* @throws { BusinessError } 10200056 - The task has been executed by the AsyncRunner.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 18
*/
addDependency(...tasks: Task[]): void;
/**
* Remove dependencies on the task array for this task.
*
* @param { Task[] } tasks - tasks tasks An array of dependent tasks.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200027 - The dependency does not exist.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Remove dependencies on the task array for this task.
*
* @param { Task[] } tasks - An array of dependent tasks.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 10200027 - The dependency does not exist.
* @throws { BusinessError } 10200052 - The periodic task cannot have a dependency.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
/**
* Removes dependent tasks for this task. Before using this API, you must create a Task instance.
*
* @param { Task[] } tasks - Array of tasks on which the current task depends. The default value is undefined.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 10200027 - The dependency does not exist.
* @throws { BusinessError } 10200052 - The periodic task cannot have a dependency.
* @throws { BusinessError } 10200056 - The task has been executed by the AsyncRunner.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 18
*/
removeDependency(...tasks: Task[]): void;
/**
* Register a callback function and call it when a task is enqueued.
* The registration must be carried out before the task is executed. Otherwise, an exception is thrown.
*
* @param { CallbackFunction } [callback] - Callback function to register.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 10200034 - The executed task does not support the registration of listeners.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
onEnqueued(callback: CallbackFunction): void;
/**
* Register a callback function and call it when the execution of a task starts.
* The registration must be carried out before the task is executed. Otherwise, an exception is thrown.
*
* @param { CallbackFunction } [callback] - Callback function to register.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 10200034 - The executed task does not support the registration of listeners.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
onStartExecution(callback: CallbackFunction): void;
/**
* Register a callback function and call it when a task fails to be executed.
* The registration must be carried out before the task is executed. Otherwise, an exception is thrown.
*
* @param { CallbackFunctionWithError } [callback] - Callback function to register.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 10200034 - The executed task does not support the registration of listeners.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
onExecutionFailed(callback: CallbackFunctionWithError): void;
/**
* Register a callback function and call it when a task is executed successfully.
* The registration must be carried out before the task is executed. Otherwise, an exception is thrown.
*
* @param { CallbackFunction } [callback] - Callback function to register.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 10200034 - The executed task does not support the registration of listeners.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
onExecutionSucceeded(callback: CallbackFunction): void;
/**
* Checks whether the task is complete.
*
* @returns { boolean } Returns {@code true} if the task has been completed; returns {@code false} otherwise.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isDone(): boolean;
/**
* Concurrent function to execute in taskpool.
*
* @type { Function }
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Concurrent function to execute in taskpool.
*
* @type { Function }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Function to be passed in during task creation. For details about the supported return value types of the function, see Sequenceable Data Types.
*
* @type { Function }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
function: Function;
/**
* The concurrent function arguments.
*
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The concurrent function arguments.
*
* @type { ?unknown[] }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Arguments of the function. For details about the supported parameter types, see Sequenceable Data Types.
*
* @type { ?Object[] }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
arguments?: Object[];
/**
* Name of the task specified when the task is created.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
name: string;
/**
* Task ID.
*
* @type { number }
* @default 0
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 18
*/
taskId: number;
/**
* Total execution time of the task. in ms.
*
* @type { number }
* @default 0
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
totalDuration: number;
/**
* Asynchronous I/O time of the task. in ms.
*
* @type { number }
* @default 0
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
ioDuration: number;
/**
* CPU time of the task. in ms.
*
* @type { number }
* @default 0
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
cpuDuration: number;
}
/**
* The TaskGroup class provides an interface to create a task group.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Implements a task group, in which tasks are associated with each other and all tasks are executed at a time.
* If all the tasks are executed normally, an array of task results is returned asynchronously, and the sequence of
* elements in the array is the same as the sequence of tasks added by calling addTask. If any task fails,
* the corresponding exception is thrown. If multiple tasks in the task group fail, the exception of the first failed
* task is thrown. A task group can be executed for multiple times, but no task can be added after the task group is executed.
* Before calling any APIs in TaskGroup, you must use constructor to create a TaskGroup instance.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
class TaskGroup {
/**
* Create a TaskGroup instance.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Constructor used to create a TaskGroup instance.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
constructor();
/**
* A constructor used to create a TaskGroup instance, with the task group name specified.
*
* @param { string } name - Task group name.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
constructor(name: string);
/**
* Add a Concurrent function into task group.
*
* @param { Function } func - func func Concurrent function to add in task group.
* @param { unknown[] } args - args args The concurrent function arguments.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Adds the function to be executed to this task group. Before using this API, you must create a TaskGroup instance.
*
* @param { Function } func - Function to be executed. The function must be decorated using @Concurrent.
* For details about the supported return value types of the function, see Sequenceable Data Types.
* @param { Object[] } args - Arguments of the function. For details about the supported parameter types,
* see Sequenceable Data Types. The default value is undefined.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
addTask(func: Function, ...args: Object[]): void;
/**
* Add a Task into TaskGroup.
*
* @param { Task } task - task task The task want to add in task group.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Add a Task into TaskGroup.
*
* @param { Task } task - task task The task want to add in task group.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Add a Task into TaskGroup.
*
* @param { Task } task - The task want to add in task group.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @throws { BusinessError } 10200051 - The periodic task cannot be executed again.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
/**
* Adds a created task to this task group. Before using this API, you must create a TaskGroup instance.
* Tasks in another task group, serial queue, or asynchronous queue, dependent tasks, continuous tasks,
* tasks that have been executed, and periodic tasks cannot be added to the task group.
*
* @param { Task } task - Task to be added to the task group.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @throws { BusinessError } 10200051 - The periodic task cannot be executed again.
* @throws { BusinessError } 10200057 - The task cannot be executed by two APIs.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 18
*/
addTask(task: Task): void;
/**
* Name of the task group specified when the task group is created.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
name: string;
}
/**
* Implements a serial queue, in which all tasks are executed in sequence. Before calling any APIs in SequenceRunner,
* you must use constructor to create a SequenceRunner instance.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
class SequenceRunner {
/**
* A constructor used to create a SequenceRunner instance.
*
* @param { Priority } priority - Priority of the task. The default value is taskpool.Priority.MEDIUM.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Incorrect parameter types;
* 2.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
constructor(priority?: Priority);
/**
* A constructor used to create a SequenceRunner instance. This instance represents a global serial queue.
* If the passed-in name is the same as an existing name, the same serial queue is returned.
* NOTE:
* 1.The bottom layer uses the singleton mode to ensure that the same instance is obtained when a serial queue with the same name is created.
* 2.The priority of a serial queue cannot be modified.
*
* @param { string } name - Name of a serial queue.
* @param { Priority } priority - Priority of the task. The default value is taskpool.Priority.MEDIUM.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(name: string, priority?: Priority);
/**
* Execute a concurrent function.
*
* @param { Task } task - The task want to execute.
* @returns { Promise<Object> }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* @throws { BusinessError } 10200003 - Worker initialization failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200025 - The task to be added to SequenceRunner has dependent tasks.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Execute a concurrent function.
*
* @param { Task } task - The task want to execute.
* @returns { Promise<Object> }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200025 - dependent task not allowed.
* @throws { BusinessError } 10200051 - The periodic task cannot be executed again.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
/**
* Adds a task to the serial queue for execution. Before using this API, you must create a SequenceRunner instance.
* Tasks in another task group, serial queue, or asynchronous queue, dependent tasks, and tasks that have been executed cannot be added to the serial queue.
* NOTE:
* 1.Tasks that depend others cannot be added to the serial queue.
* 2.The failure or cancellation of a task does not affect the execution of subsequent tasks in the serial queue.
*
* @param { Task } task - Task to be added to the serial queue.
* @returns { Promise<Object> }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200025 - dependent task not allowed.
* @throws { BusinessError } 10200051 - The periodic task cannot be executed again.
* @throws { BusinessError } 10200057 - The task cannot be executed by two APIs.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 18
*/
execute(task: Task): Promise<Object>;
}
/**
* Describes a continuous task. LongTask inherits from Task. No upper limit is set for the execution time of a continuous task,
* and no timeout exception is thrown if a continuous task runs for a long period of time. However, a continuous task cannot be
* executed in a task group or executed for multiple times. The thread for executing a continuous task exists until terminateTask
* is called after the execution is complete. The thread is reclaimed when it is idle.
*
* @extends Task
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
class LongTask extends Task {
}
/**
* The GenericsTask class provides an interface to create a task with generics.
*
* @extends Task
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 13
*/
/**
* Implements a generic task. GenericsTask inherits from Task. During the creation of a generic task, the passed-in
* parameter types and return value types of concurrent functions are verified in the compilation phase.
* Other behaviors are the same as those during the creation of a task.
*
* @extends Task
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 18
*/
class GenericsTask<A extends Array<Object>, R> extends Task {
/**
* Create a GenericsTask instance.
*
* @param { (...args: A) => R | Promise<R> } func - Concurrent function to execute in taskpool.
* @param { A } args - The concurrent function arguments.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 13
*/
/**
* A constructor used to create a GenericsTask object.
*
* @param { (...args: A) => R | Promise<R> } func - Function to be executed. The function must be decorated using @Concurrent.
* For details about the supported return value types of the function, see Sequenceable Data Types.
* @param { A } args - Arguments of the function. For details about the supported parameter types, see Sequenceable Data Types.
* The default value is undefined.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 18
*/
constructor(func: (...args: A) => R | Promise<R>, ...args: A);
/**
* Create a GenericsTask instance.
*
* @param { string } name - The name of GenericsTask.
* @param { (...args: A) => R | Promise<R> } func - Concurrent function to execute in taskpool.
* @param { A } args - The concurrent function arguments.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 13
*/
/**
* A constructor used to create a GenericsTask instance, with the task name specified.
*
* @param { string } name - Name of the generic task.
* @param { (...args: A) => R | Promise<R> } func - Function to be executed. The function must be decorated using @Concurrent.
* For details about the supported return value types of the function, see Sequenceable Data Types.
* @param { A } args - Arguments of the function. For details about the supported parameter types, see Sequenceable Data Types.
* The default value is undefined.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 18
*/
constructor(name: string, func: (...args: A) => R | Promise<R>, ...args: A);
}
/**
* The State defines the task state.
*
* @enum { number } State
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Enumerates the task states. After a task is created and execute() is called, the task is placed in the internal
* queue of the task pool and the state is WAITING. When the task is being executed by the worker thread of the task pool,
* the state changes to RUNNING. After the task is executed and the result is returned, the state is reset to WAITING.
* When the task is proactively canceled, the state changes to CANCELED.
*
* @enum { number } State
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
enum State {
/**
* the task state is waiting.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The task is waiting.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
WAITING = 1,
/**
* the task state is running.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The task is running.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
RUNNING = 2,
/**
* the task state is canceled.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The task is canceled.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
CANCELED = 3
}
/**
* Indicates the internal information of the worker thread.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Describes the internal information about a task.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
class TaskInfo {
/**
* Task identity.
*
* @type { number }
* @default 0
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Task ID.
*
* @type { number }
* @default 0
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
taskId: number;
/**
* Task state.
*
* @type { State }
* @default State::WAITING
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Task state.
*
* @type { State }
* @default State::WAITING
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
state: State;
/**
* Duration of task execution.
*
* @type { ?number }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Duration that the task has been executed, in ms. If the return value is 0, the task is not running. If the return value is empty, no task is running.
*
* @type { ?number }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
duration?: number;
/**
* Task name.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
name: string;
}
/**
* Indicates the internal information of the worker thread.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Describes the internal information about a worker thread.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
class ThreadInfo {
/**
* Thread id.
*
* @type { number }
* @default 0
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* ID of the worker thread. If the return value is empty, no task is running.
*
* @type { number }
* @default 0
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
tid: number;
/**
* Task id list that running on current thread.
*
* @type { ?number[] }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* IDs of tasks running on the calling thread. If the return value is empty, no task is running.
*
* @type { ?number[] }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
taskIds?: number[];
/**
* Thread priority.
*
* @type { ?Priority }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Priority of the calling thread. If the return value is empty, no task is running.
*
* @type { ?Priority }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
priority?: Priority;
}
/**
* Indicates the internal information of the taskpool.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Describes the internal information about a task pool.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
class TaskPoolInfo {
/**
* An array of taskpool thread information.
*
* @type { ThreadInfo[] }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Internal information about the worker threads.
*
* @type { ThreadInfo[] }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
threadInfos: ThreadInfo[];
/**
* An array of taskpool task information.
*
* @type { TaskInfo[] }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Internal information about the tasks.
*
* @type { TaskInfo[] }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
taskInfos: TaskInfo[];
}
/**
* Execute a concurrent function.
*
* @param { Function } func - func func Concurrent function want to execute.
* @param { unknown[] } args - args args The concurrent function arguments.
* @returns { Promise<unknown> }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200003 - Worker initialization failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Execute a concurrent function.
*
* @param { Function } func - func func Concurrent function want to execute.
* @param { unknown[] } args - args args The concurrent function arguments.
* @returns { Promise<unknown> }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200003 - Worker initialization failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Execute a concurrent function.
*
* @param { Function } func - func func Concurrent function want to execute.
* @param { Object[] } args - args args The concurrent function arguments.
* @returns { Promise<Object> }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200003 - Worker initialization failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Places a function to be executed in the internal queue of the task pool. The function is not executed immediately.
* It waits to be distributed to the worker thread for execution. In this mode, the function cannot be canceled.
*
* @param { Function } func - Function to be executed. The function must be decorated using @Concurrent.
* For details about the supported return value types of the function, see Sequenceable Data Types.
* @param { Object[] } args - Arguments of the function. For details about the supported parameter types,
* see Sequenceable Data Types. The default value is undefined.
* @returns { Promise<Object> }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
function execute(func: Function, ...args: Object[]): Promise<Object>;
/**
* Execute a concurrent function with generics.
*
* @param { (...args: A) => R | Promise<R> } func - Concurrent function want to execute.
* @param { A } args - The concurrent function arguments.
* @returns { Promise<R> }
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 13
*/
/**
* Verifies the passed-in parameter types and return value type of a concurrent function,
* and places the function to execute in the internal queue of the task pool.
*
* @param { (...args: A) => R | Promise<R> } func - Function to be executed. The function must be decorated using @Concurrent.
* For details about the supported return value types of the function, see Sequenceable Data Types.
* @param { A } args - Arguments of the function. For details about the supported parameter types,
* see Sequenceable Data Types. The default value is undefined.
* @returns { Promise<R> }
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 18
*/
function execute<A extends Array<Object>, R>(func: (...args: A) => R | Promise<R>, ...args: A): Promise<R>;
/**
* Execute a concurrent task.
*
* @param { Task } task - task task The task want to execute.
* @param { Priority } [priority] - priority priority Task priority, MEDIUM is default.
* @returns { Promise<unknown> }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200003 - Worker initialization failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Execute a concurrent task.
*
* @param { Task } task - task task The task want to execute.
* @param { Priority } [priority] - priority priority Task priority, MEDIUM is default.
* @returns { Promise<unknown> }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200003 - Worker initialization failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Execute a concurrent task.
*
* @param { Task } task - task task The task want to execute.
* @param { Priority } [priority] - priority priority Task priority, MEDIUM is default.
* @returns { Promise<Object> }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200003 - Worker initialization failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Execute a concurrent task.
*
* @param { Task } task - The task want to execute.
* @param { Priority } [priority] - Task priority, MEDIUM is default.
* @returns { Promise<Object> }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @throws { BusinessError } 10200051 - The periodic task cannot be executed again.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
/**
* Places a task in the internal queue of the task pool. The task is not executed immediately. It waits to be distributed
* to the worker thread for execution. In this mode, you can set the task priority and call cancel() to cancel the task.
* The task cannot be a task in a task group, serial queue, or asynchronous queue. This API can be called only once for
* a continuous task, but multiple times for a non-continuous task.
*
* @param { Task } task - Task to be executed.
* @param { Priority } [priority] - Priority of the task. The default value is taskpool.Priority.MEDIUM.
* @returns { Promise<Object> }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @throws { BusinessError } 10200051 - The periodic task cannot be executed again.
* @throws { BusinessError } 10200057 - The task cannot be executed by two APIs.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 18
*/
function execute(task: Task, priority?: Priority): Promise<Object>;
/**
* Execute a concurrent task with generics.
*
* @param { GenericsTask<A, R> } task - The task want to execute.
* @param { Priority } [priority] - Task priority, MEDIUM is default.
* @returns { Promise<R> }
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @throws { BusinessError } 10200051 - The periodic task cannot be executed again.
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 13
*/
/**
* Verifies the passed-in parameter types and return value type of a concurrent function, and places the generic task in the internal queue of the task pool.
*
* @param { GenericsTask<A, R> } task - Generic task to be executed.
* @param { Priority } [priority] - Priority of the task. The default value is taskpool.Priority.MEDIUM.
* @returns { Promise<R> }
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @throws { BusinessError } 10200051 - The periodic task cannot be executed again.
* @throws { BusinessError } 10200057 - The task cannot be executed by two APIs.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 18
*/
function execute<A extends Array<Object>, R>(task: GenericsTask<A, R>, priority?: Priority): Promise<R>;
/**
* Execute a concurrent task group.
*
* @param { TaskGroup } group - group group The task group want to execute.
* @param { Priority } [priority] - priority priority Task group priority, MEDIUM is default.
* @returns { Promise<unknown[]> }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Places a task group in the internal queue of the task pool. The tasks in the task group are not executed immediately.
* They wait to be distributed to the worker thread for execution. After all tasks in the task group are executed,
* a result array is returned. This API applies when you want to execute a group of associated tasks.
*
* @param { TaskGroup } group - Task group to be executed.
* @param { Priority } [priority] - Priority of the task group. The default value is taskpool.Priority.MEDIUM.
* @returns { Promise<Object[]> }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
function execute(group: TaskGroup, priority?: Priority): Promise<Object[]>;
/**
* Execute a concurrent task after the specified time.
*
* @param { number } delayTime - delayTime delayTime The time want to delay.
* @param { Task } task - task task The task want to execute.
* @param { Priority } [priority] - priority priority Task priority, MEDIUM is default.
* @returns { Promise<Object> }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200028 - The delayTime is less than zero.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Execute a concurrent task after the specified time.
*
* @param { number } delayTime - The time want to delay.
* @param { Task } task - The task want to execute.
* @param { Priority } [priority] - Task priority, MEDIUM is default.
* @returns { Promise<Object> }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @throws { BusinessError } 10200028 - The delayTime is less than zero.
* @throws { BusinessError } 10200051 - The periodic task cannot be executed again.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
/**
* Executes a task after a given delay. In this mode, you can set the task priority and call cancel() to cancel the task.
* The task cannot be a task in a task group, serial queue, or asynchronous queue, or a periodic task.
* This API can be called only once for a continuous task, but multiple times for a non-continuous task.
*
* @param { number } delayTime - Delay, in ms.
* @param { Task } task - Task to be executed with a delay.
* @param { Priority } [priority] - Priority of the task. The default value is taskpool.Priority.MEDIUM.
* @returns { Promise<Object> }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @throws { BusinessError } 10200028 - The delayTime is less than zero.
* @throws { BusinessError } 10200051 - The periodic task cannot be executed again.
* @throws { BusinessError } 10200057 - The task cannot be executed by two APIs.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 18
*/
function executeDelayed(delayTime: number, task: Task, priority?: Priority): Promise<Object>;
/**
* Execute a concurrent task with generics after the specified time.
*
* @param { number } delayTime - The time want to delay.
* @param { GenericsTask<A, R> } task - The task want to execute.
* @param { Priority } [priority] - Task priority, MEDIUM is default.
* @returns { Promise<R> }
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @throws { BusinessError } 10200028 - The delayTime is less than zero.
* @throws { BusinessError } 10200051 - The periodic task cannot be executed again.
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 13
*/
/**
* Verifies the passed-in parameter types and return value type of a concurrent function, and executes the generic task with a delay.
*
* @param { number } delayTime - Delay, in ms.
* @param { GenericsTask<A, R> } task - Generic task to be executed with a delay.
* @param { Priority } [priority] - Priority of the task. The default value is taskpool.Priority.MEDIUM.
* @returns { Promise<R> }
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @throws { BusinessError } 10200028 - The delayTime is less than zero.
* @throws { BusinessError } 10200051 - The periodic task cannot be executed again.
* @throws { BusinessError } 10200057 - The task cannot be executed by two APIs.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 18
*/
function executeDelayed<A extends Array<Object>, R>(delayTime: number, task: GenericsTask<A, R>, priority?: Priority): Promise<R>;
/**
* Execute a concurrent task periodically.
*
* @param { number } period - The period in milliseconds for executing task.
* @param { Task } task - The task want to execute.
* @param { Priority } [priority] - Task priority, MEDIUM is default.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @throws { BusinessError } 10200028 - The period is less than zero.
* @throws { BusinessError } 10200050 - The concurrent task has been executed and cannot be executed periodically.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
/**
* Executes a task periodically. In this execution mode, you can set the task priority and call cancel() to cancel the execution.
* A periodic task cannot be a task in a task group, serial queue, or asynchronous queue. It cannot call execute() again or have a dependency relationship.
*
* @param { number } period - Execution period, in ms.
* @param { Task } task - Task to be executed.
* @param { Priority } [priority] - Priority of the task. The default value is taskpool.Priority.MEDIUM.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @throws { BusinessError } 10200028 - The period is less than zero.
* @throws { BusinessError } 10200050 - The concurrent task has been executed and cannot be executed periodically.
* @throws { BusinessError } 10200057 - The task cannot be executed by two APIs.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 18
*/
function executePeriodically(period: number, task: Task, priority?: Priority): void;
/**
* Execute a concurrent task with generics periodically.
*
* @param { number } period - The period in milliseconds for executing task.
* @param { GenericsTask<A, R> } task - The task want to execute.
* @param { Priority } [priority] - Task priority, MEDIUM is default.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @throws { BusinessError } 10200028 - The period is less than zero.
* @throws { BusinessError } 10200050 - The concurrent task has been executed and cannot be executed periodically.
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 13
*/
/**
* Verifies the passed-in parameter types and return value type of a concurrent function, and executes the generic task
* periodically at an interval specified by period.
*
* @param { number } period - Execution period, in ms.
* @param { GenericsTask<A, R> } task - Generic task to be executed periodically.
* @param { Priority } [priority] - Priority of the task. The default value is taskpool.Priority.MEDIUM.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @throws { BusinessError } 10200028 - The period is less than zero.
* @throws { BusinessError } 10200050 - The concurrent task has been executed and cannot be executed periodically.
* @throws { BusinessError } 10200057 - The task cannot be executed by two APIs.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 18
*/
function executePeriodically<A extends Array<Object>, R>(period: number, task: GenericsTask<A, R>, priority?: Priority): void;
/**
* Cancel a concurrent task.
*
* @param { Task } task - task task The task want to cancel.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200015 - The task to cancel does not exist.
* @throws { BusinessError } 10200016 - The task to cancel is being executed.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Cancel a concurrent task.
*
* @param { Task } task - task task The task want to cancel.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200015 - The task to cancel does not exist.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Cancel a concurrent task.
*
* @param { Task } task - task task The task want to cancel.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200015 - The task to cancel does not exist.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Cancels a task in the task pool. If the task is in the internal queue of the task pool, the task will not be executed
* after being canceled, and an exception indicating task cancellation is returned. If the task has been distributed to
* the worker thread of the task pool, canceling the task does not affect the task execution, and the execution result
* is returned in the catch branch. You can use isCanceled() to check the task cancellation status. In other words,
* taskpool.cancel takes effect before taskpool.execute or taskpool.executeDelayed is called.
*
* @param { Task } task - Task to cancel.
* @throws { BusinessError } 10200015 - The task to cancel does not exist.
* @throws { BusinessError } 10200055 - The asyncRunner task has been canceled.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 18
*/
function cancel(task: Task): void;
/**
* Cancel a concurrent task group.
*
* @param { TaskGroup } group - group group The task group want to cancel.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200018 - The task group to cancel does not exist.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Cancels a task group in the task pool. If a task group is canceled before all the tasks in it are finished, undefined is returned.
*
* @param { TaskGroup } group - Task group to cancel.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200018 - The task group to cancel does not exist.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
function cancel(group: TaskGroup): void;
/**
* Cancels a task in the task pool by task ID. If the task is in the internal queue of the task pool,
* the task will not be executed after being canceled, and an exception indicating task cancellation is returned.
* If the task has been distributed to the worker thread of the task pool, canceling the task does not affect the task execution,
* and the execution result is returned in the catch branch. You can use isCanceled() to check the task cancellation status.
* In other words, taskpool.cancel takes effect before taskpool.execute or taskpool.executeDelayed is called.
* If taskpool.cancel is called by other threads, note that the cancel operation, which is asynchronous,
* may take effect for later calls of taskpool.execute or taskpool.executeDelayed.
*
* @param { number } taskId - ID of the task to cancel.
* @throws { BusinessError } 10200015 - The task to cancel does not exist.
* @throws { BusinessError } 10200055 - The asyncRunner task has been canceled.
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 18
*/
function cancel(taskId: number): void;
/**
* Get task pool internal information.
*
* @returns { TaskPoolInfo }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Obtains internal information about this task pool, including thread information and task information.
*
* @returns { TaskPoolInfo }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
function getTaskPoolInfo(): TaskPoolInfo;
/**
* Terminates a continuous task in the task pool. It is called after the continuous task is complete.
* After the task is terminated, the thread that executes the task may be reclaimed.
*
* @param { LongTask } longTask - Continuous task to terminate.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
function terminateTask(longTask: LongTask): void;
/**
* Checks whether a function is a concurrent function.
*
* @param { Function } func - Function to check.
* @returns { boolean } Returns {@code true} if it is a concurrent function; returns {@code false} otherwise.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
function isConcurrent(func: Function): boolean;
/**
* Implements an asynchronous queue, for which you can specify the task execution concurrency and queuing policy.
* Before calling any APIs in AsyncRunner, you must use constructor to create an AsyncRunner instance.
*
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 18
*/
export class AsyncRunner {
/**
* A constructor used to create an AsyncRunner instance. It constructs a non-global asynchronous queue.
* Even when the parameters passed are the same, it returns different asynchronous queues.
*
* @param { number } runningCapacity - Maximum number of tasks that can run concurrently. The value must be a positive integer.
* If a negative number is passed, an error is reported. If a non-integer is passed, the value is rounded down.
* @param { ?number } waitingCapacity - Maximum number of tasks that can be queued. The value must be greater than or equal to 0.
* If a negative number is passed, an error is reported. If a non-integer is passed, the value is rounded down.
* The default value is 0, indicating that there is no limit to the number of tasks that can wait.
* If a value greater than 0 is passed, tasks will be discarded from the front of the queue once the queue size
* exceeds this limit, implementing a discard policy.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 18
*/
constructor(runningCapacity: number, waitingCapacity?: number);
/**
* A constructor used to create an AsyncRunner instance. It constructs a global asynchronous queue.
* If the passed-in name is the same as an existing name, the same asynchronous queue is returned.
* NOTE:
* 1.The bottom layer uses the singleton mode to ensure that the same instance is obtained when an asynchronous queue with the same name is created.
* 2.The task execution concurrency and waiting capacity cannot be modified.
*
* @param { string } name - Name of an asynchronous queue.
* @param { number } runningCapacity - Maximum number of tasks that can run concurrently. The value must be a positive integer.
* If a negative number is passed, an error is reported. If a non-integer is passed, the value is rounded down.
* @param { ?number } waitingCapacity - Maximum number of tasks that can be queued. The value must be greater than or equal to 0.
* If a negative number is passed, an error is reported. If a non-integer is passed, the value is rounded down.
* The default value is 0, indicating that there is no limit to the number of tasks that can wait.
* If a value greater than 0 is passed, tasks will be discarded from the front of the queue once the queue size
* exceeds this limit, implementing a discard policy.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 18
*/
constructor(name: string, runningCapacity: number, waitingCapacity?: number);
/**
* Adds a task to the asynchronous queue for execution. Before using this API, you must create an AsyncRunner instance.
* NOTE:
* Tasks in a task group cannot be added to the asynchronous queue.
* Tasks in a serial queue cannot be added to the asynchronous queue.
* Tasks in other asynchronous queues cannot be added to the asynchronous queue.
* Periodic tasks cannot be added to the asynchronous queue.
* Delayed tasks cannot be added to the asynchronous queue.
* Tasks that depend others cannot be added to the asynchronous queue.
* Tasks that have been executed cannot be added to the asynchronous queue.
*
* @param { Task } task - Task to be added to the asynchronous queue.
* @param { ?Priority } [priority] - Priority of the task. The default value is taskpool.Priority.MEDIUM.
* @returns { Promise<Object> }
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200025 - dependent task not allowed.
* @throws { BusinessError } 10200051 - The periodic task cannot be executed again.
* @throws { BusinessError } 10200054 - The asyncRunner task is discarded.
* @throws { BusinessError } 10200057 - The task cannot be executed by two APIs.
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 18
*/
execute(task: Task, priority?: Priority): Promise<Object>;
}
/**
* Defines the task result interface
*
* @interface TaskResult
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
*/
interface TaskResult {
/**
* the result returned by the task
*
* @type { ?Object }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
*/
result?: Object;
/**
* the error thrown by the task
*
* @type { ?(Error | Object) }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
*/
error?: Error | Object;
}
}
export default taskpool;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/openharmony/interface_sdk-js.git
git@gitee.com:openharmony/interface_sdk-js.git
openharmony
interface_sdk-js
interface_sdk-js
master

搜索帮助