Class MultithreadingService

A service that handles multithreading.

Implements

MultithreadingServiceInterface

Index

Constructors

constructor

Methods

init queueThreadJob requeueThreadJob rerunThreadJob run runThreadJob shutdown waitForThreadJob

Constructors

constructor

new MultithreadingService(
    options: MultithreadingOptions,
    threadJobEntityRepository: Repository<
        ThreadJobEntity<BaseThreadJobWorkerData, unknown>,
    >,
    assetService: AssetServiceInterface,
    logger: LoggerInterface,
): MultithreadingService
Parameters
- options: MultithreadingOptions
- threadJobEntityRepository: Repository<ThreadJobEntity<BaseThreadJobWorkerData, unknown>>
- assetService: AssetServiceInterface
- logger: LoggerInterface
Returns MultithreadingService
- Defined in src/multithreading/services/multithreading.service.ts:36

Methods

init

init(): Promise<void>
Initializes the service.

Returns Promise<void>
Implementation of MultithreadingServiceInterface.init
- Defined in src/multithreading/services/multithreading.service.ts:50

queueThreadJob

queueThreadJob<WorkerData extends BaseThreadJobWorkerData, ResultType>(
threadJobData: ThreadJobData<WorkerData>,
): Promise<string>
Creates and queues a thread job with the given data.
Type Parameters
- WorkerData extends BaseThreadJobWorkerData
- ResultType
Parameters
- threadJobData: ThreadJobData<WorkerData>
  The data to create the thread job from.
Returns Promise<string>
The id of the created thread job in the database and queue.

This differs from the threadId, which is created by the os and set when the thread actually starts..
Implementation of MultithreadingServiceInterface.queueThreadJob
- Defined in src/multithreading/services/multithreading.service.ts:111

requeueThreadJob

requeueThreadJob(jobId: string, data?: ThreadJobDataFunctions): Promise<void>
Requeues a thread job that was already completed.
Parameters
- jobId: string
  The id of the job to requeue.
- Optionaldata: ThreadJobDataFunctions
  Additional data for the job.
Returns Promise<void>
Implementation of MultithreadingServiceInterface.requeueThreadJob
- Defined in src/multithreading/services/multithreading.service.ts:176

rerunThreadJob

rerunThreadJob<WorkerData extends BaseThreadJobWorkerData, ResultType>(
jobId: string,
data?: ThreadJobDataFunctions,
): Promise<ThreadJobEntity<WorkerData, ResultType>>
Reruns a thread job that was already completed.
Type Parameters
- WorkerData extends BaseThreadJobWorkerData
- ResultType
Parameters
- jobId: string
  The id of the job to rerun.
- Optionaldata: ThreadJobDataFunctions
  Additional data for the job.
Returns Promise<ThreadJobEntity<WorkerData, ResultType>>
The thread job.
Implementation of MultithreadingServiceInterface.rerunThreadJob
- Defined in src/multithreading/services/multithreading.service.ts:193

run

run<InputType, ResultType>(
    func: ThreadJobFunction<InputType, ResultType>,
    input: InputType,
    timeout?: number,
    priority?: boolean,
): Promise<ResultType>
Runs the given function on a separate thread. This will not persist the state in the database.

IMPORTANT: This uses "eval" in the thread worker, so make sure that the data passed is not malicious.
Type Parameters
- InputType
- ResultType
Parameters
- func: ThreadJobFunction<InputType, ResultType>
  The function that should be run in a separate thread.
- input: InputType
  The input value of the function.
- Optionaltimeout: number
  A custom timeout for the task. Defaults to 5 minutes or an hour, depending on the priority.
- priority: boolean = true
  Whether or not the function should make use of priority workers or not. Defaults to true.
Returns Promise<ResultType>
The result value of the function passed.

Throws
When either the function itself throws an error or something didn't work during parsing/evaluation.
Implementation of MultithreadingServiceInterface.run
- Defined in src/multithreading/services/multithreading.service.ts:140

runThreadJob

runThreadJob<WorkerData extends BaseThreadJobWorkerData, ResultType>(
threadJobData: ThreadJobData<WorkerData>,
): Promise<ThreadJobEntity<WorkerData, ResultType>>
Queues a thread job for the given data and waits for its completion.
Type Parameters
- WorkerData extends BaseThreadJobWorkerData
- ResultType
Parameters
- threadJobData: ThreadJobData<WorkerData>
  The data of the job to queue.
Returns Promise<ThreadJobEntity<WorkerData, ResultType>>
The thread job.
Implementation of MultithreadingServiceInterface.runThreadJob
- Defined in src/multithreading/services/multithreading.service.ts:132

shutdown

shutdown(): Promise<void>
Terminates all the workers.

Returns Promise<void>
Implementation of MultithreadingServiceInterface.shutdown
- Defined in src/multithreading/services/multithreading.service.ts:221

waitForThreadJob

waitForThreadJob<
    ResultType,
    WorkerData extends BaseThreadJobWorkerData = BaseThreadJobWorkerData,
>(
    jobId: string,
): Promise<ThreadJobEntity<WorkerData, ResultType>>
Waits for the thread job with the given id to complete.
Type Parameters
- ResultType
- WorkerData extends BaseThreadJobWorkerData = BaseThreadJobWorkerData
Parameters
- jobId: string
  The id of the thread job to wait for.
Returns Promise<ThreadJobEntity<WorkerData, ResultType>>
The thread job.
Implementation of MultithreadingServiceInterface.waitForThreadJob
- Defined in src/multithreading/services/multithreading.service.ts:202

Class MultithreadingService

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MultithreadingService

Methods

init

Returns Promise<void>

queueThreadJob

Type Parameters

Parameters

Returns Promise<string>

requeueThreadJob

Parameters

Returns Promise<void>

rerunThreadJob

Type Parameters

Parameters

Returns Promise<ThreadJobEntity<WorkerData, ResultType>>

run

Type Parameters

Parameters

Returns Promise<ResultType>

Throws

runThreadJob

Type Parameters

Parameters

Returns Promise<ThreadJobEntity<WorkerData, ResultType>>

shutdown

Returns Promise<void>

waitForThreadJob

Type Parameters

Parameters

Returns Promise<ThreadJobEntity<WorkerData, ResultType>>

Settings

On This Page