BuildPatchServices

API > API/Runtime

   
Name BuildPatchServices
Type Runtime
Location /Engine/Source/Runtime/Online/BuildPatchServices/
Module Build Rules BuildPatchServices.Build.cs

Classes

Name Remarks
FBuildPatchServices  
FDefaultMessageHandler  
FMessageHandler Base class of a message handler, this should be inherited from and passed to an installer to receive messages that you want to handle.

Structs

Name Remarks
FBuildInstallerConfiguration Defines a list of all the options of an installation task.
FBuildInstallStats A struct to hold stats for the build process.
FBuildPatchServicesInitSettings Defines a list of all build patch services initialization settings, can be used to override default init behaviors.
FChunkDeltaOptimiserConfiguration Defines a list of all options for the chunk delta optimisation task.
FChunkHarvesterConfiguration Defines a list of all options for the chunk harvesting task.
FChunkSourceEvent A message describing an event that occurred for a chunk source.
FChunkUriRequest A Request for a chunk
FChunkUriResponse A Response containing the actual location of the chunk
FCloudDirectoryStats Tracks install stats for a given cloud directory.
FCompactifyConfiguration Defines a list of all options for the cloud directory compactifier task.
FDeltaUriRequest A Request for a delta file
FDiffAbortThreshold Defines the threshold for the original delta size, for which we would abort and not process.
FDiffManifestsConfiguration Defines a list of all options for the diff manifests task.
FDirectoryChunkerConfiguration Defines a list of all options for the build chunking task.
FDownload A struct representing a download.
FExpiratedUriResponse A Response containing the actual location of the file and URI's expiration time
FExpiratedUrisResponse A Response containing an array of expirated URIs (e.g. different CDNs)
FFileOperation A struct representing a file operation to be completed.
FGenericMessage  
FInstallActionStats A struct to hold stats for a single install action.
FInstallationFileAction A message describing an action taken to an installation file.
FInstallerAction  
FInstallerConfiguration DEPRECATED STRUCT.
FPackageChunksConfiguration Defines a list of all options for the chunk packaging task.
FPatchDataEnumerationConfiguration Defines a list of all options for the patch data enumeration task.

Interfaces

Name Remarks
IBuildInstaller Interface to a Build Installer, exposes installation control, progress, and state information.
IBuildInstallerSharedContext An interface for sharing threads and components between multiple BPS installers
IBuildInstallerThread Interface for a re-usable thread
IBuildManifest Interface to a Build Manifest.
IBuildPatchServicesModule Interface for the services manager.
IBuildStatistics An interface for accessing runtime statistical information about an installer.
IChunkDeltaOptimiser  
IChunkHarvester  
IDirectoryChunker  
IManifestField Interface to a manifest field, which is used for accessing custom fields in the manifest
IPatchDataEnumeration  

Typedefs

Name Type Remarks Include Path
FBuildPatchBoolManifestDelegate TBaseDelegate_TwoParams< void, bool, IBuildManifestRef >   Interfaces/IBuildPatchServicesModule.h
FBuildPatchInstallerDelegate TBaseDelegate_OneParam< void, const IBuildInstallerRef & > Delegates that will be accepted and fired off by the implementation. Interfaces/IBuildPatchServicesModule.h
FChunkBuildBooleanDelegate TBaseDelegate_NoParams< bool > A delegate returning a bool. BuildPatchSettings.h
FChunkBuildConfiguration FDirectoryChunkerConfiguration   BuildPatchSettings.h
FChunkBuildFilesEnumeratedDelegate TBaseDelegate_OneParam< bool, const TArray< FString > & >   BuildPatchSettings.h
FGenerationConfiguration FDirectoryChunkerConfiguration Temporary for use with deprecated module functions. BuildPatchSettings.h
FManifestCreatedDelegate TMulticastDelegate_ThreeParams< void, FString, FString, FString >   Interfaces/IBuildPatchServicesModule.h
FSingleChunkWrittenDelegate TMulticastDelegate_TwoParams< void, FString, FString >   Interfaces/IBuildPatchServicesModule.h
IBuildInstallerPtr TSharedPtr< IBuildInstaller, ESPMode::ThreadSafe >   Interfaces/IBuildInstaller.h
IBuildInstallerRef TSharedRef< IBuildInstaller, ESPMode::ThreadSafe >   Interfaces/IBuildInstaller.h
IBuildInstallerSharedContextPtr TSharedPtr< IBuildInstallerSharedContext >   Interfaces/IBuildInstallerSharedContext.h
IBuildInstallerSharedContextRef TSharedRef< IBuildInstallerSharedContext >   Interfaces/IBuildInstallerSharedContext.h
IBuildInstallerSharedContextWeakPtr TWeakPtr< IBuildInstallerSharedContext >   Interfaces/IBuildInstallerSharedContext.h
IBuildInstallerWeakPtr TWeakPtr< IBuildInstaller, ESPMode::ThreadSafe >   Interfaces/IBuildInstaller.h
IBuildManifestPtr TSharedPtr< class IBuildManifest, ESPMode::ThreadSafe >   Interfaces/IBuildManifest.h
IBuildManifestRef TSharedRef< class IBuildManifest, ESPMode::ThreadSafe >   Interfaces/IBuildManifest.h
IBuildStatisticsPtr TSharedPtr< IBuildStatistics >   Interfaces/IBuildStatistics.h
IBuildStatisticsRef TSharedRef< IBuildStatistics >   Interfaces/IBuildStatistics.h
IChunkDeltaOptimiserPtr TSharedPtr< IChunkDeltaOptimiser >   Interfaces/IChunkDeltaOptimiser.h
IChunkDeltaOptimiserRef TSharedRef< IChunkDeltaOptimiser >   Interfaces/IChunkDeltaOptimiser.h
IChunkHarvesterPtr TSharedPtr< IChunkHarvester >   Interfaces/IChunkHarvester.h
IChunkHarvesterRef TSharedRef< IChunkHarvester >   Interfaces/IChunkHarvester.h
IDirectoryChunkerPtr TSharedPtr< IDirectoryChunker >   Interfaces/IDirectoryChunker.h
IDirectoryChunkerRef TSharedRef< IDirectoryChunker >   Interfaces/IDirectoryChunker.h
IManifestFieldPtr TSharedPtr< class IManifestField, ESPMode::ThreadSafe >   Interfaces/IBuildManifest.h
IManifestFieldRef TSharedRef< class IManifestField, ESPMode::ThreadSafe >   Interfaces/IBuildManifest.h
IPatchDataEnumerationPtr TSharedPtr< IPatchDataEnumeration >   Interfaces/IPatchDataEnumeration.h
IPatchDataEnumerationRef TSharedRef< IPatchDataEnumeration >   Interfaces/IPatchDataEnumeration.h

