FixedClusterPool | poolifier

+FixedClusterPool | poolifier

@@ -97,7 +97,7 @@

constructor

new FixedClusterPool<Data, Response>(numberOfWorkers: number, filePath: string, opts?: ClusterPoolOptions): FixedClusterPool<Data, Response>
new FixedClusterPool<Data, Response>(numberOfWorkers: number, filePath: string, opts?: ClusterPoolOptions): FixedClusterPool<Data, Response>
Constructs a new poolifier fixed cluster pool.

@@ -123,10 +123,10 @@
opts: ClusterPoolOptions = {}

Options for this fixed cluster pool.

Returns FixedClusterPool<Data, Response>

Properties

@@ -136,7 +136,7 @@

Inherit Doc

Defined in src/pools/abstract-pool.ts:37

`Readonly` filePath

filePath: string

@@ -144,7 +144,7 @@

Defined in src/pools/abstract-pool.ts:72

`Readonly` numberOfWorkers

numberOfWorkers: number

@@ -152,7 +152,7 @@

Defined in src/pools/abstract-pool.ts:71

`Readonly` opts

opts: ClusterPoolOptions = {}

@@ -160,10 +160,10 @@

Defined in src/pools/cluster/fixed.ts:53

`Protected` promiseResponseMap

promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...

The execution response promise map.

key: The message id of each submitted task.

Defined in src/pools/abstract-pool.ts:47

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

Worker choice strategy context referencing a worker choice algorithm implementation.

Default to a round robin algorithm.

Defined in src/pools/abstract-pool.ts:57

`Readonly` workerNodes

workerNodes: WorkerNode<Worker, Data>[] = []

Inherit Doc

Defined in src/pools/abstract-pool.ts:34

Accessors

@@ -203,7 +203,7 @@

Returns boolean

Defined in src/pools/cluster/fixed.ts:109

full

Returns boolean

Defined in src/pools/cluster/fixed.ts:104

`Private` numberOfQueuedTasks

Returns number

Defined in src/pools/abstract-pool.ts:182

`Private` numberOfRunningTasks

Returns number

Defined in src/pools/abstract-pool.ts:172

type

Returns PoolType

Defined in src/pools/cluster/fixed.ts:99

Methods

`Protected` afterTaskExecutionHook

afterTaskExecutionHook(worker: Worker, message: MessageValue<Response, unknown>): void
afterTaskExecutionHook(worker: Worker, message: MessageValue<Response, unknown>): void
Hook executed after the worker task execution. Can be overridden.
@@ -266,13 +266,13 @@ Can be overridden.

The worker.
-
message: MessageValue<Response, unknown>
+
message: MessageValue<Response, unknown>

The received message.

Returns void

Defined in src/pools/abstract-pool.ts:323

`Protected` afterWorkerSetup

Returns void

Defined in src/pools/cluster/fixed.ts:93

`Protected` beforeTaskExecutionHook

Returns void

Defined in src/pools/abstract-pool.ts:312

`Protected` chooseWorkerNode

chooseWorkerNode(): [number, WorkerNode<Worker, Data>]
chooseWorkerNode(): [number, WorkerNode<Worker, Data>]
Chooses a worker node for the next task.

The default uses a round robin algorithm to distribute the load.

Returns
[worker node key, worker node].

-
Returns [number, WorkerNode<Worker, Data>]
+
Returns [number, WorkerNode<Worker, Data>]
Inherited from AbstractPool.chooseWorkerNode
- Defined in src/pools/abstract-pool.ts:337

Defined in src/pools/abstract-pool.ts:356

`Protected` createAndSetupWorker

Returns Worker

Defined in src/pools/abstract-pool.ts:418

`Protected` createWorker

Returns Worker

Defined in src/pools/cluster/fixed.ts:88

destroy

Returns Promise<void>

Defined in src/pools/abstract-pool.ts:275

destroyWorker

Returns void

Defined in src/pools/cluster/fixed.ts:69

execute

execute(data: Data): Promise<Response>
execute(data: Data): Promise<Response>
Inherit Doc
@@ -384,11 +384,11 @@ Can be overridden.

Parameters
- -
  data: Data
-
Returns Promise<Response>
+
data: Data

Returns Promise<Response>

Defined in src/pools/abstract-pool.ts:244

findFreeWorkerNodeKey

Returns number

Defined in src/pools/abstract-pool.ts:237

`Protected` internalBusy

Returns boolean

Defined in src/pools/abstract-pool.ts:232

`Protected` isMain

Returns boolean

Defined in src/pools/cluster/fixed.ts:64

registerWorkerMessageListener

registerWorkerMessageListener<Message>(worker: Worker, listener: ((message: MessageValue<Message, unknown>) => void)): void
registerWorkerMessageListener<Message>(worker: Worker, listener: ((message: MessageValue<Message, unknown>) => void)): void
Inherit Doc
@@ -438,26 +438,26 @@ Can be overridden.
worker: Worker
-
listener: ((message: MessageValue<Message, unknown>) => void)
+
listener: ((message: MessageValue<Message, unknown>) => void)
- - (message: MessageValue<Message, unknown>): void
  - (message: MessageValue<Message, unknown>): void
  - Parameters
    - -
      message: MessageValue<Message, unknown>
    +
    message: MessageValue<Message, unknown>
  Returns void

Returns void

Defined in src/pools/cluster/fixed.ts:80

`Protected` sendToWorker

sendToWorker(worker: Worker, message: MessageValue<Data, unknown>): void
sendToWorker(worker: Worker, message: MessageValue<Data, unknown>): void
Inherit Doc
@@ -467,11 +467,11 @@ Can be overridden.
worker: Worker
-
message: MessageValue<Data, unknown>

message: MessageValue<Data, unknown>

Returns void

Defined in src/pools/cluster/fixed.ts:75

setWorkerChoiceStrategy

Returns void

Defined in src/pools/abstract-pool.ts:205

`Protected` setupHook

Returns void

Defined in src/pools/cluster/fixed.ts:59

`Protected` workerListener

workerListener(): ((message: MessageValue<Response, unknown>) => void)
workerListener(): ((message: MessageValue<Response, unknown>) => void)
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 message.
    @@ -522,15 +522,16 @@ Can be overridden.
    
    Parameters
    - -
      message: MessageValue<Response, unknown>
    +
    message: MessageValue<Response, unknown>
  Returns void

- + - + +

Generated using TypeDoc

\ No newline at end of file +

\ No newline at end of file

constructor

opts: ClusterPoolOptions = {}

Parameters

message: MessageValue<Message, unknown>

message: MessageValue<Message, unknown>

Parameters

message: MessageValue<Response, unknown>

message: MessageValue<Response, unknown>

Member Visibility

Theme