X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=d5a908208d680581c9e583711f2fbdba1aa39768;hb=e1d3eccbb484bfbe36f6dcb9c4ef22a11621a00b;hp=0498d0bee1ab114b1f7a2e65b4390afd3d1f9943;hpb=b08b5fc507f21848c9435380edb7d155e92eaaf5;p=poolifier.git
diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html
index 0498d0be..d5a90820 100644
--- a/docs/classes/FixedThreadPool.html
+++ b/docs/classes/FixedThreadPool.html
@@ -1,4 +1,4 @@
-FixedThreadPool | poolifier
+FixedThreadPool | poolifier
- Preparing search index...
-- The search index is not available
poolifier
+The search index is not availablepoolifier
Type of response of execution. This can only be serializable data.
+Type of execution response. This can only be serializable data.
Hierarchy
-- AbstractPool<ThreadWorkerWithMessageChannel, Data, Response>
+
- AbstractPool<ThreadWorkerWithMessageChannel, Data, Response>
- FixedThreadPool
- DynamicThreadPool
@@ -58,42 +58,40 @@emitter?
file
Properties
Accessors
-Methods
-constructor
-- new
+- new
-
Constructs a new poolifier fixed thread pool.
opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
Options for this fixed thread pool.
Returns FixedThreadPool<Data, Response>
Properties
OptionalReadonlyemitterInherit Doc
-Readonlyfile
-ProtectednextId of the next message.
+Path to the worker file.
-Readonlynumber
-Readonlyopts
-ProtectedpromiseThe promise map.
+
+ProtectedpromiseThe execution response 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.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 and resolve/reject the promise based on the message.
+When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
-ProtectedworkerWorker choice strategy instance implementing the worker choice algorithm.
-Default to a strategy implementing a round robin algorithm.
+Worker choice strategy context referencing a worker choice algorithm implementation.
+Default to a round robin algorithm.
+
+ReadonlyworkerPool worker nodes.
-ReadonlyworkersInherit Doc
-ReadonlyworkersInherit Doc
Inherited from AbstractPool.workerNodes
++- Defined in src/pools/abstract-pool.ts:39
Accessors
-busy
-+
+- get busy(): boolean
-
-
-
+
-
-
+ProtectedbusyInherit Doc
Whether the pool is busy or not.
+The pool busyness boolean status.
+Returns boolean
number
-+- Defined in src/pools/thread/fixed.ts:105
+Protectedfull+- get full(): boolean
+-
+
Whether the pool is full or not.
+The pool filling boolean status.
+Returns boolean
+Privatenumber+- get numberOfQueuedTasks(): number
+-
+
Number of tasks queued in the pool.
+Returns number
+PrivatenumberInherit Doc
Number of tasks running in the pool.
+Returns number
type
-- get type(): PoolType
+- get type(): PoolType
-
-
-
-
Inherit Doc
Returns PoolType
Methods
-
+ProtectedafterProtectedafter-- after
+- after
-
-
-- Defined in src/pools/thread/fixed.ts:85
+
+
-
+
+
+
+
+- Defined in src/pools/abstract-pool.ts:244
- setup
-
-
- Defined in src/pools/abstract-pool.ts:365
+- Defined in src/pools/abstract-pool.ts:509
+
+
-
-
-
+- constructor
+- emitter
+- file
+- number
+- opts
+- promise
+- worker
+- worker
+- busy
+- full
+- number
+- number
+- type
+- after
+- after
+- before
+- choose
+- create
+- create
+- destroy
+- destroy
+- enable
+- execute
+- find
+- internal
+- is
+- register
+- send
+- set
+- set
+- set
+- setup
+- worker
+
Hook executed after the worker task promise resolution. +
Hook executed after the worker task execution. Can be overridden.
Parameters
-
-
-
-
+- Defined in src/pools/abstract-pool.ts:391
- after
-
-
-
+
-
-
+
-message: MessageValue<Response, unknown>
-The received message.
+worker: ThreadWorkerWithMessageChannel
+The worker.
promise: PromiseWorkerResponseWrapper<ThreadWorkerWithMessageChannel, Response>
-The Promise response.
+message: MessageValue<Response, unknown>
+The received message.
Returns void
ProtectedafterInherit Doc
Function 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
+maxListenersor binding themain-worker<->workerconnection if not bind by default.Parameters
worker: ThreadWorkerWithMessageChannel
worker: ThreadWorkerWithMessageChannel
+The newly created worker.
+Returns void
+ProtectedbeforeProtectedbefore-- before
+- before
-
-
-- Defined in src/pools/abstract-pool.ts:380
+
+
-
-- Defined in src/pools/abstract-pool.ts:254
+
+
+
-- Defined in src/pools/abstract-pool.ts:312
+
+
-
-
-
-- Defined in src/pools/abstract-pool.ts:305
+
+
+- Defined in src/pools/abstract-pool.ts:300
- is
-
-
-
+
-
-
+
+
Hook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
Parameters
-
-
-worker: ThreadWorkerWithMessageChannel
-The worker.
+workerNodeKey: number
+The worker node key.
Returns void
+ProtectedchooseProtectedchoose-- choose
+- choose
-
-
- create
-
-
- Defined in src/pools/abstract-pool.ts:486
- create
-
-
-
+
+- Defined in src/pools/thread/fixed.ts:78
- destroy(): Promise<void>
-
-
-
+
-
-
+
+- destroy
-
-
-
+
-
-
+
-
-- Defined in src/pools/thread/fixed.ts:54
+
+
-
-
-
-
Chooses a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
+Chooses a worker node for the next task.
+The default uses a round robin algorithm to distribute the load.
-Returns
Worker.
+Returns
[worker node key, worker node].
Returns ThreadWorkerWithMessageChannel
ProtectedcreateCreates a new worker for this pool and sets it up completely.
+Creates a new worker and sets it up completely in the pool worker nodes.
Returns
New, completely set up worker.
Returns ThreadWorkerWithMessageChannel
+ProtectedcreateInherit Doc
Returns a newly created worker.
+Returns ThreadWorkerWithMessageChannel
destroy
Inherit Doc
Shutdowns every current worker in this pool.
+Returns Promise<void>
destroy
-+- Defined in src/pools/abstract-pool.ts:343
+ProtecteddestroyInherit Doc
Shutdowns the given worker.
+Parameters
worker: ThreadWorkerWithMessageChannel
worker: ThreadWorkerWithMessageChannel
+A worker within
+workerNodes.Returns Promise<void>
execute
+enable
-- execute(data: Data): Promise<Response>
+- enable
-
-
-
+
-
-
-
Inherit Doc
Enables/disables the worker tasks queue in this pool.
+Parameters
data: Data
Returns Promise<Response>
find
--- find
--
-
-
-
Inherit Doc
Returns false | ThreadWorkerWithMessageChannel
get
--- get
--
-
-
-
-
-
Inherit Doc
Parameters
-+-
-
enable: boolean
+Whether to enable or disable the worker tasks queue.
+worker: ThreadWorkerWithMessageChannel
Returns undefined | number
Returns void
get
+execute
-- get
+- execute(data: Data): Promise<Response>
-
-
-
+
-
-
-
Inherit Doc
Executes the function specified in the constructor with the task data input parameter.
+ +Returns
Promise that will be resolved when the task is successfully completed.
+Parameters
worker: ThreadWorkerWithMessageChannel
Returns number
Returns Promise<Response>
-get
+find
-- get
+- find
-
-
-
-
-
-
Inherit Doc
Parameters
---
-
worker: ThreadWorkerWithMessageChannel
Returns undefined | number
-Protectedinternal-- internal
--
-
-
-
Parameters
---
-
--
-
worker: ThreadWorkerWithMessageChannel
messageId: number
Returns Promise<Response>
+ProtectedinternalProtectedinternal-- internal
+- internal
-
Returns boolean
ProtectedisInherit Doc
Should return whether the worker is the main worker or not.
+Returns boolean
register
--- register
+- Defined in src/pools/thread/fixed.ts:49
+Protectedregister+- register
-
-
-
+
-
-
-
Inherit Doc
Registers a listener callback on the given worker.
+Type Parameters
@@ -493,104 +482,136 @@ Can be overridden.-
-
+
Parameters
messageChannel: ThreadWorkerWithMessageChannel
messageChannel: ThreadWorkerWithMessageChannel
+The worker which should register a listener.
+listener: ((message: MessageValue<Message, unknown>) => void)
+listener: ((message: MessageValue<Message, unknown>) => void)
+The message listener callback.
+-- (message: MessageValue<Message, unknown>): void
+- (message: MessageValue<Message, unknown>): void
-
-
-
+
Parameters
message: MessageValue<Message, unknown>
message: MessageValue<Message, unknown>
Returns void
Returns void
-
-Protectedremove-- remove
+- Defined in src/pools/thread/fixed.ts:70
+Protectedsend+- send
-
-
-
+
+
- Defined in src/pools/abstract-pool.ts:268
Removes the given worker from the pool.
+Sends a message to the given worker.
Parameters
-
-
+
-worker: ThreadWorkerWithMessageChannel
-The worker that will be removed.
+The worker which should receive the message.
+message: MessageValue<Data, unknown>
+The message.
Returns void
-Protectedsend-- send
+- Defined in src/pools/thread/fixed.ts:62
set
++- set
-
-
-
+
-
-
--
-
+
Inherit Doc
Sets the worker tasks queue options in this pool.
+Parameters
worker: ThreadWorkerWithMessageChannel
message: MessageValue<Data, unknown>
tasksQueueOptions: TasksQueueOptions
+The worker tasks queue options.
+Returns void
+set
-- set
+- set
-
-
-
+
-
-
+
+-
+
Inherit Doc
Sets the worker choice strategy in this pool.
+Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
+The worker choice strategy.
+
+OptionalworkerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Returns void
set
++- set
+-
+
+
Sets the worker choice strategy options in this pool.
+Parameters
++-
+
workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
+The worker choice strategy options.
+Returns void
ProtectedsetupSetup hook that can be overridden by a Poolifier pool implementation -to run code before workers are created in the abstract constructor.
+Setup hook to execute code before worker node are created in the abstract constructor. +Can be overridden
Returns void
+Protectedworker-- worker
+- worker
-
-
-
This function is the listener registered for each worker.
+This function is the listener registered for each worker message.
Returns
The listener function to execute when a message is received from a worker.
Returns ((message: MessageValue<Response, unknown>) => void)
+Returns ((message: MessageValue<Response, unknown>) => void)
-- (message: MessageValue<Response, unknown>): void
+- (message: MessageValue<Response, unknown>): void
-
-
-
-
This function is the listener registered for each worker.
+This function is the listener registered for each worker message.
Returns
The listener function to execute when a message is received from a worker.
Parameters
message: MessageValue<Response, unknown>
message: MessageValue<Response, unknown>
Returns void
-
+Settings
Settings
Member Visibility
Theme
Generated using TypeDoc