UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
IBuildInstallerSharedContext Class Referenceabstract

#include <IBuildInstallerSharedContext.h>

+ Inheritance diagram for IBuildInstallerSharedContext:

Public Member Functions

virtual ~IBuildInstallerSharedContext ()
 
virtual BuildPatchServices::IBuildInstallerThread * CreateThread ()=0
 
virtual void ReleaseThread (BuildPatchServices::IBuildInstallerThread *Thread)=0
 
virtual void PreallocateThreads (uint32 NumThreads)=0
 
virtual uint32 NumThreadsPerInstaller (bool bUseChunkDBs, bool bHasInstallSource) const =0
 

Detailed Description

An interface for sharing threads and components between multiple BPS installers

Constructor & Destructor Documentation

◆ ~IBuildInstallerSharedContext()

virtual IBuildInstallerSharedContext::~IBuildInstallerSharedContext ( )
inlinevirtual

Virtual destructor.

Member Function Documentation

◆ CreateThread()

virtual BuildPatchServices::IBuildInstallerThread * IBuildInstallerSharedContext::CreateThread ( )
pure virtual

Return an existing free thread or allocate one.

Returns
an IBuildInstallerThread

Implemented in BuildPatchServices::FBuildInstallerSharedContext.

◆ NumThreadsPerInstaller()

virtual uint32 IBuildInstallerSharedContext::NumThreadsPerInstaller ( bool  bUseChunkDBs,
bool  bHasInstallSource 
) const
pure virtual
Returns
The number of threads required per installer

Implemented in BuildPatchServices::FBuildInstallerSharedContext.

◆ PreallocateThreads()

virtual void IBuildInstallerSharedContext::PreallocateThreads ( uint32  NumThreads)
pure virtual

Preallocate thread free list with NumThreads. If more than NumThreads are required, a warning will be logged.

Implemented in BuildPatchServices::FBuildInstallerSharedContext.

◆ ReleaseThread()

virtual void IBuildInstallerSharedContext::ReleaseThread ( BuildPatchServices::IBuildInstallerThread *  Thread)
pure virtual

Relinquish the thread and add to the free list. It should not be used again after this.

Implemented in BuildPatchServices::FBuildInstallerSharedContext.

The documentation for this class was generated from the following file: