X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedThreadPool.html;h=2a68eb0cdd600770995af3c6a19f981d2de71afb;hb=71056a0ac555e096c1428d6341ef45c7980a6332;hp=de188c51b7a27b2207d87e0a875aafdb1fcd1642;hpb=d0f1dce33156fdb99f0ca3627839001909419497;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index de188c51..5d0045b7 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,55 +1,801 @@ -
Protected
Readonly
filePath to the worker file.
+Protected
Readonly
numberNumber of workers that this pool should manage.
+Protected
Readonly
optsOptions for this fixed thread pool.
+Protected
promiseThe execution response promise map.
+key
: The message id of each submitted task.value
: An object that contains the worker, the execution response promise resolve and reject callbacks.When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
+Protected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
+Default to a round robin algorithm.
+Readonly
workerPool worker nodes.
+Protected
busyWhether the pool is busy or not.
+The pool busyness boolean status.
+Protected
fullWhether the pool is full or not.
+The pool filling boolean status.
+Protected
maxPool maximum size.
+Protected
minPool minimum size.
+Protected
typePool type.
+If it is 'dynamic'
, it provides the max
property.
Protected
workerGets the worker type.
+Protected
afterHook executed after the worker task execution. +Can be overridden.
+The worker.
+The received message.
+Protected
afterFunction that can be hooked up when a worker has been newly created and moved to the pool worker nodes.
+Can be used to update the maxListeners
or binding the main-worker
<->worker
connection if not bind by default.
The newly created worker.
+Protected
beforeProtected
chooseProtected
createCreates a new worker and sets it up completely in the pool worker nodes.
+New, completely set up worker.
+ +Protected
createReturns a newly created worker.
+Protected
destroyShutdowns the given worker.
+A worker within workerNodes
.
Enables/disables the worker tasks queue in this pool.
+Whether to enable or disable the worker tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Executes the specified function in the worker constructor with the task data input parameter.
+Optional
data: DataThe task input data for the specified worker function. This can only be serializable data.
+Optional
name: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
+Promise that will be fulfilled when the task is completed.
+ +Protected
internalProtected
isProtected
registerRegisters a listener callback on the given worker.
+The worker which should register a listener.
+The message listener callback.
+Protected
sendSends a message to the given worker.
+The worker which should receive the message.
+The message.
+Sets the worker tasks queue options in this pool.
+The worker tasks queue options.
+Sets the worker choice strategy in this pool.
+The worker choice strategy.
+Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Sets the worker choice strategy options in this pool.
+The worker choice strategy options.
+Protected
setupProtected
workerThis function is the listener registered for each worker message.
+The listener function to execute when a message is received from a worker.
+ +This function is the listener registered for each worker message.
+The listener function to execute when a message is received from a worker.
+ +Generated using TypeDoc
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 execution response. 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, filePath, opts?): 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: ThreadPoolOptions = {}
+Options for this fixed thread pool.
+Returns FixedThreadPool<Data, Response>
+Properties
+
+Optional
Readonly
emitterEmitter on which events can be listened to.
+Events that can currently be listened to:
++
+
+
+
-'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.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