X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=68183a8fc4ca9065feb7818590e33e833ad4d03b;hb=e7339cfd46bfe4600187ae2c6bd6c9e7f63e7052;hp=d8d8c10381a8c7c6e11f3535a1b82fe231760c32;hpb=301c53e7ae6cf1120298ea10868a9091904c01a2;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index d8d8c103..68183a8f 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,18 +1,20 @@ -
Type of worker which manages this pool.
+Type of data sent to the worker. This can only be serializable data.
Optional
Readonly
emitterEmitter on which events can be listened to.
+Events that can currently be listened to:
+'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.Performs the task specified in the constructor with the data parameter.
@@ -69,16 +115,48 @@The input for the specified task. This can only be serializable data.
Finds a free worker node key based on the number of tasks the worker has applied.
+If a worker is found with 0
running tasks, it is detected as free and its worker node key is returned.
If no free worker is found, -1
is returned.
A worker node key if there is one, -1
otherwise.
Readonly
fullWhether the pool is full or not.
+The pool filling boolean status.
+Sets the worker choice strategy in this pool.
The worker choice strategy.
Readonly
typePool type.
+If it is 'dynamic'
, it provides the max
property.
Generated using TypeDoc
Contract definition for a poolifier pool.