BuildPatchServices Namespace Reference

Namespaces
namespace	ApplicationClosedErrorCodes
namespace	AsyncHelpers
namespace	BlockStructureHelpers
namespace	ConstructionErrorCodes
namespace	CustomChunkReferencesHelpers
namespace	DiffHelpers
namespace	DiskSpaceErrorCodes
namespace	DownloadErrorCodes
namespace	HeaderHelpers
namespace	InitializationErrorCodes
namespace	ListHelpers
namespace	ManifestDataHelpers
namespace	ManifestVersionHelpers
namespace	MoveErrorCodes
namespace	PaddingChunk
namespace	PathLengthErrorCodes
namespace	PrerequisiteErrorPrefixes
namespace	UserCancelErrorCodes
namespace	VerifyErrorCodes

Classes
struct	FAnalyticsEventInfo
struct	FBlockEntry
struct	FBlockRange
class	FBlockStructure
class	FBuildDataVerifier
struct	FBuildInstallerConfiguration
class	FBuildInstallerSharedContext
class	FBuildInstallerSharedContextFactory
class	FBuildInstallerThread
class	FBuildManifestSetFactory
struct	FBuildPatchDownloadRecord
class	FBuildPatchFileConstructor
class	FBuildPatchInstaller
struct	FBuildPatchInstallerAction
class	FBuildPatchManifestSet
struct	FBuildPatchProgress
struct	FBuildPatchServicesInitSettings
class	FBuildStatistics
class	FBuildStatisticsFactory
class	FBuildStreamerFactory
struct	FChunkAccessLookup
struct	FChunkBuildConfiguration
class	FChunkDataAccess
class	FChunkDataAccessFactory
struct	FChunkDatabaseFile
struct	FChunkDatabaseHeader
class	FChunkDatabaseWriter
class	FChunkDatabaseWriterFactory
struct	FChunkDataList
class	FChunkDataSerialization
class	FChunkDataSerializationFactory
class	FChunkDataSizeProvider
class	FChunkDataSizeProviderFactory
class	FChunkDbChunkSource
class	FChunkDbChunkSourceStatistics
class	FChunkDbChunkSourceStatisticsFactory
struct	FChunkDbDataAccess
struct	FChunkDbSourceConfig
struct	FChunkDeltaOptimiserConfiguration
class	FChunkDeltaOptimiserFactory
class	FChunkEvictionPolicy
class	FChunkEvictionPolicyFactory
struct	FChunkHeader
struct	FChunkInfo
struct	FChunkLocation
struct	FChunkMatch
struct	FChunkMatchMeta
struct	FChunkMatchProcessor
class	FChunkMatchProcessorFactory
class	FChunkMatchStomper
struct	FChunkPart
class	FChunkReferenceTracker
class	FChunkReferenceTrackerFactory
class	FChunkSearcher
struct	FChunkSourceEvent
class	FChunkSuccessRate
struct	FChunkUriRequest
struct	FChunkUriResponse
class	FCloudChunkSource
class	FCloudChunkSourceFactory
class	FCloudChunkSourceStatistics
class	FCloudChunkSourceStatisticsFactory
class	FCloudEnumeration
class	FCloudEnumerationFactory
struct	FCloudSourceConfig
struct	FCompactifyConfiguration
class	FConstructorCloudChunkSource
struct	FConstructorCloudChunkSourceConfig
struct	FCustomFields
struct	FDataFileResult
struct	FDataMessage
class	FDataScanner
class	FDataScannerCounter
class	FDataScannerFactory
class	FDataStream
class	FDefaultMessageHandler
class	FDeltaChunkEnumeration
class	FDeltaChunkEnumerationFactory
class	FDeltaMatchProcessor
class	FDeltaScanner
class	FDeltaScannerFactory
class	FDiffManifests
struct	FDiffManifestsConfiguration
class	FDiffManifestsFactory
class	FDirectoryBuildStreamer
struct	FDirectoryBuildStreamerConfig
struct	FDirectoryBuildStreamerDependencies
struct	FDownload
class	FDownloadConnectionCount
struct	FDownloadConnectionCountConfig
class	FDownloadConnectionCountFactory
struct	FDownloadDelegates
class	FDownloadService
class	FDownloadServiceFactory
class	FDownloadServiceImpl
class	FDownloadServiceStatistics
class	FDownloadServiceStatisticsFactory
struct	FFileAttributes
class	FFileAttributesParser
class	FFileAttributesParserFactory
class	FFileAttributesParserImpl
class	FFileAttribution
class	FFileAttributionFactory
struct	FFileBlock
struct	FFileChunkPart
struct	FFileConstructorConfig
class	FFileConstructorStatistics
class	FFileConstructorStatisticsFactory
class	FFileDownload
struct	FFileManifest
struct	FFileManifestList
struct	FFileOperation
class	FFileOperationTracker
class	FFileOperationTrackerFactory
struct	FFileRequest
struct	FFileSpan
class	FFileSystem
class	FFileSystemFactory
struct	FGenericMessage
class	FHttpDownload
class	FHttpManager
class	FHttpManagerFactory
struct	FInstallationFileAction
class	FInstallChunkSource
class	FInstallChunkSourceStatistics
class	FInstallChunkSourceStatisticsFactory
struct	FInstallerAction
class	FInstallerAnalytics
class	FInstallerAnalyticsFactory
struct	FInstallerConfiguration
class	FInstallerError
class	FInstallerErrorFactory
class	FMachineConfig
class	FMachineConfigFactory
class	FManifestBuilder
struct	FManifestBuilderConfig
class	FManifestBuilderFactory
class	FManifestBuildStreamer
struct	FManifestBuildStreamerConfig
struct	FManifestBuildStreamerDependencies
class	FManifestData
struct	FManifestDetails
struct	FManifestHeader
struct	FManifestIterator
struct	FManifestMeta
struct	FManifestResult
struct	FMatchEntry
class	FMeanUseTracker
class	FMeanValue
class	FMemoryChunkStore
class	FMemoryChunkStoreFactory
class	FMemoryChunkStoreStatistics
class	FMemoryChunkStoreStatisticsFactory
class	FMessageHandler
class	FMessagePump
class	FMessagePumpFactory
class	FNullFileOperationTracker
class	FNullInstallerAnalytics
class	FOptimisedDelta
struct	FOptimisedDeltaConfiguration
struct	FOptimisedDeltaDependencies
class	FOptimisedDeltaFactory
class	FPackageChunks
struct	FPackageChunksConfiguration
class	FPackageChunksFactory
class	FParallelChunkWriter
struct	FParallelChunkWriterConfig
class	FParallelChunkWriterFactory
struct	FParallelChunkWriterSummaries
class	FParallelDirectoryEnumerator
class	FPatchDataCompactifier
class	FPatchDataCompactifierFactory
class	FPatchDataEnumeration
struct	FPatchDataEnumerationConfiguration
class	FPatchDataEnumerationFactory
struct	FPeakSpeed
class	FPlatformFactory
struct	FPreReqInfo
class	FPrerequisites
class	FPrerequisitesFactory
struct	FScannerDetails
struct	FScopedControllables
struct	FScopeLockedChunkData
class	FSpeedRecorder
class	FSpeedRecorderFactory
class	FStatsCollector
class	FStatsCollectorFactory
class	FStatsCollectorImpl
class	FStatsParallelScopeTimer
class	FStatsScopedTimer
class	FVerifier
class	FVerifierFactory
class	FVerifierStatistics
class	FVerifierStatisticsFactory
class	FWriterChunkDataAccess
class	IBuildInstallerThread
class	IBuildManifestSet
class	IBuildStatistics
class	IBuildStreamer
class	IChunkDataAccess
class	IChunkDatabaseWriter
class	IChunkDataSerialization
class	IChunkDataSizeProvider
class	IChunkDbChunkSourceStat
class	IChunkDbChunkSourceStatistics
class	IChunkDeltaOptimiser
class	IChunkEvictionPolicy
class	IChunkMatchProcessor
class	IChunkReferenceTracker
class	IChunkSource
class	IChunkStore
class	ICloudChunkSource
class	ICloudChunkSourceStat
class	ICloudChunkSourceStatistics
class	ICloudEnumeration
class	IConstructorChunkDbChunkSource
class	IConstructorChunkSource
class	IConstructorCloudChunkSource
class	IConstructorInstallChunkSource
class	IControllable
class	IDataScanner
class	IDataSizeProvider
class	IDeltaChunkEnumeration
class	IDiffManifests
class	IDirectoryBuildStreamer
class	IDownload
class	IDownloadConnectionCount
class	IDownloadService
class	IDownloadServiceStat
class	IDownloadServiceStatistics
class	IFileAttribution
class	IFileConstructorStat
class	IFileConstructorStatistics
class	IFileOperationTracker
class	IFileSystem
class	IHttpManager
class	IInstallChunkSourceStat
class	IInstallChunkSourceStatistics
class	IInstallerAnalytics
class	IInstallerError
class	IMachineConfig
class	IManifestBuilder
class	IManifestBuildStreamer
class	IMemoryChunkStore
class	IMemoryChunkStoreStat
class	IMemoryChunkStoreStatistics
class	IMessagePump
class	IOptimisedDelta
class	IPackageChunks
class	IParallelChunkWriter
class	IPatchDataCompactifier
class	IPatchDataEnumeration
class	IPlatform
class	IPrerequisites
class	ISpeedRecorder
class	IVerifier
class	IVerifierStat
class	IVerifierStatistics
struct	TBlockData
class	TFactory
class	TPlatform
class	TProcessTimer

