Protected workerThis function is the listener registered for each worker.
+ +The listener function to execute when a message is received from a worker.
+This function is the listener registered for each worker.
+ +The listener function to execute when a message is received from a worker.
+Generated using TypeDoc
A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.
-This thread pool creates new threads when the others are busy, up to the maximum number of threads. +
+- Preparing search index...
+- The search index is not available
poolifier+- poolifier
+- DynamicThreadPool
+Class DynamicThreadPool<Data, Response>
A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.
+This thread pool creates new threads when the others are busy, up to the maximum number of threads. When the maximum number of threads is reached, an event is emitted. If you want to listen to this event, use the pool's
-emitter.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 dynamic thread pool.
-Type parameters
Data = unknown
Response = unknown
Parameters
min: number
Minimum number of threads which are always active.
-max: number
Maximum number of threads that can be created by this pool.
-filePath: string
Path to an implementation of a
-ThreadWorkerfile, which can be relative or absolute.opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
Returns DynamicThreadPool<Data, Response>
Properties
Optional Readonly emitter
Readonly file
Readonly max
Protected next
Id of the next message.
-Readonly number
Readonly opts
Protected promise
The promise map.
-+ +
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
++- FixedThreadPool<Data, Response>
+
+- DynamicThreadPool
+
+Index
Constructors
+Properties
+Accessors
+Methods
+Constructors
+constructor
++- new
+-
+
+
+
+
+
Constructs a new poolifier dynamic thread pool.
+Type Parameters
++-
+
+-
+
Data = unknown
Response = unknown
Parameters
++-
+
+-
+
+-
+
+-
+
min: number
+Minimum number of threads which are always active.
+max: number
+Maximum number of threads that can be created by this pool.
+filePath: string
+Path to an implementation of a
+ThreadWorkerfile, which can be relative or absolute.opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
+Options for this dynamic thread pool.
+Returns DynamicThreadPool<Data, Response>
Properties
+
+OptionalReadonlyemitterInherit Doc
+Readonlyfile
+ProtectedReadonlymax
+ProtectednextId of the next message.
+
+Readonlynumber
+Readonlyopts
+ProtectedpromiseThe 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.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
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
Returns number
type
Returns PoolType
Methods
Protected after
Parameters
worker: ThreadWorkerWithMessageChannel
Returns void
Protected choose
Choose a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
-Returns ThreadWorkerWithMessageChannel
Worker.
-Protected create
Creates a new worker for this pool and sets it up completely.
-Returns ThreadWorkerWithMessageChannel
New, completely set up worker.
-Protected create
Returns ThreadWorkerWithMessageChannel
Protected decrease
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
Parameters
worker: ThreadWorkerWithMessageChannel
Returns Promise<void>
execute
Parameters
data: Data
Returns Promise<Response>
find
Returns false | [ThreadWorkerWithMessageChannel, number]
Protected increase
Increase the number of tasks that the given worker has applied.
-Parameters
worker: ThreadWorkerWithMessageChannel
Worker whose tasks are increased.
-Returns void
Protected internal
Parameters
worker: ThreadWorkerWithMessageChannel
messageId: number
Returns Promise<Response>
Protected internal
Returns boolean
Protected is
Returns boolean
register
Type parameters
Message
Parameters
messageChannel: ThreadWorkerWithMessageChannel
listener: (message: MessageValue<Message, unknown>) => void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Protected remove
Removes the given worker from the pool.
-Parameters
worker: ThreadWorkerWithMessageChannel
Worker that will be removed.
-Returns void
Protected send
Parameters
worker: ThreadWorkerWithMessageChannel
message: MessageValue<Data, unknown>
Returns void
set
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED"
Returns void
Protected setup
Setup hook that can be overridden by a Poolifier pool implementation +
+ProtectedworkerWorker choice strategy instance implementing the worker choice algorithm.
+Default to a strategy implementing a round robin algorithm.
+
+ReadonlyworkersInherit Doc
+ReadonlyworkersInherit Doc
Accessors
+busy
++- get busy(): boolean
+-
+
+
+
Inherit Doc
Returns boolean
number
++- get numberOfRunningTasks(): number
+-
+
+
+
Inherit Doc
Returns number
type
++- get type(): PoolType
+-
+
+
+
Inherit Doc
Returns PoolType
Methods
+
+Protectedafter+- after
+-
+
+
+
Hook executed after the worker task promise resolution. +Can be overridden.
+Parameters
++-
+
+-
+
message: MessageValue<Response, unknown>
+The received message.
+promise: PromiseWorkerResponseWrapper<ThreadWorkerWithMessageChannel, Response>
+The Promise response.
+Returns void
+Protectedafter+- after
+-
+
+
+
+
+
Inherit Doc
Parameters
++-
+
worker: ThreadWorkerWithMessageChannel
Returns void
+Protectedbefore+- before
+-
+
+
+
Hook executed before the worker task promise resolution. +Can be overridden.
+Parameters
++-
+
worker: ThreadWorkerWithMessageChannel
+The worker.
+Returns void
+Protectedchoose+- choose
+-
+
Chooses a worker for the next task.
+The default implementation uses a round robin algorithm to distribute the load.
+ +Returns
Worker.
+Returns ThreadWorkerWithMessageChannel
+Protectedcreate+- create
+-
+
Creates a new worker for this pool and sets it up completely.
+ +Returns
New, completely set up worker.
+Returns ThreadWorkerWithMessageChannel
+Protectedcreate+- create
+-
+
+
+
Inherit Doc
Returns ThreadWorkerWithMessageChannel
destroy
++- destroy(): Promise<void>
+-
+
+
+
Inherit Doc
Returns Promise<void>
destroy
++- destroy
+-
+
+
+
+
+
Inherit Doc
Parameters
++-
+
worker: ThreadWorkerWithMessageChannel
Returns Promise<void>
execute
++- execute(data: Data): Promise<Response>
+-
+
+
+
+
+
Inherit Doc
Parameters
++-
+
data: Data
Returns Promise<Response>
find
++- find
+-
+
+
+
Inherit Doc
Returns false | ThreadWorkerWithMessageChannel
get
++- get
+-
+
+
+
+
+
Inherit Doc
Parameters
++-
+
worker: ThreadWorkerWithMessageChannel
Returns undefined | number
get
++- get
+-
+
+
+
+
+
Inherit Doc
Parameters
++-
+
worker: ThreadWorkerWithMessageChannel
Returns number
get
++- get
+-
+
+
+
+
+
Inherit Doc
Parameters
++-
+
worker: ThreadWorkerWithMessageChannel
Returns undefined | number
+Protectedinternal+- internal
+-
+
+
+
Parameters
++-
+
+-
+
worker: ThreadWorkerWithMessageChannel
messageId: number
Returns Promise<Response>
+Protectedinternal+- internal
+-
+
Returns boolean
+Protectedis+- is
+-
+
+
+
Inherit Doc
Returns boolean
register
++- register
+-
+
+
+
+
+
+
+
Inherit Doc
Type Parameters
++-
+
Message
Parameters
++-
+
+-
+
messageChannel: ThreadWorkerWithMessageChannel
listener: ((message: MessageValue<Message, unknown>) => void)
++-
+
+- (message: MessageValue<Message, unknown>): void
+-
+
+
+
Parameters
++-
+
message: MessageValue<Message, unknown>
Returns void
Returns void
+Protectedremove+- remove
+-
+
+
+
Removes the given worker from the pool.
+Parameters
++-
+
worker: ThreadWorkerWithMessageChannel
+The worker that will be removed.
+Returns void
+Protectedsend+- send
+-
+
+
+
+
+
Inherit Doc
Parameters
++-
+
+-
+
worker: ThreadWorkerWithMessageChannel
message: MessageValue<Data, unknown>
Returns void
set
++- set
+-
+
+
+
+
+
Inherit Doc
Parameters
++-
+
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
Returns void
+Protectedsetup+- setup
+-
+
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
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