X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FThreadWorker.html;h=fc092ca1a89ff43ecd92c6f604c7b3b3508bb71e;hb=405b39c2835f645e2193dc30c3d190e3dcf3bc3e;hp=dc2272a1f923c2053e334e740c3955925eb41feb;hpb=a76fac14098cf2138cf8d6997ac7c89d8c3ae508;p=poolifier.git diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index dc2272a1..fc092ca1 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,507 +1,84 @@ -
Constructs a new poolifier thread worker.
+Task function(s) processed by the worker when the pool's execution
function is invoked.
Options for the worker.
+Protected
Optional
activeHandler id of the activeInterval
worker activity check.
Protected
Readonly
isWhether this is the main worker or not.
+Protected
lastTimestamp of the last task processed by this worker.
+Protected
optsOptions for the worker.
+Private
Optional
portMessage port used to communicate with the main worker.
+Protected
Optional
statisticsPerformance statistics computation requirements.
+Protected
taskTask function(s) processed by the worker when the pool's execution
function is invoked.
Protected
idWorker id.
+Adds a task function to the worker. +If a task function with the same name already exists, it is replaced.
+The name of the task function to add.
+The task function to add.
+Whether the task function was added or not.
+Protected
getReturns the main worker.
+Reference to the main worker.
+https://nodejs.org/api/errors.html#class-error If the main worker is not set.
+Protected
handleProtected
handleHandles a kill message sent by the main worker.
+Protected
handleHandles the ready message sent by the main worker.
+The ready message.
+Protected
handleChecks if the worker has a task function with the given name.
+The name of the task function to check.
+Whether the worker has a task function with the given name or not.
+Protected
messageWorker message listener.
+The received message.
+Removes a task function from the worker.
+The name of the task function to remove.
+Whether the task function existed and was removed or not.
+Protected
Readonly
runProtected
Readonly
runRuns the given task function asynchronously.
+Task function that will be executed.
+Input data for the task function.
+Protected
Readonly
runRuns the given task function synchronously.
+Task function that will be executed.
+Input data for the task function.
+Protected
sendProtected
Readonly
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.
+Generated using TypeDoc
A thread worker used by a poolifier
+ThreadPool
.- Preparing search index...
- The search index is not available
poolifier - v3.1.21Class ThreadWorker<Data, Response>
A thread worker used by a poolifier
ThreadPool
.When this worker is inactive for more than the given
maxInactiveTime
, it will send a termination request to its main thread.If you use a
- -DynamicThreadPool
the extra workers that were created will be terminated, but the minimum number of workers will be guaranteed.Template
of data this worker receives from pool's execution. This can only be serializable data.
- -Template
of response the worker sends back to the main thread. This can only be serializable data.
- -Author
Alessandro Pio Ardizio
- -Since
0.0.1
-Type Parameters
---
-
--
-
Data = unknown
Response = unknown
Hierarchy
--- AbstractWorker<MessagePort, Data, Response>
-
-- ThreadWorker
-
-Index
Constructors
-Properties
-Methods
-Constructors
-constructor
--- new
Thread Worker<Data, Response>(fn: ((data: Data) => Response), opts?: WorkerOptions): ThreadWorker<Data, Response>
--
-
-
-
-
-
-
Constructs a new poolifier thread worker.
-Type Parameters
---
-
--
-
Data = unknown
Response = unknown
Parameters
---
-
-
--
-
fn: ((data: Data) => Response)
-Function processed by the worker when the pool's
-execution
function is invoked.--
-
-- (data: Data): Response
--
-
-
-
Parameters
---
-
data: Data
Returns Response
opts: WorkerOptions = {}
-Options for the worker.
-Returns ThreadWorker<Data, Response>
Properties
- Interval
-Protected
Optional
Readonly
aliveHandler Id of the
-aliveInterval
worker alive check. Task Timestamp
-Protected
lastTimestamp of the last task processed by this worker.
- Worker
-Protected
main
-Readonly
optsOptions for the worker.
-Methods
-async Id
--- async
Id(): number
--
-
-
-
Returns
The unique
-asyncId
assigned 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
- -asyncResource
property referencing -theAsyncResource
to 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 }
Alive
-Protected
check-- check
Alive(): void
--
-
-
Check to see if the worker should be terminated, because its living too long.
-Returns void
emit Destroy
--- emit
Destroy(): ThreadWorker<Data, Response>
--
-
-
Call all
- -destroy
hooks. 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 thedestroy
hooks will -never be called.Returns
A reference to
-asyncResource
.Returns ThreadWorker<Data, Response>
Main Worker
-Protected
get-- get
Main Worker(): MessagePort
--
-
-
Returns the main worker.
- -Returns
Reference to the main worker.
-Returns MessagePort
Error
-Protected
handle-- handle
Error(e: string | Error): string
--
-
-
-
-
Handle an error and convert it to a string so it can be sent back to the main worker.
- -Returns
Message of the error.
-Parameters
---
-
e: string | Error
-The error raised by the worker.
-Returns string
Listener
-Protected
message-- message
Listener(value: MessageValue<Data, MessagePort>, fn: ((data: Data) => Response)): void
--
-
-
-
Parameters
---
-
--
-
value: MessageValue<Data, MessagePort>
fn: ((data: Data) => Response)
---
-
-- (data: Data): Response
--
-
-
-
Parameters
---
-
data: Data
Returns Response
Returns void
-Protected
run-- run(fn: ((data?: Data) => Response), value: MessageValue<Data, unknown>): void
--
-
-
-
-
Run the given function synchronously.
-Parameters
---
-
-
--
-
fn: ((data?: Data) => Response)
-Function that will be executed.
---
-
-- (data?: Data): Response
--
-
-
-
Parameters
---
-
Optional
data: DataReturns Response
value: MessageValue<Data, unknown>
-Input data for the given function.
-Returns void
Async
-Protected
run-- run
Async(fn: ((data?: Data) => Promise<Response>), value: MessageValue<Data, unknown>): void
--
-
-
-
-
Run the given function asynchronously.
-Parameters
---
-
-
--
-
fn: ((data?: Data) => Promise<Response>)
-Function that will be executed.
---
-
-- (data?: Data): Promise<Response>
--
-
-
-
Parameters
---
-
Optional
data: DataReturns Promise<Response>
value: MessageValue<Data, unknown>
-Input data for the given function.
-Returns void
run In Async Scope
--- run
In Async Scope<This, Result>(fn: ((this: This, ...args: any[]) => Result), thisArg?: This, ...args: any[]): Result
--
-
-
-
-
-
-
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
-Optional
thisArg: ThisThe receiver to be used for the function call.
-
-Rest
...args: any[]Optional arguments to pass to the function.
-Returns Result
To Main Worker
-Protected
send-- send
To Main Worker(message: MessageValue<Response, unknown>): void
--
-
-
-
-
Send a message to the main worker.
-Parameters
---
-
message: MessageValue<Response, unknown>
-The response message.
-Returns void
trigger Async Id
--- trigger
Async Id(): number
--
-
-
-
Returns
The same
-triggerAsyncId
that is passed to theAsyncResource
constructor.Returns number
-Static
bind-- 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
- -asyncResource
property referencing -theAsyncResource
to 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.
-
-Optional
type: stringAn optional name to associate with the underlying
-AsyncResource
.Optional
thisArg: ThisArgReturns Func & { asyncResource: AsyncResource }
-
-Settings
Member Visibility
Theme
Generated using TypeDoc
Author
Alessandro Pio Ardizio
+Since
0.0.1
+