Functions
FManifestIterator	begin (const FBuildPatchInstallerAction &InstallerAction)
FManifestIterator	end (const FBuildPatchInstallerAction &InstallerAction)
	ENUM_CLASS_FLAGS (EAttributeFlags)
	ENUM_CLASS_FLAGS (EWriteFlags)
	ENUM_CLASS_FLAGS (EReadFlags)
const TCHAR *	ToString (const EChunkLoadResult &ChunkLoadResult)
const TCHAR *	ToString (const EChunkSaveResult &ChunkSaveResult)
FArchive &	operator<< (FArchive &Ar, FChunkHeader &Header)
FArchive &	operator<< (FArchive &Ar, FChunkPart &ChunkPart)
FArchive &	operator<< (FArchive &Ar, FChunkDatabaseHeader &Header)
	ENUM_CLASS_FLAGS (EChunkStorageFlags)
	ENUM_CLASS_FLAGS (EChunkHashFlags)
FArchive &	operator<< (FArchive &Ar, FManifestHeader &Header)
FArchive &	operator<< (FArchive &Ar, FManifestMeta &Meta)
FArchive &	operator<< (FArchive &Ar, FChunkDataList &ChunkDataList)
FArchive &	operator<< (FArchive &Ar, FFileManifestList &FileDataList)
FArchive &	operator<< (FArchive &Ar, FCustomFields &CustomFields)
	ENUM_CLASS_FLAGS (EManifestStorageFlags)
	ENUM_CLASS_FLAGS (EFileMetaFlags)
