#include <BuildPatchFileConstructor.h>

Inheritance diagram for BuildPatchServices::FBuildPatchFileConstructor:

Classes
struct	FBackingStoreStats

Public Member Functions
	FBuildPatchFileConstructor (FFileConstructorConfig Configuration, IFileSystem FileSystem, IConstructorChunkDbChunkSource ChunkDbChunkSource, IConstructorCloudChunkSource CloudChunkSource, IConstructorInstallChunkSource InstallChunkSource, IChunkReferenceTracker ChunkReferenceTracker, IInstallerError InstallerError, IInstallerAnalytics InstallerAnalytics, IMessagePump MessagePump, IFileConstructorStat *FileConstructorStat, TMap< FGuid, EConstructorChunkLocation > &&ChunkLocations)

	~FBuildPatchFileConstructor ()

void	Run ()

virtual void	SetPaused (bool bInIsPaused) override

virtual void	Abort () override

void	WakeUpDispatch ()

uint64	GetRequiredDiskSpace ()

uint64	GetAvailableDiskSpace ()

	DECLARE_EVENT_OneParam (FBuildPatchFileConstructor, FOnBeforeDeleteFile, const FString &)

FOnBeforeDeleteFile &	OnBeforeDeleteFile ()

void	GrabFilesInstalledToMemory (TMap< FString, TArray64< uint8 > > &OutFilesInstalledToMemory)

FBackingStoreStats	GetBackingStoreStats ()

Public Member Functions inherited from BuildPatchServices::IControllable
virtual	~IControllable ()

Detailed Description

FBuildPatchFileConstructor This class controls a thread that constructs files from a file list, given install details, and chunk availability notifications

Constructor & Destructor Documentation

◆ FBuildPatchFileConstructor()

FBuildPatchFileConstructor::FBuildPatchFileConstructor	(	FFileConstructorConfig	Configuration,
		IFileSystem *	FileSystem,
		IConstructorChunkDbChunkSource *	ChunkDbChunkSource,
		IConstructorCloudChunkSource *	CloudChunkSource,
		IConstructorInstallChunkSource *	InstallChunkSource,
		IChunkReferenceTracker *	ChunkReferenceTracker,
		IInstallerError *	InstallerError,
		IInstallerAnalytics *	InstallerAnalytics,
		IMessagePump *	MessagePump,
		IFileConstructorStat *	FileConstructorStat,
		TMap< FGuid, EConstructorChunkLocation > &&	ChunkLocations
	)

Constructor

Parameters

Configuration	The configuration for the constructor.
FileSystem	The service used to open files.
ChunkSource	Pointer to the chunk source.
ChunkReferenceTracker	Pointer to the chunk reference tracker.
InstallerError	Pointer to the installer error class for reporting fatal errors.
InstallerAnalytics	Pointer to the installer analytics handler for reporting events.
FileConstructorStat	Pointer to the stat class for receiving updates.

◆ ~FBuildPatchFileConstructor()

FBuildPatchFileConstructor::~FBuildPatchFileConstructor ( )

Default Destructor, will delete the allocated Thread

Member Function Documentation

◆ Abort()

void FBuildPatchFileConstructor::Abort ( )

overridevirtual

Called to instruct the class to cease all activity, and perform any shutdown.

Implements BuildPatchServices::IControllable.

◆ DECLARE_EVENT_OneParam()

BuildPatchServices::FBuildPatchFileConstructor::DECLARE_EVENT_OneParam	(	FBuildPatchFileConstructor	,
		FOnBeforeDeleteFile	,
		const FString &
	)

Broadcasts with full filepath to file that the constructor is about to delete in order to free up space.

Returns: Reference to the event object.

◆ GetAvailableDiskSpace()

uint64 FBuildPatchFileConstructor::GetAvailableDiskSpace ( )

Get the disk space that was available when last updating RequiredDiskSpace. See notes with GetRequiredDiskSpace. It's possible for this to return 0 due to the underlying operating system being unable to report a value in cases of e.g. the drive being disconnected.

◆ GetBackingStoreStats()

FBackingStoreStats BuildPatchServices::FBuildPatchFileConstructor::GetBackingStoreStats ( )

inline

◆ GetRequiredDiskSpace()

uint64 FBuildPatchFileConstructor::GetRequiredDiskSpace ( )

Get the disk space that was required to perform the installation. This can change over time and indicates the required space to finish the installation from the current state. It is not initialized until after resume is processed and returns zero until that time. Note that since this and GetAvailableDiskSpace are separate accessors there's no guarantee that they match - e.g. if you call GetRequiredDiskSpace and then GetAvailableDiskSpace immediately afterwards, it's possible the Available Disk Space value is from a later call. This is highly unlikely due to how rare these updates are, but it's possible. Use these for UI purposes only.

◆ GrabFilesInstalledToMemory()

void BuildPatchServices::FBuildPatchFileConstructor::GrabFilesInstalledToMemory ( TMap< FString, TArray64< uint8 > > & OutFilesInstalledToMemory )

inline

◆ OnBeforeDeleteFile()

FBuildPatchFileConstructor::FOnBeforeDeleteFile & FBuildPatchFileConstructor::OnBeforeDeleteFile ( )

◆ Run()

void FBuildPatchFileConstructor::Run ( )

◆ SetPaused()

void FBuildPatchFileConstructor::SetPaused ( bool bIsPaused )