Enums

Public

Name Remarks
BuildPatchServices::EBuildPatchState Namespace to declares the progress type enum
BuildPatchServices::EDeltaPolicy An enum defining the desired policy for requesting an optimised delta.
BuildPatchServices::EDiffAbortThresholdUnits An enum defining the units of DiffAbortThreshold value.
BuildPatchServices::EFeatureLevel An enum type to describe supported features of a certain manifest.
BuildPatchServices::EFileOperationState An enum describing the current state of the data for a file operation that has or will be processed.
BuildPatchServices::EFileSortOrder An enum defining the method of sorting files in a build.
BuildPatchServices::EInstallMode An enum defining the installation mode that should be used.
BuildPatchServices::EMessageRequests Flag for which Requests a message handler expects to receive, allows for internal implementation optimisation.
BuildPatchServices::EVerifyError An enum defining the possible causes for a verification failure.
BuildPatchServices::EVerifyMode An enum defining the verification mode that should be used.
EBuildPatchDownloadHealth Enum describing download health. The actual percentage values used are configurable in the engine ini.
EBuildPatchInstallError Declares the error type enum for use with the error system
ECompactifyMode::Type  
EFileMetaFlags Declares flags for meta or attributes associated with a file.

Constants

Name Type Remarks Include Path
InstallErrorPrefixes::ErrorTypeStrings const TCHAR *   Interfaces/IBuildInstaller.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
MinAbsolute uint64 Minimum threshold value limit, expressed in absolute units. BuildPatchSettings.h  
MinPercentage uint64 Minimum threshold value limit, expressed as a percentage. BuildPatchSettings.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

uint64 BuildPatchServices::CalculateRequiredDiskSpace ( const IBuildManifestPtr& CurrentManifest,
const IBuildManifestRef& BuildManifest,
const EInstallMode& InstallMode,
const TSet< FString >& InstallTags
)

   BuildPatchInstall.h  

FString BuildPatchServices::GetChunkDeltaFilename ( const IBuildManifestRef& SourceManifest,
const IBuildManifestRef& DestinationManifest,
const FString& FilenameTrailer
)

 Based on the source and destination manifests, get the filename for the delta that optimises patching from source to destination. BuildPatchDelta.h  

IBuildManifestPtr BuildPatchServices::MergeDeltaManifest ( const IBuildManifestRef& Manifest,
const IBuildManifestRef& Delta
)

   BuildPatchDelta.h  

bool BuildPatchServices::operator! ( EMessageRequests E
)

   BuildPatchMessage.h  

EMessageRequests BuildPatchServices::operator& ( EMessageRequests Lhs,
EMessageRequests Rhs
)

   BuildPatchMessage.h  

EMessageRequests & BuildPatchServices::operator&= ( EMessageRequests& Lhs,
EMessageRequests Rhs
)

   BuildPatchMessage.h  

EMessageRequests BuildPatchServices::operator^ ( EMessageRequests Lhs,
EMessageRequests Rhs
)

   BuildPatchMessage.h  

