IBuildJob

A build job is responsible for the execution of one build.

Windows
MacOS
Linux

References

Module

DerivedDataCache

Header

/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildJob.h

Include

#include "DerivedDataBuildJob.h"

Syntax

class IBuildJob

Remarks

A build job is responsible for the execution of one build.

Jobs typically proceed through each one of a sequence of states, though a state may be skipped if the action was found in the cache or if the scheduler finds duplicate jobs for a definition or an action.

The job depends on the build scheduler to move it through its states. That relationship allows the scheduler more control over resources such as: memory, compute, storage, network.

Functions

Name Description

Public function Const

IBuild &

 

GetBuild()

Returns the build system associated with this job.

Public function Const

ICache &

 

GetCache()

Returns the cache associated with this job.

Public function Const

FStringView

 

GetFunction()

Returns the name of the function to build with, or "Unknown" if not resolved yet.

Public function Const

FStringView

 

GetName()

Returns the name by which to identify this job for logging and profiling.

Public function

void

 

SetOutput

(
    const FBuildOutput& Output
)

Called by the scheduler if it has cached output compatible with the build policy.

Public function

void

 

SkipExecuteRemote()

Called by the scheduler to skip remote execution and fall back to local execution if permitted.

Public function

void

 

StepExecution()

Called by the scheduler to continue this job on the calling thread.