Job Manager Subsystem for C++

Subsystem Methods

Name	Description
GetNumJobs	Get the total number of jobs in the queue.
CancelJob	Cancels the job with the given ID. If the job has already started it may or may not listen to the request.
CancelAllJobs	Cancels all the jobs in the queue. If any job has already started it may or may not listen to the request.
IsPendingJobsPaused	Checks if the job manager has been asked to pause.
PausePendingJobs	Pause pending jobs. No new jobs will be started, but those already running will continue on. Call ResumePendingJobs() to be able to run the jobs again.
ResumePendingJobs	Resume running pending jobs. Called after PausePendingJobs() have been called and when the jobs can be started again.
WaitForJobToComplete	Waits for the job with the given ID to complete.
WaitForAllJobsToComplete	Waits for all the jobs in the job queue to complete.

Subsystem Properties

Name	Description
OnJobAdded	Called when a new job has been added.
OnJobCompleted	Called when a job has completed.
OnJobProgressUpdated	Called when a job's progress is updated.
OnJobStateChanged	Called when a job's state changes.

Data structs

Name	Description
FJobInfo	Represents a snapshot of a job's state and related information.

Enums

Name	Description
EJobState	This enum specifies what state the job has.

Functions details

GetNumJobs

Get the total number of jobs in the queue.

Signature

int32 GetNumJobs()

Parameters

Function has no parameters

Return value

Type: int32 The total number of jobs in the queue.

CancelJob

Cancels the job with the given ID. If the job has already started it may or may not listen to the request.

Signature

void CancelJob(
		const FGuid& JobId
	)

Parameters

Name	Type	Description
JobId	const FGuid&	The id of the job to cancel.

Return value

Type: void

CancelAllJobs

Cancels all the jobs in the queue. If any job has already started it may or may not listen to the request.

Signature

void CancelAllJobs()

Parameters

Function has no parameters

Return value

Type: void

IsPendingJobsPaused

Checks if the job manager has been asked to pause.

Signature

bool IsPendingJobsPaused()

Parameters

Function has no parameters

Return value

Type: bool Whether the pending jobs have been paused.

PausePendingJobs

Pause pending jobs. No new jobs will be started, but those already running will continue on. Call ResumePendingJobs() to be able to run the jobs again.

Signature

void PausePendingJobs()

Parameters

Function has no parameters

Return value

Type: void

ResumePendingJobs

Resume running pending jobs. Called after PausePendingJobs() has been called and when the jobs can be started again.

Signature

void ResumePendingJobs()

Parameters

Function has no parameters

Return value

Type: void

WaitForJobToComplete

Waits for the job with the given ID to complete.

Signature

void WaitForJobToComplete(
		const FGuid& JobId
	)

Parameters

Name	Type	Description
JobId	const FGuid&	The id of the job to wait for.

Return value

Type: void

WaitForAllJobsToComplete

Waits for all the jobs in the job queue to complete.

Signature

void WaitForAllJobsToComplete()

Parameters

Function has no parameters

Return value

Type: void

Properties details

OnJobAdded

Called when a new job has been added.

Type

FSgDynamicOnJobAdded

OnJobCompleted

Called when a job has completed.

Type

FSgDynamicOnJobCompleted

OnJobProgressUpdated

Called when a job's progress is updated.

Type

FSgDynamicOnJobProgress

OnJobStateChanged

Called when a job's state changes.

Type

FSgDynamicOnJobStateChanged

Data structs details

FJobInfo

Represents a snapshot of a job's state and related information.

Signature

struct FJobInfo

Properties

Name	Type	Description
Id	FGuid	Job Id
Name	FString	Job name
Progress	float	Current job progress
State	EJobState	Current job state
Tags	TMap<FName, FString>	Tags associated with the current job

Enums details

EJobState

This enum specifies what state the job has.

Values

Name	Description
Unknown	Unknown job state. Used for default construction.
Created	Job has been constructed, but it has not yet been added to the job manager for processing.
Pending	Job has been added to the job manager queue.
Running	Job is currently being processed.
CancelRequested	Intermediate state when a job has been requested to be canceled but not reacted to it yet.
Canceled	Job has been canceled.
Failed	Job has failed during processing.
Completed	Job has processed successfully.