const TCHAR *	ToString (const IChunkDbChunkSourceStat::ELoadResult &LoadResult)
	DECLARE_DELEGATE_TwoParams (FDownloadProgressDelegate, int32, uint64)
	DECLARE_DELEGATE_TwoParams (FDownloadCompleteDelegate, int32, const FDownloadRef &)
const TCHAR *	ToString (const IInstallChunkSourceStat::ELoadResult &LoadResult)
FText	GetStandardErrorText (EBuildPatchInstallError ErrorType)
FText	GetDiskSpaceMessage (const FString &Location, uint64 RequiredBytes, uint64 AvailableBytes, const FNumberFormattingOptions *FormatOptions)
FString	EnumToString (const EBuildPatchInstallError &InErrorType)
	ENUM_CLASS_FLAGS (FBuildInstallerThread::EMsg)
bool	TryConvertToVerifyResult (EVerifyError InVerifyError, EVerifyResult &OutVerifyResult)
bool	TryConvertToVerifyError (EVerifyResult InVerifyResult, EVerifyError &OutVerifyError)
BUILDPATCHSERVICES_API FString	GetChunkDeltaFilename (const IBuildManifestRef &SourceManifest, const IBuildManifestRef &DestinationManifest)
BUILDPATCHSERVICES_API IBuildManifestPtr	MergeDeltaManifest (const IBuildManifestRef &Manifest, const IBuildManifestRef &Delta)
BUILDPATCHSERVICES_API const TCHAR *	FeatureLevelToString (const EFeatureLevel &FeatureLevel)
BUILDPATCHSERVICES_API bool	FeatureLevelFromString (const TCHAR *FeatureLevelString, EFeatureLevel &FeatureLevel)
BUILDPATCHSERVICES_API uint64	CalculateRequiredDiskSpace (const IBuildManifestPtr &CurrentManifest, const IBuildManifestRef &BuildManifest, const EInstallMode &InstallMode, const TSet< FString > &InstallTags)
	ENUM_CLASS_FLAGS (EMessageRequests)
