X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedThreadPool.html;h=a02b125a6471ad45875d111e4d8eaf14bed4b993;hb=74f29142ea20199700ef7021402616ea9de714a8;hp=de188c51b7a27b2207d87e0a875aafdb1fcd1642;hpb=d0f1dce33156fdb99f0ca3627839001909419497;p=poolifier.git
diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html
index de188c51..a02b125a 100644
--- a/docs/classes/FixedThreadPool.html
+++ b/docs/classes/FixedThreadPool.html
@@ -1,55 +1,690 @@
-
FixedThreadPool | poolifierClass FixedThreadPool<Data, Response>
+
+Protected
workerChoiceStrategyContext
+
+
+
+Readonly
workerNodes
+
+
+
+Accessors
+
+busy
+
+- get busy(): boolean
+-
+
+
Returns boolean
+
+full
+
+- get full(): boolean
+-
+
+
Returns boolean
+
+Private
numberOfQueuedTasks
+
+- get numberOfQueuedTasks(): number
+-
+
+
Returns number
+
+Private
numberOfRunningTasks
+
+- get numberOfRunningTasks(): number
+-
+
+
Returns number
+
+type
+
+- get type(): PoolType
+-
+
+
Returns PoolType
+
+Methods
+
+Protected
afterPromiseResponseHook
+
+- afterPromiseResponseHook(worker: ThreadWorkerWithMessageChannel, message: MessageValue<Response, unknown>): void
+-
+
+
+
Parameters
+
+-
+
+
+-
+
message: MessageValue<Response, unknown>
+
+Returns void
+
+Protected
afterWorkerSetup
+
+
+Protected
beforePromiseResponseHook
+
+- beforePromiseResponseHook(workerNodeKey: number): void
+-
+
+
+
Parameters
+
+-
+
workerNodeKey: number
+
+Returns void
+
+Protected
chooseWorkerNode
+
+
+Protected
createAndSetupWorker
+
+
+Protected
createWorker
+
+
+Protected
dequeueTask
+
+- dequeueTask(workerNodeKey: number): undefined | Task<Data>
+-
+
+
Returns undefined | Task<Data>
+
+destroy
+
+- destroy(): Promise<void>
+-
+
+
Returns Promise<void>
+
+
+Protected
enqueueTask
+
+- enqueueTask(workerNodeKey: number, task: Task<Data>): void
+-
+
+
Parameters
+
+-
+
workerNodeKey: number
+-
+
task: Task<Data>
+Returns void
+
+execute
+
+- execute(data: Data): Promise<Response>
+-
+
+
+
Returns Promise<Response>
+
+findFreeWorkerNodeKey
+
+- findFreeWorkerNodeKey(): number
+-
+
+
Returns number
+
+Protected
flushTasksQueue
+
+- flushTasksQueue(workerNodeKey: number): void
+-
+
+
Returns void
+
+Protected
flushTasksQueueByWorker
+
+
+Protected
internalBusy
+
+- internalBusy(): boolean
+-
+
Returns boolean
+
+Protected
isMain
+
+- isMain(): boolean
+-
+
+
Returns boolean
+
+registerWorkerMessageListener
+
+- registerWorkerMessageListener<Message>(messageChannel: ThreadWorkerWithMessageChannel, listener: ((message: MessageValue<Message, unknown>) => void)): void
+-
+
+
+
+
Parameters
+
+-
+
+-
+
listener: ((message: MessageValue<Message, unknown>) => void)
+
+-
+
+- (message: MessageValue<Message, unknown>): void
+-
+
+
Parameters
+
+-
+
message: MessageValue<Message, unknown>
+Returns void
+Returns void
+
+Protected
removeWorkerNode
+
+
+Protected
sendToWorker
+
+- sendToWorker(worker: ThreadWorkerWithMessageChannel, message: MessageValue<Data, unknown>): void
+-
+
+
+
Parameters
+
+-
+
+-
+
message: MessageValue<Data, unknown>
+Returns void
+
+setWorkerChoiceStrategy
+
+- setWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void
+-
+
+
+
Parameters
+
+-
+
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
+Returns void
+
+Protected
setupHook
+
+- setupHook(): void
+-
+
+
Returns void
+
+Protected
tasksQueueLength
+
+- tasksQueueLength(workerNodeKey: number): number
+-
+
+
Returns number
+
+Protected
workerListener
+
+- workerListener(): ((message: MessageValue<Response, unknown>) => void)
+-
+
+
Returns ((message: MessageValue<Response, unknown>) => void)
+
+-
+
+- (message: MessageValue<Response, unknown>): void
+-
+
+
+
Parameters
+
+-
+
message: MessageValue<Response, unknown>
+Returns void
+
+
+
\ No newline at end of file
A thread pool with a fixed number of threads.
-It is possible to perform tasks in sync or asynchronous mode as you prefer.
++- Preparing search index...
+- The search index is not available
poolifier+- poolifier
+- FixedThreadPool
+Class FixedThreadPool<Data, Response>
A thread pool with a fixed number of threads.
+It is possible to perform tasks in sync or asynchronous mode as you prefer.
This pool selects the threads in a round robin fashion.
-of data sent to the worker. This can only be serializable data.
-of response of execution. This can only be serializable data.
-Alessandro Pio Ardizio
-0.0.1
-Type parameters
Data = unknown
Response = unknown
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Constructs a new poolifier fixed thread pool.
-Type parameters
Data = unknown
Response = unknown
Parameters
numberOfThreads: number
Number of threads for this pool.
-filePath: string
Path to an implementation of a
-ThreadWorker
file, which can be relative or absolute.opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
Returns FixedThreadPool<Data, Response>
Properties
Optional Readonly emitter
Readonly file Path
Optional Readonly max
Protected next Message Id
Id of the next message.
-Readonly number Of Workers
Readonly opts
Protected promise Map
The promise map.
--
-
+
+
key
: This is the message Id of each submitted task.value
: An object that contains the worker, the resolve function and the reject function.Author
Alessandro Pio Ardizio
+ +Since
0.0.1
+Type Parameters
++-
+
+-
+
Data = unknown
+Type of data sent to the worker. This can only be serializable data.
+Response = unknown
+Type of response of execution. This can only be serializable data.
+Hierarchy
++- AbstractPool<ThreadWorkerWithMessageChannel, Data, Response>
+
+- FixedThreadPool
+
+- DynamicThreadPool
+
+Index
Constructors
+Properties
+Accessors
+Methods
+Constructors
+constructor
++- new
Fixed Thread Pool<Data, Response>(numberOfThreads: number, filePath: string, opts?: PoolOptions<ThreadWorkerWithMessageChannel>): FixedThreadPool<Data, Response>
+-
+
+
+
+
+
+
Constructs a new poolifier fixed thread pool.
+Type Parameters
++-
+
+-
+
Data = unknown
Response = unknown
Parameters
++-
+
+-
+
+-
+
numberOfThreads: number
+Number of threads for this pool.
+filePath: string
+Path to an implementation of a
+ThreadWorker
file, which can be relative or absolute.opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
+Options for this fixed thread pool.
+Returns FixedThreadPool<Data, Response>
Properties
+
+Optional
Readonly
emitterInherit Doc
Path
+Readonly
filePath to the worker-file.
+ Of Workers
+Readonly
numberNumber of workers that this pool should manage.
+
+Readonly
optsOptions for the pool.
+ Response Map
+Protected
promiseThe promise response map.
++
+
-key
: The message id of each submitted task.value
: An object that contains the worker, the promise resolve and reject callbacks.When we receive a message from the worker we get a map entry and resolve/reject the promise based on the message.
-Readonly tasks
Protected worker Choice Strategy Context
Worker choice strategy instance implementing the worker choice algorithm.
-Default to a strategy implementing a round robin algorithm.
-Readonly workers
Accessors
busy
Returns boolean
number Of Running Tasks
Returns number
type
Returns PoolType
Methods
Protected after Worker Setup
Parameters
worker: ThreadWorkerWithMessageChannel
Returns void
Protected choose Worker
Choose a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
-Returns ThreadWorkerWithMessageChannel
Worker.
-Protected create And Setup Worker
Creates a new worker for this pool and sets it up completely.
-Returns ThreadWorkerWithMessageChannel
New, completely set up worker.
-Protected create Worker
Returns ThreadWorkerWithMessageChannel
Protected decrease Workers Tasks
Decrease the number of tasks that the given worker has applied.
-Parameters
worker: ThreadWorkerWithMessageChannel
Worker whose tasks are decreased.
-Returns void
destroy
Returns Promise<void>
destroy Worker
Parameters
worker: ThreadWorkerWithMessageChannel
Returns Promise<void>
execute
Parameters
data: Data
Returns Promise<Response>
find Free Tasks Map Entry
Returns false | [ThreadWorkerWithMessageChannel, number]
Protected increase Workers Task
Increase the number of tasks that the given worker has applied.
-Parameters
worker: ThreadWorkerWithMessageChannel
Worker whose tasks are increased.
-Returns void
Protected internal Execute
Parameters
worker: ThreadWorkerWithMessageChannel
messageId: number
Returns Promise<Response>
Protected internal Get Busy Status
Returns boolean
Protected is Main
Returns boolean
register Worker Message Listener
Type parameters
Message
Parameters
messageChannel: ThreadWorkerWithMessageChannel
listener: (message: MessageValue<Message, unknown>) => void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Protected remove Worker
Removes the given worker from the pool.
-Parameters
worker: ThreadWorkerWithMessageChannel
Worker that will be removed.
-Returns void
Protected send To Worker
Parameters
worker: ThreadWorkerWithMessageChannel
message: MessageValue<Data, unknown>
Returns void
set Worker Choice Strategy
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED"
Returns void
Protected setup Hook
Setup hook that can be overridden by a Poolifier pool implementation -to run code before workers are created in the abstract constructor.
-Returns void
Protected worker Listener
This function is the listener registered for each worker.
-Returns (message: MessageValue<Response, unknown>) => void
The listener function to execute when a message is sent from a worker.
-This function is the listener registered for each worker.
-Parameters
message: MessageValue<Response, unknown>
Returns void
The listener function to execute when a message is sent from a worker.
-Generated using TypeDoc
When we receive a message from the worker we get a map entry with the promise resolve/reject bound to the message.
+