X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=bb275d41748743cf0ffc26295ad4da9de761289a;hb=d6b93f1ae5603949390418b787e0ad51b026f9c5;hp=39bf3862b55dde4572e9e3f553d8d0e96955d5d7;hpb=7e2a464b15953320c79646e2ff88d953db4e5b96;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 39bf3862..bb275d41 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 +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.