X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Finterfaces%2FIPool.html;h=c7323502811497d57439240f1692d47b9ae3f03b;hb=1d9e702392092e351b448175a77c16234eec9212;hp=6afc627a1af1dc713389262a37b3044f203631b6;hpb=6c7b620077f30f365d597b7fce35cfe5584c2702;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 6afc627a..c7323502 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.
Type of response of execution. This can only be serializable data.
+Type of execution response. This can only be serializable data.
Shutdowns every current worker in this pool.
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 +105,40 @@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.
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.