X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FIWorkerNode.html;h=be00e69fe29d4267ebc7b4e607ccade714f3113c;hb=186417b2eb79b9bcadbf15bd5c53da4dbe6c92e2;hp=ec3e313c903310cc347fca8582da3c714ee54089;hpb=c5d5cc086c12de1bc8ceb7f6bcda6b8e283ab405;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index ec3e313c..be00e69f 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,7 +1,7 @@ -
Internal
Optional
strategyWorker choice strategy data. This is used to store data that are specific to the worker choice strategy.
-Tasks queue back pressure size. +
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.
+Readonly
tasksTasks queue size.
The tasks queue size.
-Readonly
terminateTerminates the worker node.
-Readonly
usageWorker usage statistics.
-Readonly
workerWorker.
-Optional
[captureRest
...args: AnyRestAlias for emitter.on(eventName, listener)
.
Readonly
terminateTerminates the worker node.
+Readonly
usageWorker usage statistics.
+Readonly
workerWorker.
+Optional
[captureRest
...args: AnyRestAlias for emitter.on(eventName, listener)
.
Rest
...args: any[]v0.1.26
Synchronously calls each of the listeners registered for the event named eventName
, in the order they were registered, passing the supplied arguments
to each.
emitter.setMaxListeners()
method allows the limit
modified for this specific EventEmitter
instance. The value can be set to Infinity
(or 0
) to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter
, so that calls can be chained.
v0.3.5
-
Worker node interface.
+- Preparing search index...
- The search index is not available
poolifier - v4.0.10Interface IWorkerNode<Worker, Data>
Internal
Worker node interface.
    clearTasksQueue: (() => void);
    deleteTaskFunctionWorkerUsage: ((name) => boolean);
    dequeueLastPrioritizedTask: (() => undefined | Task<Data>);
    dequeueTask: ((bucket?) => undefined | Task<Data>);
    enqueueTask: ((task) => number);
    getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage);
    hasBackPressure: (() => boolean);
    info: WorkerInfo;
    messageChannel?: MessageChannel;
    registerOnceWorkerEventHandler: ((event, handler) => void);
    registerWorkerEventHandler: ((event, handler) => void);
    strategyData?: StrategyData;
    tasksQueueBackPressureSize: number;
    tasksQueueSize: (() => number);
    terminate: (() => Promise<void>);
    usage: WorkerUsage;
    worker: Worker;
    [captureRejectionSymbol]?<K>(error, event, ...args): void;
    addListener<K>(eventName, listener): this;
    emit<K>(eventName, ...args): boolean;
    eventNames(): (string | symbol)[];
    getMaxListeners(): number;
    listenerCount<K>(eventName, listener?): number;
    listeners<K>(eventName): Function[];
    off<K>(eventName, listener): this;
    on<K>(eventName, listener): this;
    once<K>(eventName, listener): this;
    prependListener<K>(eventName, listener): this;
    prependOnceListener<K>(eventName, listener): this;
    rawListeners<K>(eventName): Function[];
    removeAllListeners(eventName?): this;
    removeListener<K>(eventName, listener): this;
    setMaxListeners(n): this;
}
Type Parameters
Type of worker.
Type of data sent to the worker. This can only be structured-cloneable data.
-Hierarchy
Index
Properties
Hierarchy
Index
Properties
Properties
Readonly
clearClears tasks queue.
-Type declaration
Returns void
Readonly
deleteDeletes task function worker usage statistics.
+Type declaration
Returns void
Readonly
deleteDeletes task function worker usage statistics.
Type declaration
Parameters
The task function name.
Returns boolean
Returns
-true
if the task function worker usage statistics were deleted,false
otherwise.Readonly
dequeueDequeue last prioritized task.
+Readonly
dequeueDequeue last prioritized task.
Type declaration
Returns undefined | Task<Data>
Returns
The dequeued task.
-Readonly
dequeueDequeue task.
+Readonly
dequeueDequeue task.
Type declaration
Parameters
Optional
bucket: numberThe prioritized bucket to dequeue from.
Returns undefined | Task<Data>
Default Value
Returns
The dequeued task.
-Readonly
enqueueEnqueue task.
+Readonly
enqueueEnqueue task.
Type declaration
Parameters
The task to queue.
Returns number
Returns
The tasks queue size.
-Readonly
getGets task function worker usage statistics.
+Readonly
getGets task function worker usage statistics.
Type declaration
Parameters
The task function name.
Returns undefined | WorkerUsage
Returns
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).
+Readonly
hasWhether the worker node has back pressure (i.e. its tasks queue is full).
Type declaration
Returns boolean
Returns
-true
if the worker node has back pressure,false
otherwise.Readonly
infoWorker info.
-Optional
Readonly
messageMessage channel (worker thread only).
-Readonly
registerRegisters once a worker event handler.
+Readonly
infoWorker info.
+Optional
Readonly
messageMessage channel (worker thread only).
+Readonly
registerRegisters once a worker event handler.
Type declaration
Parameters
The event.
The event handler.
-Returns void
Readonly
registerRegisters a worker event handler.
+Returns void
Readonly
registerRegisters a worker event handler.
Type declaration
Parameters
The event.
The event handler.
-Returns void
Optional
strategyWorker choice strategy data. +
Returns void