DynamicThreadPool | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=86171c79877dbdd2161b6a2b2d61d2e323339196;hb=0eb836fa3f5683400594b9c595650b49ff8ae0ac;hp=2cc3a42b6aa0f3fc35fd7086e526338593e90f2f;hpb=c7e01b67847217903200f2453a4ffd4ba6bb191a;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 2cc3a42b..86171c79 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,4 +1,4 @@ -DynamicThreadPool | poolifier - v2.6.22

+DynamicThreadPool | poolifier - v2.6.27

@@ -45,7 +45,7 @@ When the maximum number of threads is reached and workers are busy, an event is

DynamicThreadPool

Defined in src/pools/thread/dynamic.ts:15

@@ -95,7 +95,9 @@ When the maximum number of threads is reached and workers are busy, an event is getWorkerInfo internalBusy isMain +listTaskFunctions registerWorkerMessageListener +sendKillMessageToWorker sendStartupMessageToWorker sendToWorker setTasksQueueOptions @@ -147,7 +149,7 @@ When the maximum number of threads is reached and workers are busy, an event is

Defined in src/pools/thread/dynamic.ts:27

Properties

@@ -156,9 +158,10 @@ When the maximum number of threads is reached and workers are busy, an event is

Emitter on which events can be listened to.

Events that can currently be listened to:

'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.
'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.
'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
'destroy': Emitted when the pool is destroyed.
'error': Emitted when an uncaught error occurs.
'taskError': Emitted when an error occurs while executing a task.

@@ -166,7 +169,7 @@ When the maximum number of threads is reached and workers are busy, an event is

Defined in src/pools/abstract-pool.ts:65

`Protected` `Readonly` filePath

filePath: string

@@ -175,7 +178,7 @@ When the maximum number of threads is reached and workers are busy, an event is

Defined in src/pools/abstract-pool.ts:109

`Protected` `Readonly` max

max: number

@@ -183,7 +186,7 @@ When the maximum number of threads is reached and workers are busy, an event is

Defined in src/pools/thread/dynamic.ts:29

`Protected` `Readonly` numberOfWorkers

numberOfWorkers: number

@@ -192,7 +195,7 @@ When the maximum number of threads is reached and workers are busy, an event is

Defined in src/pools/abstract-pool.ts:108

`Protected` `Readonly` opts

opts: ThreadPoolOptions = {}

@@ -201,7 +204,7 @@ When the maximum number of threads is reached and workers are busy, an event is

Defined in src/pools/thread/fixed.ts:49

`Protected` promiseResponseMap

promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...

@@ -215,7 +218,7 @@ When the maximum number of threads is reached and workers are busy, an event is

Defined in src/pools/abstract-pool.ts:75

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

@@ -224,7 +227,7 @@ When the maximum number of threads is reached and workers are busy, an event is

Defined in src/pools/abstract-pool.ts:81

`Readonly` workerNodes

workerNodes: IWorkerNode<Worker, Data>[] = []

@@ -233,7 +236,7 @@ When the maximum number of threads is reached and workers are busy, an event is

Defined in src/pools/abstract-pool.ts:62

Accessors

@@ -248,7 +251,7 @@ When the maximum number of threads is reached and workers are busy, an event is

Defined in src/pools/thread/dynamic.ts:48

Methods

@@ -375,7 +378,7 @@ Can be overridden.

Defined in src/pools/abstract-pool.ts:793

`Protected` afterWorkerNodeSetup

Defined in src/pools/abstract-pool.ts:1026

`Protected` beforeTaskExecutionHook

Defined in src/pools/abstract-pool.ts:772

`Protected` checkDynamicPoolSize

Returns void

Defined in src/pools/abstract-pool.ts:180

`Protected` createAndSetupDynamicWorkerNode

Defined in src/pools/abstract-pool.ts:973

`Protected` createAndSetupWorkerNode

Defined in src/pools/abstract-pool.ts:933

`Protected` createWorker

Defined in src/pools/thread/fixed.ts:114

destroy

Defined in src/pools/abstract-pool.ts:718

`Protected` destroyWorkerNode

Defined in src/pools/thread/fixed.ts:60

enableTasksQueue

Defined in src/pools/abstract-pool.ts:578

execute

execute(data?, name?): Promise<Response>
execute(data?, name?, transferList?): Promise<Response>
Executes the specified function in the worker constructor with the task data input parameter.

@@ -547,12 +550,17 @@ Can be overridden.
- Optional data: Data
  -
  The task input data for the specified task function. This can only be structured-cloneable data.
  +
  The optional task input data for the specified task function. This can only be structured-cloneable data.
- Optional name: string
  -
  The name of the task function to execute. If not specified, the default task function will be executed.
  +
  The optional name of the task function to execute. If not specified, the default task function will be executed.
  +
  +
- +
  Optional transferList: TransferListItem[]
  +
  An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.

Returns Promise<Response>

Promise that will be fulfilled when the task is completed.

@@ -560,7 +568,7 @@ Can be overridden.

Defined in src/pools/abstract-pool.ts:659

`Protected` flushTasksQueue

Returns void

Defined in src/pools/abstract-pool.ts:1241

`Protected` getWorkerInfo

Defined in src/pools/abstract-pool.ts:1180

`Protected` internalBusy

internalBusy(): boolean
-
Whether worker nodes are executing at least one task.
+
Whether worker nodes are executing concurrently their tasks quota or not.

Returns boolean
Worker nodes busyness boolean status.
Inherited from FixedThreadPool.internalBusy
- Defined in src/pools/abstract-pool.ts:622

Defined in src/pools/abstract-pool.ts:629

`Protected` isMain

Defined in src/pools/thread/fixed.ts:55

listTaskFunctions

listTaskFunctions(): string[]
+
Lists the names of task function available in this pool.
+
+
Returns string[]
The names of task function available in this pool.
+ +
+
Inherited from FixedThreadPool.listTaskFunctions
+
- Defined in src/pools/abstract-pool.ts:650

`Protected` registerWorkerMessageListener

Defined in src/pools/thread/fixed.ts:104

`Protected` sendKillMessageToWorker

sendKillMessageToWorker(workerNodeKey, workerId): Promise<void>
+
+
Parameters
+
- +
  workerNodeKey: number
- +
  workerId: number
+
Returns Promise<void>
+
Inherited from FixedThreadPool.sendKillMessageToWorker
+
- Defined in src/pools/abstract-pool.ts:727

`Protected` sendStartupMessageToWorker

Defined in src/pools/thread/fixed.ts:88

`Protected` sendToWorker

sendToWorker(workerNodeKey, message): void
sendToWorker(workerNodeKey, message, transferList?): void
Sends a message to worker given its worker node key.

@@ -701,12 +738,17 @@ Can be overridden.

message: MessageValue<Data, unknown>

The message.

+
+
Optional transferList: TransferListItem[]
+
The optional array of transferable objects.
+