BUILDPATCHSERVICES_API const FText &	StateToText (const EBuildPatchState &State)

Function Documentation

begin()

FManifestIterator BuildPatchServices::begin

(

const FBuildPatchInstallerAction &

InstallerAction

)

CalculateRequiredDiskSpace()

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

DECLARE_DELEGATE_TwoParams() [1/2]

BuildPatchServices::DECLARE_DELEGATE_TwoParams	(	FDownloadCompleteDelegate	,
		int32	,
		const FDownloadRef &
	)

Delegate called for download complete.

Parameters

RequestId	The id that was returned by RequestFile(..).
Download	The complete download instance.

DECLARE_DELEGATE_TwoParams() [2/2]

BuildPatchServices::DECLARE_DELEGATE_TwoParams	(	FDownloadProgressDelegate	,
		int32	,
		uint64
	)

Delegate called for download progress updates.

Parameters

RequestId	The id that was returned by RequestFile(..).
BytesSoFar	The number of bytes received so far.

end()

FManifestIterator BuildPatchServices::end

(

const FBuildPatchInstallerAction &

InstallerAction

)

ENUM_CLASS_FLAGS() [1/9]

BuildPatchServices::ENUM_CLASS_FLAGS

(

EAttributeFlags

)

ENUM_CLASS_FLAGS() [2/9]

BuildPatchServices::ENUM_CLASS_FLAGS

(

EChunkHashFlags

)

ENUM_CLASS_FLAGS() [3/9]

BuildPatchServices::ENUM_CLASS_FLAGS

(

EChunkStorageFlags

)

ENUM_CLASS_FLAGS() [4/9]

BuildPatchServices::ENUM_CLASS_FLAGS

(

EFileMetaFlags

)

ENUM_CLASS_FLAGS() [5/9]

BuildPatchServices::ENUM_CLASS_FLAGS

(

EManifestStorageFlags

)

ENUM_CLASS_FLAGS() [6/9]

BuildPatchServices::ENUM_CLASS_FLAGS

(

EMessageRequests

)

ENUM_CLASS_FLAGS() [7/9]

BuildPatchServices::ENUM_CLASS_FLAGS

(

EReadFlags

)

ENUM_CLASS_FLAGS() [8/9]

BuildPatchServices::ENUM_CLASS_FLAGS

(

EWriteFlags

)

ENUM_CLASS_FLAGS() [9/9]

BuildPatchServices::ENUM_CLASS_FLAGS

(

FBuildInstallerThread::EMsg

)

EnumToString()

FString BuildPatchServices::EnumToString

(

const EBuildPatchInstallError &

ErrorType

)

Returns the string representation of the specified FBuildPatchInstallError value. Used for logging only.

Parameters

ErrorType

The error type value.

Returns

A string value for the EBuildPatchInstallError enum.

FeatureLevelFromString()

BUILDPATCHSERVICES_API bool BuildPatchServices::FeatureLevelFromString	(	const TCHAR *	FeatureLevelString,
		EFeatureLevel &	FeatureLevel
	)

Parses the provided string into the relevant EFeatureLevel value, if it matches.

Parameters

FeatureLevelString	The string to try parse.
FeatureLevel	Receives the enum value if successful.

Returns

true if successfully parsed.

FeatureLevelToString()

BUILDPATCHSERVICES_API const TCHAR * BuildPatchServices::FeatureLevelToString

(

const EFeatureLevel &

FeatureLevel

)

Returns the string representation of the EFeatureLevel value. Used for analytics and logging only.

Parameters

FeatureLevel

The feature level enum value.

Returns

The string representation.

GetChunkDeltaFilename()

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

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

Parameters

SourceManifest	The source manifest.
DestinationManifest	The destination manifest.

Returns

the CloudDir relative delta filename.

GetDiskSpaceMessage()

FText BuildPatchServices::GetDiskSpaceMessage	(	const FString &	Location,
		uint64	RequiredBytes,
		uint64	AvailableBytes,
		const FNumberFormattingOptions *	FormatOptions = nullptr
	)

Get the standard error message for for a disk space issue.

Parameters

Location	The disk path requiring more space.
RequiredBytes	The number of bytes required for the installation.
AvailableBytes	The number of bytes available on the drive.
FormatOptions	Optionally override the default number formatting.

Returns

the displayable text for the out of space error.

GetStandardErrorText()

FText BuildPatchServices::GetStandardErrorText

