X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=c2a8b6536daffaff46d340383a50c19f7e64e4cf;hb=dea288f11483ea6c15807b20e4c621483c7fa5af;hp=5cc045600ab87b42f1a226bd5547e8ebd23c3011;hpb=23d03397abcbf7274ba08acf89728bcaf32f0f6f;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 5cc04560..c2a8b653 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier
+AbstractPool | poolifier
@@ -18,19 +18,19 @@
-
Implements
-- IPool<Worker, Data, Response>
@@ -53,104 +53,109 @@
Constructors
-constructor
+
Properties
-emitter?
-
filePath
-
numberOfWorkers
-
opts
-
promiseResponseMap
-
workerChoiceStrategyContext
-
workerNodes
+
Accessors
-busy
-
full
-
numberOfQueuedTasks
-
numberOfRunningTasks
-
type
+
Constructors
-
+
constructor
-
-- new AbstractPool<Worker, Data, Response>(numberOfWorkers: number, filePath: string, opts: PoolOptions<Worker>): AbstractPool<Worker, Data, Response>
+
+- new AbstractPool<Worker, Data, Response>(numberOfWorkers, filePath, opts): AbstractPool<Worker, Data, Response>
-
-
-
-
Data = unknown
+Data = unknown
-
-
Response = unknown
+Response = unknown
Parameters
-
-
numberOfWorkers: number
+numberOfWorkers: number
-
-
filePath: string
-
-Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:77
Properties
-
+
Optional
Readonly
emitter
-
+
-
+
Readonly
filePath
-filePath: string
-
Returns void
-
+
Private
checkNumberOfWorkers
-
-- checkNumberOfWorkers(numberOfWorkers: number): void
+
+- checkNumberOfWorkers(numberOfWorkers): void
-
+
numberOfWorkers: number
Returns void
-
+
Private
checkPoolOptions
-
-- checkPoolOptions(opts: PoolOptions<Worker>): void
+
+- checkPoolOptions(opts): void
-
+
Returns void
-
+
+Private
checkValidTasksQueueOptions
+
+- checkValidTasksQueueOptions(tasksQueueOptions): void
+-
+
+
Returns void
+
Private
checkValidWorkerChoiceStrategy
-
-- checkValidWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void
+
+- checkValidWorkerChoiceStrategy(workerChoiceStrategy): void
-
Parameters
-
-
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
+workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
Returns void
-
+
+Private
checkValidWorkerChoiceStrategyOptions
+
+- checkValidWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void
+-
+
+
Returns void
+
Protected
chooseWorkerNode
-
-- chooseWorkerNode(): [number, WorkerNode<Worker, Data>]
+
+- chooseWorkerNode(): [number, WorkerNode<Worker, Data>]
-
-
Returns [number, WorkerNode<Worker, Data>]
-
+
Protected
createAndSetupWorker
-
-- createAndSetupWorker(): Worker
+
+- createAndSetupWorker(): Worker
-
-
Returns Worker
-
+
Protected
Abstract
createWorker
-
-- createWorker(): Worker
+
+- createWorker(): Worker
-
-
Returns Worker
-
+
Private
dequeueTask
-
-- dequeueTask(workerNodeKey: number): undefined | Task<Data>
+
+- dequeueTask(workerNodeKey): undefined | Task<Data>
-
-
Returns undefined | Task<Data>
+Returns undefined | Task<Data>
-
+
destroy
-
-- destroy(): Promise<void>
+
+- destroy(): Promise<void>
-
-
Returns Promise<void>
-
+
Protected
Abstract
destroyWorker
-
-- destroyWorker(worker: Worker): void | Promise<void>
+
+- destroyWorker(worker): void | Promise<void>
-
@@ -456,221 +509,203 @@ Can be overridden.
Parameters
-
-
worker: Worker
+worker: Worker
-Returns void | Promise<void>
+
+enableTasksQueue
+
+- enableTasksQueue(enable, tasksQueueOptions?): void
+-
+
+
+
Parameters
+
+-
+
enable: boolean
+
+-
+
+
+Returns void
-
+
Private
enqueueTask
-
-- enqueueTask(workerNodeKey: number, task: Task<Data>): number
+
+- enqueueTask(workerNodeKey, task): number
-
Parameters
-
-
workerNodeKey: number
+workerNodeKey: number
-
-
task: Task<Data>
+task: Task<Data>
Returns number
-
+
execute
-
-- execute(data: Data): Promise<Response>
+
+- execute(data?, name?): Promise<Response>
-
-
Returns void
-
-Private
flushTasksQueueByWorker
-
+
+Private
flushTasksQueues
+
+- flushTasksQueues(): void
-
-
Returns void
-
+
Private
getWorkerNodeKey
-
-- getWorkerNodeKey(worker: Worker): number
+
+- getWorkerNodeKey(worker): number
-
Parameters
-
-
worker: Worker
+worker: Worker
-Returns number
-
-Private
getWorkerTasksUsage
-
-- getWorkerTasksUsage(worker: Worker): undefined | TasksUsage
--
-
-
-
-
+
Protected
internalBusy
-
-- internalBusy(): boolean
+
+- internalBusy(): boolean
-
Returns boolean
-
+
Protected
Abstract
isMain
-
-- isMain(): boolean
+
+- isMain(): boolean
-
Returns boolean
-
+
Private
pushWorkerNode
-
-- pushWorkerNode(worker: Worker): number
+
+- pushWorkerNode(worker): number
-
Parameters
-
-
worker: Worker
+worker: Worker
-Returns number
-
+
Protected
Abstract
registerWorkerMessageListener
-
-- registerWorkerMessageListener<Message>(worker: Worker, listener: ((message: MessageValue<Message, unknown>) => void)): void
+
+- registerWorkerMessageListener<Message>(worker, listener): void
-
-
Parameters
-
-
worker: Worker
+worker: Worker
-
-
listener: ((message: MessageValue<Message, unknown>) => void)
+listener: ((message) => void)
-
-
-- (message: MessageValue<Message, unknown>): void
+
+- (message): void
-
+
message: MessageValue<Message, Worker | MessagePort>
Returns void
Returns void
-
+
Private
removeWorkerNode
-
-- removeWorkerNode(worker: Worker): void
+
+- removeWorkerNode(worker): void
-
@@ -678,16 +713,16 @@ Can be overridden.
Parameters
-
-
worker: Worker
+worker: Worker
Returns void
-
+
Protected
Abstract
sendToWorker
-
-- sendToWorker(worker: Worker, message: MessageValue<Data, unknown>): void
+
+- sendToWorker(worker, message): void
-
@@ -695,20 +730,38 @@ Can be overridden.
Parameters
-
-
worker: Worker
+worker: Worker
-
-
+
message: MessageValue<Data, Worker | MessagePort>
Returns void
-
+
+setTasksQueueOptions
+
+- setTasksQueueOptions(tasksQueueOptions): void
+-
+
+
+
Returns void
+
setWorkerChoiceStrategy
-
-- setWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void
+
+- setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void
-
@@ -716,17 +769,39 @@ Can be overridden.
Parameters
-
-
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
+workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
+-
+
+
+Returns void
+
+setWorkerChoiceStrategyOptions
+
+- setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void
+-
+
+
Returns void
-
+
Private
setWorkerNode
-
-- setWorkerNode(workerNodeKey: number, worker: Worker, tasksUsage: TasksUsage, tasksQueue: Task<Data>[]): void
+
+- setWorkerNode(workerNodeKey, worker, tasksUsage, tasksQueue): void
-
@@ -734,28 +809,28 @@ Can be overridden.
Parameters
-
-
workerNodeKey: number
+workerNodeKey: number
-
-
worker: Worker
+worker: Worker
-
-
+
-
-
tasksQueue: Task<Data>[]
+tasksQueue: Queue<Task<Data>>
Returns void
-
+
Private
setWorkerNodeTasksUsage
-
-- setWorkerNodeTasksUsage(workerNode: WorkerNode<Worker, Data>, tasksUsage: TasksUsage): void
+
+- setWorkerNodeTasksUsage(workerNode, tasksUsage): void
-
@@ -763,67 +838,65 @@ Can be overridden.
Parameters
Returns void
-
+
Protected
setupHook
-
-- setupHook(): void
+
+- setupHook(): void
-
Returns void
-
+
Private
tasksQueueSize
-
-- tasksQueueSize(workerNodeKey: number): number
+
+- tasksQueueSize(workerNodeKey): number
-
+
workerNodeKey: number
Returns number
-
+
Protected
workerListener
-
+Defined in src/pools/abstract-pool.ts:532
+Theme
On This Page
+constructor
+emitter
+filePath
+numberOfWorkers
+opts
+promiseResponseMap
+workerChoiceStrategyContext
+workerNodes
+busy
+full
+numberOfQueuedTasks
+numberOfRunningTasks
+size
+type
+afterTaskExecutionHook
+afterWorkerSetup
+beforeTaskExecutionHook
+buildTasksQueueOptions
+checkAndEmitEvents
+checkFilePath
+checkNumberOfWorkers
+checkPoolOptions
+checkValidTasksQueueOptions
+checkValidWorkerChoiceStrategy
+checkValidWorkerChoiceStrategyOptions
+chooseWorkerNode
+createAndSetupWorker
+createWorker
+dequeueTask
+destroy
+destroyWorker
+enableTasksQueue
+enqueueTask
+execute
+executeTask
+flushTasksQueue
+flushTasksQueues
+getWorkerNodeKey
+internalBusy
+isMain
+pushWorkerNode
+registerWorkerMessageListener
+removeWorkerNode
+sendToWorker
+setTasksQueueOptions
+setWorkerChoiceStrategy
+setWorkerChoiceStrategyOptions
+setWorkerNode
+setWorkerNodeTasksUsage
+setupHook
+tasksQueueSize
+workerListener
+PoolType
+AbstractPool
+AbstractWorker
+CircularArray
+ClusterWorker
+DynamicClusterPool
+DynamicThreadPool
+FixedClusterPool
+FixedThreadPool
+PoolEmitter
+Queue
+ThreadWorker
+WorkerChoiceStrategyContext
+ClusterPoolOptions
+IPool
+IWorker
+IWorkerChoiceStrategy
+MessageValue
+PoolOptions
+PromiseResponseWrapper
+RequiredStatistics
+Task
+TasksQueueOptions
+TasksUsage
+WorkerChoiceStrategyOptions
+WorkerNode
+WorkerOptions
+Draft
+ErrorHandler
+ExitHandler
+KillBehavior
+MessageHandler
+OnlineHandler
+PoolEvent
+TaskFunctions
+ThreadWorkerWithMessageChannel
+WorkerAsyncFunction
+WorkerChoiceStrategy
+WorkerFunction
+WorkerSyncFunction
+KillBehaviors
+PoolEvents
+WorkerChoiceStrategies
\ No newline at end of file
Base class that implements some shared logic for all poolifier pools.