Job Manager Subsystem for Blueprint

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
JobInfo	Represents a snapshot of a job's state and related information.

Enums

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

Functions details

GetNumJobs

Get the total number of jobs in the queue.

Parameters

Function has no parameters

Return value

Type: int 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.

Parameters

Name	Type	Description
JobId	Guid	The id of the job to cancel.

Return value

Type: None

CancelAllJobs

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

Parameters

Function has no parameters

Return value

Type: None

IsPendingJobsPaused

Checks if the job manager has been asked to pause.

Parameters

Function has no parameters

Return value

Type: Boolean 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.

Parameters

Function has no parameters

Return value

Type: None

ResumePendingJobs

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

Parameters

Function has no parameters

Return value

Type: None

WaitForJobToComplete

Waits for the job with the given ID to complete.

Parameters

Name	Type	Description
JobId	Guid	The id of the job to wait for.

Return value

Type: None

WaitForAllJobsToComplete

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

Parameters

Function has no parameters

Return value

Type: None

Properties details

OnJobAdded

Called when a new job has been added.

Type

SgDynamicOnJobAdded

OnJobCompleted

Called when a job has completed.

Type

SgDynamicOnJobCompleted

OnJobProgressUpdated

Called when a job's progress is updated.

Type

SgDynamicOnJobProgress

OnJobStateChanged

Called when a job's state changes.

Type

SgDynamicOnJobStateChanged

Data structs details

JobInfo

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

Properties

Name	Type	Description
Id	Guid	Job Id
Name	String	Job name
Progress	float	Current job progress
State	JobState	Current job state
Tags	Map	Tags associated with the current job

Enums details

JobState

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.