X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=467df5ca6e9726e7ed57b27986643bda443b2a55;hb=3dcc95e54a6bfeb4b27460d60d3c90d27ac352dd;hp=615fc4f1189c3214a2b6cbb099f1881ad3a32c53;hpb=281c4c4798ff3366a0efb1f65a80b451804bedab;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 615fc4f1..467df5ca 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,15 +1,16 @@ -IPool | poolifier - v3.1.21

Interface IPool<Worker, Data, Response>

Contract definition for a poolifier pool.

-
interface IPool<Worker, Data, Response> {
    addTaskFunction: ((name, fn) => Promise<boolean>);
    destroy: (() => Promise<void>);
    emitter?: EventEmitterAsyncResource;
    enableTasksQueue: ((enable, tasksQueueOptions?) => void);
    execute: ((data?, name?, transferList?) => Promise<Response>);
    hasTaskFunction: ((name) => boolean);
    info: PoolInfo;
    listTaskFunctionNames: (() => string[]);
    removeTaskFunction: ((name) => Promise<boolean>);
    setDefaultTaskFunction: ((name) => Promise<boolean>);
    setTasksQueueOptions: ((tasksQueueOptions) => void);
    setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void);
    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void);
    start: (() => void);
    workerNodes: IWorkerNode<Worker, Data>[];
}

Type Parameters

Implemented by

Properties

addTaskFunction destroy emitter? enableTasksQueue execute hasTaskFunction info -listTaskFunctionNames +listTaskFunctionsProperties +mapExecute removeTaskFunction setDefaultTaskFunction setTasksQueueOptions @@ -17,54 +18,60 @@ setWorkerChoiceStrategyOptions start workerNodes -

Properties

Readonly addTaskFunction

addTaskFunction: ((name, fn) => Promise<boolean>)

Adds a task function to this pool. +

Properties

ReadonlyaddTaskFunction

addTaskFunction: ((name: string, fn: TaskFunction<Data, Response> | TaskFunctionObject<Data, Response>) => Promise<boolean>)

Adds a task function to this pool. If a task function with the same name already exists, it will be overwritten.

Type declaration

    • (name, fn): Promise<boolean>

    • Parameters

      Returns Promise<boolean>

Returns

true if the task function was added, false otherwise.

-

Throws

https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.

-

Throws

https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.

-

Readonly destroy

destroy: (() => Promise<void>)

Terminates all workers in this pool.

-

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

Optional Readonly emitter

emitter?: EventEmitterAsyncResource

