@@ -44,7 +44,7 @@
+
Defined in src/pools/thread/fixed.ts:29
@@ -58,42 +58,44 @@
Properties
+
Defined in src/pools/thread/fixed.ts:40
Properties
@@ -140,71 +142,61 @@
Inherit Doc
+
Defined in src/pools/abstract-pool.ts:33
Readonly filePath
-filePath: string
-
-Protected nextMessageId
-nextMessageId: number = 0
-
Id of the next message.
+Path to the worker-file.
-Readonlynumber
-Readonlyopts
-ProtectedpromiseThe promise map.
+
+ProtectedpromiseThe promise response 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 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.
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.
-Readonlyworkers
+ReadonlyworkerInherit Doc
-ReadonlyworkersInherit Doc
Accessors
Returns boolean
number
--- get numberOfRunningTasks(): number
+- Defined in src/pools/thread/fixed.ts:105
full
++- get full(): boolean
-
+
Inherit Doc
Returns boolean
+Privatenumber+- get numberOfQueuedTasks(): number
+-
+
Number of tasks queued in the pool.
+Returns number
+Privatenumber+- get numberOfRunningTasks(): number
+-
+
Number of tasks running in the pool.
+Returns number
type
@@ -239,13 +253,13 @@
Returns PoolType
Methods
-
+ProtectedafterProtectedafter-- after
+- after
-
-
-
-
-
+- Defined in src/pools/abstract-pool.ts:307
-
-- Defined in src/pools/thread/fixed.ts:85
+
+
Hook executed after the worker task promise resolution. Can be overridden.
@@ -254,17 +268,17 @@ Can be overridden.Parameters
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
Protectedafter@@ -280,11 +294,11 @@ Can be overridden.
Returns void
+ProtectedbeforeProtectedbefore-- before
+- before
-
-- Defined in src/pools/abstract-pool.ts:296
+
+
Hook executed before the worker task promise resolution. Can be overridden.
@@ -293,40 +307,40 @@ 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:406
+- Defined in src/pools/thread/fixed.ts:78
+
+
+- Defined in src/pools/abstract-pool.ts:259
+- Defined in src/pools/thread/fixed.ts:54
+
+
-
-- Defined in src/pools/abstract-pool.ts:236
+
+
-
-
-
-
+
+
-
-
+
+
-
-- Defined in src/pools/abstract-pool.ts:572
+
+
+- Defined in src/pools/abstract-pool.ts:221
+- Defined in src/pools/thread/fixed.ts:49
-
-- Defined in src/pools/thread/fixed.ts:70
+
+
+- Defined in src/pools/abstract-pool.ts:189
- setup
-
-
- Defined in src/pools/abstract-pool.ts:281
+
+
- worker
-
-
- (message: MessageValue<Response, unknown>): void
-
-
- Defined in src/pools/abstract-pool.ts:429
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
+Protectedcreate@@ -337,7 +351,21 @@ Can be overridden.
Returns ThreadWorkerWithMessageChannel
+Protecteddequeue+- dequeue
+-
+
+
+
Parameters
++-
+
workerNodeKey: number
Returns undefined | Task<Data>
destroy
@@ -348,7 +376,7 @@ Can be overridden.
Returns Promise<void>
destroy
@@ -364,7 +392,23 @@ Can be overridden.
Returns Promise<void>
+Protectedenqueue+- enqueue
+-
+
+
+
Parameters
++-
+
+-
+
workerNodeKey: number
task: Task<Data>
Returns void
execute
@@ -380,75 +424,55 @@ Can be overridden.
Returns Promise<Response>
find
+find
-- find
+- find
-
-
Inherit Doc
Returns false | ThreadWorkerWithMessageChannel
get
--- get
--
-
-
-
-
-
Inherit Doc
Parameters
---
-
worker: ThreadWorkerWithMessageChannel
Returns undefined | number
get
--- get
+- Defined in src/pools/abstract-pool.ts:229
+Protectedflush+- flush
-
-
-
-
-
-
Inherit Doc
Parameters
worker: ThreadWorkerWithMessageChannel
Returns number
Returns void
get
--- get
+- Defined in src/pools/abstract-pool.ts:563
+Protectedflush+- flush
-
-
-
-
-
Inherit Doc
Parameters
worker: ThreadWorkerWithMessageChannel
Returns undefined | number
+ProtectedinternalProtectedinternal-- internal
+- internal
-
Returns boolean
Protectedis@@ -459,7 +483,7 @@ Can be overridden.
Returns boolean
register
@@ -493,25 +517,25 @@ Can be overridden.
Returns void
+ProtectedremoveProtectedremove-- remove
+- remove
-
-
- Defined in src/pools/abstract-pool.ts:545
+- Defined in src/pools/thread/fixed.ts:62
+
Removes the given worker from the pool.
+Removes the given worker from the pool worker nodes.
Parameters
-
+worker: ThreadWorkerWithMessageChannel
-The worker that will be removed.
+The worker.
Returns void
Protectedsend@@ -529,11 +553,11 @@ Can be overridden.
Returns void
set
-- set
+- set
-
@@ -541,29 +565,43 @@ Can be overridden.
-
-
Inherit Doc
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
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 run code before worker node are created in the abstract constructor. +Can be overridden
Returns void
+
+Protectedtasks+- tasks
+-
+
+
+
Parameters
++-
+
workerNodeKey: number
Returns number
ProtectedworkerThis 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.
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 void
@@ -614,36 +652,38 @@ to run code before workers are created in the abstract constructor.- constructor
- emitter?
- file
-- next
- number
- opts
-- promise
+- promise
- worker
-- workers
-- workers
+- worker
- busy
-- number
+- full
+- number
+- number
- type
-- after
+- after
- after
-- before
-- choose
+- before
+- choose
- create
- create
+- dequeue
- destroy
- destroy
+- enqueue
- execute
-- find
-- get
-- get
-- get
-- internal
+- find
+- flush
+- flush
+- internal
- is
- register
-- remove
+- remove
- send
- set
- setup
+- tasks
- worker
Generated using TypeDoc