FBuildSession

A build session is the main point to the build scheduler.

Windows
MacOS
Linux

Inheritance Hierarchy

FBuildSession

FOptionalBuildSession

References

Module

DerivedDataCache

Header

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

Include

#include "DerivedDataBuildSession.h"

Syntax

class FBuildSession

Remarks

A build session is the main point to the build scheduler.

The purpose of a session is to group together related builds that use the same input resolver, such as grouping builds by target platform. A request to build one definition can lead to more builds being scheduled if the definition references values from other builds as inputs.

Constructors

No constructors are accessible with public or protected access.

Functions

Name Description

Public function

void

 

Build

(
    const FBuildKey& Key,
    const FBuildPolicy& Policy,
    IRequestOwner& Owner,
    FOnBuildComplete&& OnComplete
)

Asynchronous request to execute a build according to the policy.

Public function

void

 

Build

(
    const FBuildDefinition& Definition,
    const FOptionalBuildInputs& Inputs,
    const FBuildPolicy& Policy,
    IRequestOwner& Owner,
    FOnBuildComplete&& OnComplete
)

Asynchronous request to execute a build according to the policy.

Public function

void

 

Build

(
    const FBuildAction& Action,
    const FOptionalBuildInputs& Inputs,
    const FBuildPolicy& Policy,
    IRequestOwner& Owner,
    FOnBuildComplete&& OnComplete
)

Asynchronous request to execute a build according to the policy.

Public function Const

FStringView

 

GetName()

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