X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FIPool.html;h=0b232f29be2d00227a28ed520f67771f3a571334;hb=6c525543a7ed67a926b7c1f4bf98985aaad1f088;hp=001e5789d57f65a4b14c07c8b9715bb446760017;hpb=881050e41e8c464ce0c3537d05898bd42ed87631;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 001e5789..0b232f29 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -
Type of worker which manages this pool.
+Type of data sent to the worker. This can only be serializable data.
Readonly
busyWhether the pool is busy or not.
+The pool busyness boolean status.
+Shutdowns every current worker in this pool.
+Optional
Readonly
emitterOptional
Readonly
emitterEmitter on which events can be listened to.
Events that can currently be listened to:
'busy'
'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.
@@ -88,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.