EMessageRequests & BuildPatchServices::operator^= ( EMessageRequests& Lhs,
EMessageRequests Rhs
)

   BuildPatchMessage.h  

EMessageRequests BuildPatchServices::operator| ( EMessageRequests Lhs,
EMessageRequests Rhs
)

   BuildPatchMessage.h  

EMessageRequests & BuildPatchServices::operator|= ( EMessageRequests& Lhs,
EMessageRequests Rhs
)

   BuildPatchMessage.h  

EMessageRequests BuildPatchServices::operator~ ( EMessageRequests E
)

   BuildPatchMessage.h  
Returns the FText representation of the specified EBuildPatchState value. BuildPatchState.h  

void LexFromString ( BuildPatchServices::EDeltaPolicy& DeltaPolicy,
const TCHAR* Buffer
)

   BuildPatchDelta.h  

void LexFromString ( BuildPatchServices::EFeatureLevel& FeatureLevel,
const TCHAR* Buffer
)

   BuildPatchFeatureLevel.h  

void LexFromString ( BuildPatchServices::EInstallMode& InstallMode,
const TCHAR* Buffer
)

   BuildPatchInstall.h  

void LexFromString ( BuildPatchServices::FChunkSourceEvent::EType& ChunkSourceEventType,
const TCHAR* Buffer
)

   BuildPatchMessage.h  

void LexFromString ( BuildPatchServices::FInstallationFileAction::EType& InstallationFileActionType,
const TCHAR* Buffer
)

   BuildPatchMessage.h  

void LexFromString ( BuildPatchServices::EFileSortOrder& FileSortOrder,
const TCHAR* Buffer
)

   BuildPatchSettings.h  

void LexFromString ( BuildPatchServices::EBuildPatchState& Error,
const TCHAR* Buffer
)

   BuildPatchState.h  

void LexFromString ( BuildPatchServices::EVerifyMode& VerifyMode,
const TCHAR* Buffer
)

   BuildPatchVerify.h  

void LexFromString ( BuildPatchServices::EVerifyError& VerifyError,
const TCHAR* Buffer
)

   BuildPatchVerify.h  

void LexFromString ( EBuildPatchInstallError& Error,
const TCHAR* Buffer
)

   Interfaces/IBuildInstaller.h  

void LexFromString ( EBuildPatchDownloadHealth& Error,
const TCHAR* Buffer
)

   Interfaces/IBuildInstaller.h  

void LexFromString ( BuildPatchServices::EFileOperationState& Value,
const TCHAR* Buffer
)

   Interfaces/IBuildStatistics.h  

const TCHAR * LexToString ( BuildPatchServices::EDeltaPolicy DeltaPolicy
)

   BuildPatchDelta.h  

const TCHAR * LexToString ( BuildPatchServices::EFeatureLevel FeatureLevel
)

   BuildPatchFeatureLevel.h  

const TCHAR * LexToString ( BuildPatchServices::EInstallMode InstallMode
)

   BuildPatchInstall.h  

const TCHAR * LexToString ( BuildPatchServices::FChunkSourceEvent::EType ChunkSourceEventType
)

   BuildPatchMessage.h  

const TCHAR * LexToString ( BuildPatchServices::FInstallationFileAction::EType InstallationFileActionType
)

   BuildPatchMessage.h  

const TCHAR * LexToString ( BuildPatchServices::EFileSortOrder FileSortOrder
)

   BuildPatchSettings.h  
  BuildPatchSettings.h  
  BuildPatchSettings.h  
  BuildPatchState.h  

const TCHAR * LexToString ( BuildPatchServices::EVerifyMode VerifyMode
)

   BuildPatchVerify.h  

const TCHAR * LexToString ( BuildPatchServices::EVerifyError VerifyError
)

   BuildPatchVerify.h  

const TCHAR * LexToString ( EBuildPatchInstallError Error
)

   Interfaces/IBuildInstaller.h  

const TCHAR * LexToString ( EBuildPatchDownloadHealth Error
)

   Interfaces/IBuildInstaller.h  
  Interfaces/IBuildStatistics.h  

bool operator! ( EFileMetaFlags E
)

   Interfaces/IBuildManifest.h  
  Interfaces/IBuildManifest.h  

EFileMetaFlags & operator&= ( EFileMetaFlags& Lhs,
EFileMetaFlags Rhs
)

   Interfaces/IBuildManifest.h  
  Interfaces/IBuildManifest.h  

EFileMetaFlags & operator^= ( EFileMetaFlags& Lhs,
EFileMetaFlags Rhs
)

   Interfaces/IBuildManifest.h  
  Interfaces/IBuildManifest.h  

EFileMetaFlags & operator|= ( EFileMetaFlags& Lhs,
EFileMetaFlags Rhs
)

   Interfaces/IBuildManifest.h  

EFileMetaFlags operator~ ( EFileMetaFlags E
)

   Interfaces/IBuildManifest.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page