repositories
/
poolifier.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Merge dependabot/npm_and_yarn/examples/typescript/http-server-pool/express-hybrid...
[poolifier.git]
/
src
/
pools
/
pool.ts
diff --git
a/src/pools/pool.ts
b/src/pools/pool.ts
index 73ca3aa105e477add5fd11d3d5cd19911c41f115..ccb4b5b94ef858ad00c0eb5a28c490651854489e 100644
(file)
--- a/
src/pools/pool.ts
+++ b/
src/pools/pool.ts
@@
-1,7
+1,13
@@
-import type { TransferListItem, WorkerOptions } from 'node:worker_threads'
-import type { EventEmitterAsyncResource } from 'node:events'
import type { ClusterSettings } from 'node:cluster'
import type { ClusterSettings } from 'node:cluster'
+import type { EventEmitterAsyncResource } from 'node:events'
+import type { TransferListItem, WorkerOptions } from 'node:worker_threads'
+
+import type { TaskFunctionProperties } from '../utility-types.js'
import type { TaskFunction } from '../worker/task-functions.js'
import type { TaskFunction } from '../worker/task-functions.js'
+import type {
+ WorkerChoiceStrategy,
+ WorkerChoiceStrategyOptions
+} from './selection-strategies/selection-strategies-types.js'
import type {
ErrorHandler,
ExitHandler,
import type {
ErrorHandler,
ExitHandler,
@@
-11,15
+17,14
@@
import type {
OnlineHandler,
WorkerType
} from './worker.js'
OnlineHandler,
WorkerType
} from './worker.js'
-import type {
- WorkerChoiceStrategy,
- WorkerChoiceStrategyOptions
-} from './selection-strategies/selection-strategies-types.js'
/**
* Enumeration of pool types.
*/
/**
* Enumeration of pool types.
*/
-export const PoolTypes = Object.freeze({
+export const PoolTypes: Readonly<{
+ fixed: 'fixed'
+ dynamic: 'dynamic'
+}> = Object.freeze({
/**
* Fixed pool type.
*/
/**
* Fixed pool type.
*/
@@
-38,7
+43,16
@@
export type PoolType = keyof typeof PoolTypes
/**
* Enumeration of pool events.
*/
/**
* Enumeration of pool events.
*/
-export const PoolEvents = Object.freeze({
+export const PoolEvents: Readonly<{
+ ready: 'ready'
+ busy: 'busy'
+ full: 'full'
+ empty: 'empty'
+ destroy: 'destroy'
+ error: 'error'
+ taskError: 'taskError'
+ backPressure: 'backPressure'
+}> = Object.freeze({
ready: 'ready',
busy: 'busy',
full: 'full',
ready: 'ready',
busy: 'busy',
full: 'full',
@@
-63,7
+77,7
@@
export interface PoolInfo {
readonly worker: WorkerType
readonly started: boolean
readonly ready: boolean
readonly worker: WorkerType
readonly started: boolean
readonly ready: boolean
- readonly
s
trategy: WorkerChoiceStrategy
+ readonly
defaultS
trategy: WorkerChoiceStrategy
readonly strategyRetries: number
readonly minSize: number
readonly maxSize: number
readonly strategyRetries: number
readonly minSize: number
readonly maxSize: number
@@
-171,7
+185,7
@@
export interface PoolOptions<Worker extends IWorker> {
*/
startWorkers?: boolean
/**
*/
startWorkers?: boolean
/**
- * The worker choice strategy to use in this pool.
+ * The
default
worker choice strategy to use in this pool.
*
* @defaultValue WorkerChoiceStrategies.ROUND_ROBIN
*/
*
* @defaultValue WorkerChoiceStrategies.ROUND_ROBIN
*/
@@
-243,7
+257,7
@@
export interface IPool<
*/
readonly workerNodes: Array<IWorkerNode<Worker, Data>>
/**
*/
readonly workerNodes: Array<IWorkerNode<Worker, Data>>
/**
- *
Event emitter integrated with async resource on which events can be listened to
.
+ *
Pool event emitter integrated with async resource
.
* The async tracking tooling identifier is `poolifier:<PoolType>-<WorkerType>-pool`.
*
* Events that can currently be listened to:
* The async tracking tooling identifier is `poolifier:<PoolType>-<WorkerType>-pool`.
*
* Events that can currently be listened to:
@@
-269,7
+283,7
@@
export interface IPool<
readonly execute: (
data?: Data,
name?: string,
readonly execute: (
data?: Data,
name?: string,
- transferList?: TransferListItem[]
+ transferList?:
readonly
TransferListItem[]
) => Promise<Response>
/**
* Starts the minimum number of workers in this pool.
) => Promise<Response>
/**
* Starts the minimum number of workers in this pool.
@@
-308,11
+322,11
@@
export interface IPool<
*/
readonly removeTaskFunction: (name: string) => Promise<boolean>
/**
*/
readonly removeTaskFunction: (name: string) => Promise<boolean>
/**
- * Lists the
names of task function
available in this pool.
+ * Lists the
properties of task functions
available in this pool.
*
*
- * @returns The
names of task function
available in this pool.
+ * @returns The
properties of task functions
available in this pool.
*/
*/
- readonly listTaskFunction
Names: () => string
[]
+ readonly listTaskFunction
sProperties: () => TaskFunctionProperties
[]
/**
* Sets the default task function in this pool.
*
/**
* Sets the default task function in this pool.
*
@@
-321,9
+335,9
@@
export interface IPool<
*/
readonly setDefaultTaskFunction: (name: string) => Promise<boolean>
/**
*/
readonly setDefaultTaskFunction: (name: string) => Promise<boolean>
/**
- * Sets the worker choice strategy in this pool.
+ * Sets the
default
worker choice strategy in this pool.
*
*
- * @param workerChoiceStrategy - The worker choice strategy.
+ * @param workerChoiceStrategy - The
default
worker choice strategy.
* @param workerChoiceStrategyOptions - The worker choice strategy options.
*/
readonly setWorkerChoiceStrategy: (
* @param workerChoiceStrategyOptions - The worker choice strategy options.
*/
readonly setWorkerChoiceStrategy: (
@@
-334,10
+348,11
@@
export interface IPool<
* Sets the worker choice strategy options in this pool.
*
* @param workerChoiceStrategyOptions - The worker choice strategy options.
* Sets the worker choice strategy options in this pool.
*
* @param workerChoiceStrategyOptions - The worker choice strategy options.
+ * @returns `true` if the worker choice strategy options were set, `false` otherwise.
*/
readonly setWorkerChoiceStrategyOptions: (
workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
*/
readonly setWorkerChoiceStrategyOptions: (
workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
- ) =>
void
+ ) =>
boolean
/**
* Enables/disables the worker node tasks queue in this pool.
*
/**
* Enables/disables the worker node tasks queue in this pool.
*