X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FIWorkerNode.html;h=278faaa7eb385ef44d177c5db1a4f0dcf1cc3e8f;hb=4ee786575c19cfc95faa0dfc2671b3ab8f680402;hp=be1ccbdc5f15cf10cd8d2457f4ddad626ddd500b;hpb=04cb7adbacc7fb0d1b76db6122f86c52e33d136d;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index be1ccbdc..278faaa7 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,13 +1,13 @@ -
Readonly
clearReadonly
clearReadonly
closeCloses communication channel.
+Readonly
deleteDeletes task function worker usage statistics.
+The task function name.
+true
if the task function worker usage statistics were deleted, false
otherwise.
Readonly
dequeueReadonly
enqueueWorker node enqueue task.
+Enqueue task.
The task to queue.
The task queue size.
+The tasks queue size.
+ +Readonly
getGets task function worker usage statistics.
+The task function name.
+The task function worker usage statistics if the task function worker usage statistics are initialized, undefined
otherwise.
Readonly
hasWhether the worker node has back pressure (i.e. its tasks queue is full).
+true
if the worker node has back pressure, false
otherwise.
Readonly
infoWorker node worker info.
+Worker info.
+Optional
Readonly
messageMessage channel (worker_threads only).
+Optional
onCallback invoked when worker node tasks queue is back pressured.
+Optional
onCallback invoked when worker node tasks queue is empty.
Readonly
popReadonly
resetWorker node reset usage statistics .
+Resets usage statistics.
Optional
strategyWorker choice strategy data. +This is used to store data that is specific to the worker choice strategy.
+Tasks queue back pressure size. +This is the number of tasks that can be enqueued before the worker node has back pressure.
+Readonly
tasksTasks queue size.
+The tasks queue size.
+ +Readonly
unshiftWorker node tasks queue size.
+Prepends a task to the tasks queue.
+The task to prepend.
The tasks queue size.
Readonly
usageWorker node worker usage statistics.
+Worker usage statistics.
Readonly
workerWorker node worker.
+Worker.
Generated using TypeDoc
Generated using TypeDoc
Worker node clear tasks queue.
+Clears tasks queue.
Returns void