(

EBuildPatchInstallError

ErrorType

)

Get the standard error message for an error type.

Parameters

ErrorType

The enum value for the error.

Returns

the displayable text for the error type.

MergeDeltaManifest()

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

operator<<() [1/8]

FArchive & BuildPatchServices::operator<<	(	FArchive &	Ar,
		FChunkDatabaseHeader &	Header
	)

Serialization operator.

Parameters

Ar	Archive to serialize to.
Header	Header to serialize.

Returns

Passed in archive.

operator<<() [2/8]

FArchive & BuildPatchServices::operator<<	(	FArchive &	Ar,
		FChunkDataList &	ChunkDataList
	)

Serialization operator.

Parameters

Ar	Archive to serialize to.
ChunkDataList	FChunkDataList to serialize.

Returns

Passed in archive.

operator<<() [3/8]

FArchive & BuildPatchServices::operator<<	(	FArchive &	Ar,
		FChunkHeader &	Header
	)

Serialization operator.

Parameters

Ar	Archive to serialize to.
Header	Header to serialize.

Returns

Passed in archive.

operator<<() [4/8]

FArchive & BuildPatchServices::operator<<	(	FArchive &	Ar,
		FChunkPart &	ChunkPart
	)

Serialization operator.

Parameters

Ar	Archive to serialize to.
ChunkPart	FChunkPart to serialize.

Returns

Passed in archive.

operator<<() [5/8]

FArchive & BuildPatchServices::operator<<	(	FArchive &	Ar,
		FCustomFields &	CustomFields
	)

Serialization operator.

Parameters

Ar	Archive to serialize to.
CustomFields	FCustomFields to serialize.

Returns

Passed in archive.

operator<<() [6/8]

FArchive & BuildPatchServices::operator<<	(	FArchive &	Ar,
		FFileManifestList &	FileDataList
	)

Serialization operator.

Parameters

Ar	Archive to serialize to.
FileManifestList	FFileManifestList to serialize.

Returns

Passed in archive.

operator<<() [7/8]

FArchive & BuildPatchServices::operator<<	(	FArchive &	Ar,
		FManifestHeader &	Header
	)

Serialization operator.

Parameters

Ar	Archive to serialize to.
Header	FManifestHeader to serialize.

Returns

Passed in archive.

operator<<() [8/8]

FArchive & BuildPatchServices::operator<<	(	FArchive &	Ar,
		FManifestMeta &	Meta
	)

Serialization operator.

Parameters

Ar	Archive to serialize to.
Meta	FManifestMeta to serialize.

Returns

Passed in archive.

StateToText()

BUILDPATCHSERVICES_API const FText & BuildPatchServices::StateToText

(

const EBuildPatchState &

State

)

Returns the FText representation of the specified EBuildPatchState value. Used for displaying to the user.

Parameters

State

- The error type value.

Returns

The display text associated with the progress step.

ToString() [1/4]

const TCHAR * BuildPatchServices::ToString

(

const EChunkLoadResult &

ChunkLoadResult

)

A ToString implementation for EChunkLoadResult.

ToString() [2/4]

const TCHAR * BuildPatchServices::ToString

(

const EChunkSaveResult &

ChunkSaveResult

)

A ToString implementation for EChunkSaveResult.

ToString() [3/4]

const TCHAR * BuildPatchServices::ToString

(

const IChunkDbChunkSourceStat::ELoadResult &

LoadResult

)

A ToString implementation for IChunkDbChunkSourceStat::ELoadResult.

ToString() [4/4]

const TCHAR * BuildPatchServices::ToString

(

const IInstallChunkSourceStat::ELoadResult &

LoadResult

)

A ToString implementation for IInstallChunkSourceStat::ELoadResult.

TryConvertToVerifyError()

bool BuildPatchServices::TryConvertToVerifyError	(	EVerifyResult	InVerifyResult,
		EVerifyError &	OutVerifyError
	)

Used to convert a EVerifyResult to a EVerifyError.

Parameters

InVerifyResult	- Result to convert.
OutVerifyError	- Reference to complete.

Returns

true if successful.

TryConvertToVerifyResult()

bool BuildPatchServices::TryConvertToVerifyResult	(	EVerifyError	InVerifyError,
		EVerifyResult &	OutVerifyResult
	)

Used to convert a EVerifyError to a EVerifyResult.

Parameters

InVerifyError	- Error to convert.
OutVerifyResult	- Reference to completed.

Returns

true if successful.