X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=34b89a9c40fdbfee2971e6bfbd024fd18b8ffc3a;hb=ccd73e075194fac1cf6e1b736f1556b199c95bc5;hp=b23ee1e776d8d42d0b617c4d02f17ab847856a59;hpb=76aa2b0f39bd376383f2fdc79046328693719590;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index b23ee1e7..34b89a9c 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,4 +1,4 @@ -
Emitter on which events can be listened to.
Events that can currently be listened to:
-
-
+
+
+
@@ -152,7 +157,7 @@ +'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.'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.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.Protected
Readonly
fileProtected
Readonly
numberProtected
Readonly
optsProtected
promiseProtected
worker Nodes
-Readonly
workerPool worker nodes.
Accessors
Protected
full@@ -239,7 +244,7 @@
info
@@ -251,7 +256,7 @@
Protected
max@@ -263,7 +268,7 @@
Protected
min@@ -275,7 +280,25 @@
+Private
ready+- get ready(): boolean
+-
+
Returns boolean
+Private
starting+- get starting(): boolean
+-
+
Returns boolean
Protected
type@@ -288,7 +311,20 @@
+Private
utilization+- get utilization(): number
+-
+
+
Gets the approximate pool utilization.
+Returns number
The pool utilization.
+ +Protected
worker@@ -300,7 +336,7 @@
Methods
Protected
after@@ -349,7 +385,7 @@ Can be overridden.
Protected
before@@ -375,7 +411,23 @@ Can be overridden.
Dynamic Pool Size
+Protected
check+- check
Dynamic Pool Size(min, max): void
+-
+
+
+
Parameters
++-
+
+-
+
min: number
max: number
Returns void
Protected
create@@ -388,7 +440,7 @@ Can be overridden.
Protected
create@@ -401,7 +453,7 @@ Can be overridden.
Protected
create@@ -414,19 +466,19 @@ Can be overridden.
destroy
Terminate every current worker in this pool.
+Terminates every current worker in this pool.
Returns Promise<void>
+Protected
destroy@@ -446,7 +498,7 @@ Can be overridden.
enable Tasks Queue
@@ -471,7 +523,7 @@ Can be overridden.
execute
@@ -497,7 +549,7 @@ Can be overridden.
Protected
internal@@ -510,7 +562,7 @@ Can be overridden.
Protected
is@@ -522,7 +574,7 @@ Can be overridden.
Protected
send@@ -547,7 +599,7 @@ Can be overridden.
set Tasks Queue Options
@@ -567,7 +619,7 @@ Can be overridden.
set Worker Choice Strategy
@@ -592,7 +644,7 @@ Can be overridden.
set Worker Choice Strategy Options
@@ -612,7 +664,7 @@ Can be overridden.
Protected
setup@@ -625,7 +677,7 @@ Can be overridden.
Protected
worker@@ -653,7 +705,7 @@ Can be overridden.