Protected runRuns the given task function synchronously.
+Task function that will be executed.
+Input data for the task function.
+Protected sendProtected sendSends a message to main worker.
+The response message.
+Sets the default task function to use in the worker.
+The name of the task function to use as default task function.
+Whether the default task function was set or not.
+Static bindBinds the given function to the current execution context.
+The function to bind to the current execution context.
+Optional type: stringAn optional name to associate with the underlying AsyncResource.
Optional thisArg: ThisArgv14.8.0, v12.19.0
+Generated using TypeDoc
A cluster worker used by a poolifier
+ClusterPool.- Preparing search index...
- The search index is not available
poolifier - v3.0.9Class ClusterWorker<Data, Response>
A cluster worker used by a poolifier
ClusterPool.When this worker is inactive for more than the given
maxInactiveTime, it will send a termination request to its main worker.If you use a
- -DynamicClusterPoolthe extra workers that were created will be terminated, but the minimum number of workers will be guaranteed.Author
Christopher Quadflieg
- -Since
2.0.0
-Type Parameters
---
-
--
-
Data = unknown
-Type of data this worker receives from pool's execution. This can only be serializable data.
-Response = unknown
-Type of response the worker sends back to the main worker. This can only be serializable data.
-Hierarchy
--- AbstractWorker<Worker, Data, Response>
-
-- ClusterWorker
-
-Index
Constructors
-Properties
-Methods
-Constructors
-constructor
--- new
--
-
-
-
-
-
Constructs a new poolifier cluster worker.
-Type Parameters
---
-
--
-
Data = unknown
Response = unknown
Parameters
---
-
--
-
fn: ((data: Data) => Response)
-Function processed by the worker when the pool's
-executionfunction is invoked.--
-
-- (data: Data): Response
--
-
-
-
Parameters
---
-
data: Data
Returns Response
opts: WorkerOptions = {}
-Options for the worker.
-Returns ClusterWorker<Data, Response>
Properties
-
-ProtectedOptionalReadonlyaliveHandler id of the
-aliveIntervalworker alive check.
-ProtectedReadonlyisWhether this is the main worker or not.
-
-ProtectedlastTimestamp of the last task processed by this worker.
-
-ProtectedmainReference to main worker.
-
-ProtectedReadonlyoptsOptions for the worker.
-Methods
-async
--- async
--
-
-
-
Returns
The unique
-asyncIdassigned to the resource.Returns number
bind
--- bind<Func>(fn: Func): Func & {
--
-
-
-
-
-
    asyncResource: AsyncResource;
}
Binds the given function to execute to this
-AsyncResource's scope.The returned function will have an
- -asyncResourceproperty referencing -theAsyncResourceto which the function is bound.Since
v14.8.0, v12.19.0
-Type Parameters
---
-
Func extends ((...args: any[]) => any)
Parameters
---
-
fn: Func
-The function to bind to the current
-AsyncResource.Returns Func & {
    asyncResource: AsyncResource;
}
-Protectedcheck-- check
--
-
Checks if the worker should be terminated, because its living too long.
-Returns void
emit
--- emit
--
-
Call all
destroyhooks. This should only ever be called once. An error will +Author
Christopher Quadflieg
+Since
2.0.0
+Type Parameters
Data = unknown
Type of data this worker receives from pool's execution. This can only be structured-cloneable data.
+Response = unknown
Type of response the worker sends back to the main worker. This can only be structured-cloneable data.
+Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Constructs a new poolifier cluster worker.
+Type Parameters
Data = unknown
Response = unknown
Parameters
taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>
Task function(s) processed by the worker when the pool's
+executionfunction is invoked.opts: WorkerOptions = {}
Options for the worker.
+Returns ClusterWorker<Data, Response>
Properties
ProtectedOptionalactiveHandler id of the
+activeIntervalworker activity check.ProtectedReadonlyisWhether this is the main worker or not.
+ProtectedlastTimestamp of the last task processed by this worker.
+ProtectedoptsOptions for the worker.
+ProtectedstatisticsPerformance statistics computation requirements.
+ProtectedtaskTask function(s) processed by the worker when the pool's
+executionfunction is invoked.Accessors
ProtectedidWorker id.
+Returns number
Methods
add
Adds a task function to the worker. +If a task function with the same name already exists, it is replaced.
+Parameters
name: string
The name of the task function to add.
+fn: TaskFunction<Data, Response>
The task function to add.
+Returns TaskFunctionOperationResult
Whether the task function was added or not.
+async
Returns number
The unique
+asyncIdassigned to the resource.bind
Binds the given function to execute to this
+AsyncResource's scope.Type Parameters
Func extends ((...args) => any)
Parameters
fn: Func
The function to bind to the current
+AsyncResource.Returns Func
Since
v14.8.0, v12.19.0
+emit
Call all
- -destroyhooks. This should only ever be called once. An error will be thrown if it is called more than once. This must be manually called. If the resource is left to be collected by the GC then thedestroyhooks will never be called.Returns
A reference to
-asyncResource.Returns ClusterWorker<Data, Response>
-Protectedget-- get
--
-
Returns the main worker.
- -Returns
Reference to the main worker.
-Returns Worker
-Protectedhandle-- handle
--
-
-
-
-
-
Inherit Doc
Parameters
---
-
e: string | Error
Returns string
-Protectedmessage-- message
--
-
-
-
Worker message listener.
-Parameters
---
-
--
-
message: MessageValue<Data, Worker>
-Message received.
-fn: ((data: Data) => Response)
-Function processed by the worker when the pool's
-executionfunction is invoked.--
-
-- (data: Data): Response
--
-
-
-
Parameters
---
-
data: Data
Returns Response
Returns void
-Protectedrun-- run(fn: ((data?: Data) => Response), message: MessageValue<Data, unknown>): void
--
-
-
-
Runs the given function synchronously.
-Parameters
---
-
--
-
fn: ((data?: Data) => Response)
-Function that will be executed.
---
-
-- (data?: Data): Response
--
-
-
-
Parameters
---
-
Optionaldata: DataReturns Response
message: MessageValue<Data, unknown>
-Input data for the given function.
-Returns void
-Protectedrun-- run
--
-
-
-
Runs the given function asynchronously.
-Parameters
---
-
--
-
fn: ((data?: Data) => Promise<Response>)
-Function that will be executed.
---
-
-- (data?: Data): Promise<Response>
--
-
-
-
Parameters
---
-
Optionaldata: DataReturns Promise<Response>
message: MessageValue<Data, unknown>
-Input data for the given function.
-Returns void
run
--- run
--
-
Call the provided function with the provided arguments in the execution context +
Returns ClusterWorker<Data, Response>
A reference to
+asyncResource.ProtectedgetReturns the main worker.
+Returns Worker
Reference to the main worker.
+Throws
https://nodejs.org/api/errors.html#class-error If the main worker is not set.
+ProtectedhandleHandles an error and convert it to a string so it can be sent back to the main worker.
+Parameters
error: string | Error
The error raised by the worker.
+Returns string
The error message.
+ProtectedhandleHandles a kill message sent by the main worker.
+Parameters
_message: MessageValue<Data, unknown>
Returns void
ProtectedhandleHandles the ready message sent by the main worker.
+Parameters
message: MessageValue<Data, unknown>
The ready message.
+Returns void
ProtectedhandleParameters
message: MessageValue<Data, unknown>
Returns void
has
Checks if the worker has a task function with the given name.
+Parameters
name: string
The name of the task function to check.
+Returns TaskFunctionOperationResult
Whether the worker has a task function with the given name or not.
+list
Lists the names of the worker's task functions.
+Returns string[]
The names of the worker's task functions.
+ProtectedmessageWorker message listener.
+Parameters
message: MessageValue<Data, unknown>
The received message.
+Returns void
remove
Removes a task function from the worker.
+Parameters
name: string
The name of the task function to remove.
+Returns TaskFunctionOperationResult
Whether the task function existed and was removed or not.
+ProtectedrunRuns the given task.
+Parameters
task: Task<Data>
The task to execute.
+Returns void
ProtectedrunRuns the given task function asynchronously.
+Parameters
fn: TaskAsyncFunction<Data, Response>
Task function that will be executed.
+task: Task<Data>
Input data for the task function.
+Returns void
run
Call the provided function with the provided arguments in the execution context of the async resource. This will establish the context, trigger the AsyncHooks before callbacks, call the function, trigger the AsyncHooks after callbacks, and then restore the original execution context.
- -Since
v9.6.0
-Type Parameters
---
-
--
-
This
Result
Parameters
---
-
--
-
--
-
fn: ((this: This, ...args: any[]) => Result)
-The function to call in the execution context of this async resource.
---
-
-- (this: This, ...args: any[]): Result
--
-
-
-
Parameters
---
-
--
-
this: This
Rest...args: any[]Returns Result
-OptionalthisArg: ThisThe receiver to be used for the function call.
-
-Rest...args: any[]Optional arguments to pass to the function.
-Returns Result
-Protectedsend-- send
--
-
-
-
-
-
Inherit Doc
Parameters
---
-
message: MessageValue<Response, unknown>
Returns void
trigger
--- trigger
--
-
-
-
Returns
The same
-triggerAsyncIdthat is passed to theAsyncResourceconstructor.Returns number
-Staticbind-- bind<Func, ThisArg>(fn: Func, type?: string, thisArg?: ThisArg): Func & {
--
-
-
-
-
-
    asyncResource: AsyncResource;
}
Binds the given function to the current execution context.
-The returned function will have an
- -asyncResourceproperty referencing -theAsyncResourceto which the function is bound.Since
v14.8.0, v12.19.0
-Type Parameters
---
-
--
-
Func extends ((this: ThisArg, ...args: any[]) => any)
ThisArg
Parameters
---
-
--
-
--
-
fn: Func
-The function to bind to the current execution context.
-
-Optionaltype: stringAn optional name to associate with the underlying
-AsyncResource.OptionalthisArg: ThisArgReturns Func & {
    asyncResource: AsyncResource;
}
-
-Settings
Member Visibility
Theme
-
-On This Page
-- constructor
-- alive
-- is
-- last
-- main
-- opts
-- async
-- bind
-- check
-- emit
-- get
-- handle
-- message
-- run
-- run
-- run
-- send
-- trigger
-- bind
Generated using TypeDoc
Type Parameters
This
Result
Parameters
fn: ((this, ...args) => Result)
The function to call in the execution context of this async resource.
+Parameters
this: This
Rest...args: any[]Returns Result
OptionalthisArg: ThisThe receiver to be used for the function call.
+Rest...args: any[]Optional arguments to pass to the function.
+Returns Result
Since
v9.6.0
+