Event emitter integrated with async resource on which events can be listened to. +

  • fn: TaskFunction<Data, Response> | TaskFunctionObject<Data, Response>

    The task function.

    +

    • Returns Promise<boolean>

    true if the task function was added, false otherwise.

    +

    Throws

    https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.

    +

    Throws

    https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function or task function object.

    +

    Readonlydestroy

    destroy: (() => Promise<void>)

    Terminates all workers in this pool.

    +

    Optional Readonlyemitter

    emitter?: EventEmitterAsyncResource

    Pool event emitter integrated with async resource. The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    Events that can currently be listened to:

    -

    Readonly enableTasksQueue

    enableTasksQueue: ((enable, tasksQueueOptions?) => void)

    Enables/disables the worker node tasks queue in this pool.

    +

    ReadonlyenableTasksQueue

    enableTasksQueue: ((enable: boolean, tasksQueueOptions?: TasksQueueOptions) => void)

    Enables/disables the worker node tasks queue in this pool.

    Type declaration

    Readonly execute

    execute: ((data?, name?, transferList?) => Promise<Response>)

    Executes the specified function in the worker constructor with the task data input parameter.

    -

    Type declaration

    Returns

    Promise that will be fulfilled when the task is completed.

    -

    Readonly hasTaskFunction

    hasTaskFunction: ((name) => boolean)

    Whether the specified task function exists in this pool.

    +
  • OptionaltasksQueueOptions: TasksQueueOptions

    The worker node tasks queue options.

    +

    • Returns void

    Readonlyexecute

    execute: ((data?: Data, name?: string, transferList?: readonly TransferListItem[]) => Promise<Response>)

    Executes the specified function in the worker constructor with the task data input parameter.

    +

    Type declaration

    ReadonlyhasTaskFunction

    hasTaskFunction: ((name: string) => boolean)

    Whether the specified task function exists in this pool.

    Type declaration

    Returns

    true if the task function exists, false otherwise.

    -

    Readonly info

    info: PoolInfo

    Pool information.

    -

    Readonly listTaskFunctionNames

    listTaskFunctionNames: (() => string[])

    Lists the names of task function available in this pool.

    -

    Type declaration

    Returns

    The names of task function available in this pool.

    -

    Readonly removeTaskFunction

    removeTaskFunction: ((name) => Promise<boolean>)

    Removes a task function from this pool.

    -

    Type declaration

    Returns

    true if the task function was removed, false otherwise.

    -

    Readonly setDefaultTaskFunction

    setDefaultTaskFunction: ((name) => Promise<boolean>)

    Sets the default task function in this pool.

    -

    Type declaration

    Returns

    true if the default task function was set, false otherwise.

    -

    Readonly setTasksQueueOptions

    setTasksQueueOptions: ((tasksQueueOptions) => void)

    Sets the worker node tasks queue options in this pool.

    -

    Type declaration

    Readonly setWorkerChoiceStrategy

    setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)

    Sets the worker choice strategy in this pool.

    -

    Type declaration

    Readonly setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)

    Sets the worker choice strategy options in this pool.

    -

    Type declaration

    Readonly start

    start: (() => void)

    Starts the minimum number of workers in this pool.

    -

    Type declaration

    Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[]

    Pool worker nodes.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    true if the task function exists, false otherwise.

    +

    Readonlyinfo

    info: PoolInfo

    Pool information.

    +

    ReadonlylistTaskFunctionsProperties

    listTaskFunctionsProperties: (() => TaskFunctionProperties[])

    Lists the properties of task functions available in this pool.

    +

    Type declaration

    ReadonlymapExecute

    mapExecute: ((data: Iterable<Data>, name?: string, transferList?: readonly TransferListItem[]) => Promise<Response[]>)

    Executes the specified function in the worker constructor with the tasks data iterable input parameter.

    +

    Type declaration

    ReadonlyremoveTaskFunction

    removeTaskFunction: ((name: string) => Promise<boolean>)

    Removes a task function from this pool.

    +

    Type declaration

    ReadonlysetDefaultTaskFunction

    setDefaultTaskFunction: ((name: string) => Promise<boolean>)

    Sets the default task function in this pool.

    +

    Type declaration

    ReadonlysetTasksQueueOptions

    setTasksQueueOptions: ((tasksQueueOptions: TasksQueueOptions) => void)

    Sets the worker node tasks queue options in this pool.

    +

    Type declaration

    ReadonlysetWorkerChoiceStrategy

    setWorkerChoiceStrategy: ((workerChoiceStrategy:
        | "ROUND_ROBIN"
        | "LEAST_USED"
        | "LEAST_BUSY"
        | "LEAST_ELU"
        | "FAIR_SHARE"
        | "WEIGHTED_ROUND_ROBIN"
        | "INTERLEAVED_WEIGHTED_ROUND_ROBIN", workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions) => void)

    Sets the default worker choice strategy in this pool.

    +

    Type declaration

    ReadonlysetWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions: WorkerChoiceStrategyOptions) => boolean)

    Sets the worker choice strategy options in this pool.

    +

    Type declaration

    Readonlystart

    start: (() => void)

    Starts the minimum number of workers in this pool.

    +

    Readonly InternalworkerNodes

    workerNodes: IWorkerNode<Worker, Data>[]

    Pool worker nodes.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file