Class 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.

Author

Alessandro Pio Ardizio

Since

0.0.1

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 thread. This can only be serializable data.

Hierarchy

  • AbstractWorker<MessagePort, Data, Response>
    • ThreadWorker

Constructors

constructor

Properties

aliveInterval? isMain lastTaskTimestamp mainWorker opts

Methods

asyncId bind checkAlive emitDestroy getMainWorker handleError messageListener run runAsync runInAsyncScope sendToMainWorker triggerAsyncId bind

Constructors

constructor

  • 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

Protected Optional Readonly aliveInterval

aliveInterval?: Timeout

Handler id of the aliveInterval worker alive check.

Protected Readonly isMain

isMain: boolean

Whether this is the main worker or not.

Protected lastTaskTimestamp

lastTaskTimestamp: number

Timestamp of the last task processed by this worker.

Protected mainWorker

mainWorker: undefined | null | MessagePort

Reference to main worker.

Protected Readonly opts

opts: WorkerOptions = ...

Options for the worker.

Methods

asyncId

  • Returns

    The unique asyncId assigned to the resource.

    Returns number

bind

  • Binds the given function to execute to this AsyncResource's scope.

    The returned function will have an asyncResource property referencing the AsyncResource 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;
    }

Protected checkAlive

  • Checks if the worker should be terminated, because its living too long.

    Returns void

emitDestroy

  • 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 the destroy hooks will never be called.

    Returns

    A reference to asyncResource.

    Returns ThreadWorker<Data, Response>

Protected getMainWorker

  • Returns the main worker.

    Returns

    Reference to the main worker.

    Returns MessagePort

Protected handleError

  • Handles 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

Protected messageListener

  • Worker message listener.

    Parameters

    • message: MessageValue<Data, MessagePort>

      Message received.

    • 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

    Returns void

Protected run

  • Runs the given function synchronously.

    Parameters

    • fn: ((data?: Data) => Response)

      Function that will be executed.

        • (data?: Data): Response

        • Parameters

          • Optional data: Data

          Returns Response

    • message: MessageValue<Data, unknown>

      Input data for the given function.

    Returns void

Protected runAsync

  • Runs the given function asynchronously.

    Parameters

    • fn: ((data?: Data) => Promise<Response>)

      Function that will be executed.

        • (data?: Data): Promise<Response>

        • Parameters

          • Optional data: Data

          Returns Promise<Response>

    • message: MessageValue<Data, unknown>

      Input data for the given function.

    Returns void

runInAsyncScope

  • 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: This

      The receiver to be used for the function call.

    • Rest ...args: any[]

      Optional arguments to pass to the function.

    Returns Result

Protected sendToMainWorker

  • Inherit Doc

    Parameters

    • message: MessageValue<Response, unknown>

    Returns void

triggerAsyncId

  • Returns

    The same triggerAsyncId that is passed to the AsyncResource constructor.

    Returns number

Static bind

  • Binds the given function to the current execution context.

    The returned function will have an asyncResource property referencing the AsyncResource 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: string

      An optional name to associate with the underlying AsyncResource.

    • Optional thisArg: ThisArg

    Returns Func & {
        asyncResource: AsyncResource;
    }

Settings

Member Visibility

Theme

Generated using TypeDoc