X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerNode.html;h=67f20e9503a443086699f95a0cd65f5fbcbbe16c;hb=a9fc134421fb6926f4eff76d1d82c9bd8b341606;hp=974a1631880b9f74c5bdde67b076c8b5bfe25cf8;hpb=e1ba9765afbf97436250d19f28c818221ebc10b9;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index 974a1631..67f20e95 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,7 +1,7 @@ -
Internal
Readonly
resetResets usage statistics.
+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
unshiftPrepends a task to the tasks queue.
+Readonly
terminateTerminates the worker node.
+Readonly
unshiftPrepends a task to the tasks queue.
The tasks queue size.
-Readonly
usageWorker usage statistics.
-Readonly
workerWorker.
-Optional
[captureRest
...args: AnyRestAlias for emitter.on(eventName, listener)
.
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 namedeventName
, 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 toInfinity
(or 0
) to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter
, so that calls can be chained.
v0.3.5
-Generated using TypeDoc
Generated using TypeDoc
Worker node interface.
+- Preparing search index...
- The search index is not available
poolifier - v3.1.29Interface IWorkerNode<Worker, Data>
Internal
Worker node interface.
    clearTasksQueue: (() => void);
    deleteTaskFunctionWorkerUsage: ((name) => boolean);
    dequeueTask: (() => undefined | Task<Data>);
    enqueueTask: ((task) => number);
    getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage);
    hasBackPressure: (() => boolean);
    info: WorkerInfo;
    messageChannel?: MessageChannel;
    popTask: (() => undefined | Task<Data>);
    registerOnceWorkerEventHandler: ((event, handler) => void);
    registerWorkerEventHandler: ((event, handler) => void);
    resetUsage: (() => void);
    strategyData?: StrategyData;
    tasksQueueBackPressureSize: number;
    tasksQueueSize: (() => number);
    terminate: (() => Promise<void>);
    unshiftTask: ((task) => number);
    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 task.
+Readonly
dequeueDequeue task.
Type declaration
Returns undefined | Task<Data>
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
popPops a task from the tasks queue.
+Readonly
infoWorker info.
+Optional
Readonly
messageMessage channel (worker thread only).
+Readonly
popPops a task from the tasks queue.
Type declaration
Returns undefined | Task<Data>
Returns
The popped task.
-Readonly
registerRegisters once a worker event handler.
+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
Readonly
resetResets usage statistics.
-Type declaration
Returns void
Optional
strategyWorker choice strategy data. +
Returns void