BuildPatchServices::FBuildPatchInstaller Class Reference

#include <BuildPatchInstaller.h>

Inheritance diagram for BuildPatchServices::FBuildPatchInstaller:

Public Member Functions
	FBuildPatchInstaller (FBuildInstallerConfiguration Configuration, TMultiMap< FString, FBuildPatchAppManifestRef > InstallationInfo, const FString &LocalMachineConfigFile, TSharedPtr< IAnalyticsProvider > Analytics, FBuildPatchInstallerDelegate StartDelegate, FBuildPatchInstallerDelegate CompleteDelegate)
	~FBuildPatchInstaller ()
uint32	Run () override
virtual bool	StartInstallation () override
virtual bool	IsComplete () const override
virtual bool	IsCanceled () const override
virtual bool	IsPaused () const override
virtual bool	IsResumable () const override
virtual bool	IsUpdate () const override
virtual bool	CompletedSuccessfully () const override
virtual bool	HasError () const override
virtual EBuildPatchInstallError	GetErrorType () const override
virtual FString	GetErrorCode () const override
virtual FText	GetPercentageText () const override
virtual FText	GetDownloadSpeedText () const override
virtual double	GetDownloadSpeed () const override
virtual int64	GetTotalDownloadRequired () const override
virtual int64	GetTotalDownloaded () const override
virtual EBuildPatchState	GetState () const override
virtual FText	GetStatusText () const override
virtual float	GetUpdateProgress () const override
virtual FBuildInstallStats	GetBuildStatistics () const override
virtual EBuildPatchDownloadHealth	GetDownloadHealth () const override
virtual FText	GetErrorText () const override
virtual void	CancelInstall () override
virtual bool	TogglePauseInstall () override
virtual void	RegisterMessageHandler (FMessageHandler *MessageHandler) override
virtual void	UnregisterMessageHandler (FMessageHandler *MessageHandler) override
virtual const FBuildInstallerConfiguration &	GetConfiguration () const override
virtual void	GetDebugText (TArray< FString > &Output) override
virtual TMap< FString, TArray64< uint8 > > &	GetFilesInstalledToMemory () override
bool	Tick ()
void	PreExit ()
const IFileOperationTracker *	GetFileOperationTracker () const
const ISpeedRecorder *	GetDownloadSpeedRecorder () const
const ISpeedRecorder *	GetDiskReadSpeedRecorder () const
const ISpeedRecorder *	GetDiskWriteSpeedRecorder () const
const IDownloadServiceStatistics *	GetDownloadServiceStatistics () const
const IInstallChunkSourceStatistics *	GetInstallChunkSourceStatistics () const
const ICloudChunkSourceStatistics *	GetCloudChunkSourceStatistics () const
const IFileConstructorStatistics *	GetFileConstructorStatistics () const
const IChunkDbChunkSourceStatistics *	GetChunkDbChunkSourceStatistics () const
const IVerifierStatistics *	GetVerifierStatistics () const
Public Member Functions inherited from IBuildInstaller
virtual	~IBuildInstaller ()
virtual int64	GetInitialDownloadSize () const
Public Member Functions inherited from FRunnable
virtual bool	Init ()
virtual void	Stop ()
virtual void	Exit ()
virtual class FSingleThreadRunnable *	GetSingleThreadInterface ()
virtual	~FRunnable ()
Public Member Functions inherited from TSharedFromThis< FBuildPatchInstaller, ESPMode::ThreadSafe >
TSharedRef< FBuildPatchInstaller, Mode >	AsShared ()
TSharedRef< FBuildPatchInstaller const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< FBuildPatchInstaller, Mode >	AsWeak ()
TWeakPtr< FBuildPatchInstaller const, Mode >	AsWeak () const
TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const
void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Additional Inherited Members
Protected Member Functions inherited from TSharedFromThis< FBuildPatchInstaller, ESPMode::ThreadSafe >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()
Static Protected Member Functions inherited from TSharedFromThis< FBuildPatchInstaller, ESPMode::ThreadSafe >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Detailed Description

FBuildPatchInstaller This class controls a thread that wraps the code to install/patch an app from manifests.

Constructor & Destructor Documentation

FBuildPatchInstaller()

BuildPatchServices::FBuildPatchInstaller::FBuildPatchInstaller	(	FBuildInstallerConfiguration	Configuration,
		TMultiMap< FString, FBuildPatchAppManifestRef >	InstallationInfo,
		const FString &	LocalMachineConfigFile,
		TSharedPtr< IAnalyticsProvider >	Analytics,
		FBuildPatchInstallerDelegate	StartDelegate,
		FBuildPatchInstallerDelegate	CompleteDelegate
	)

Constructor takes configuration and dependencies.

Parameters

Configuration	The installer configuration structure.
InstallationInfo	Map of locally installed apps for use as chunk sources.
LocalMachineConfigFile	Filename for the local machine's config. This is used for per-machine configuration rather than shipped or user config.
Analytics	Optionally valid ptr to an analytics provider for sending events.
StartDelegate	Delegate for when the process has started.
CompleteDelegate	Delegate for when the process has completed.

~FBuildPatchInstaller()

BuildPatchServices::FBuildPatchInstaller::~FBuildPatchInstaller

(

)

Default Destructor, will delete the allocated Thread.

Member Function Documentation

CancelInstall()

void BuildPatchServices::FBuildPatchInstaller::CancelInstall ( )

overridevirtual

Cancel the current install

Implements IBuildInstaller.

CompletedSuccessfully()

bool BuildPatchServices::FBuildPatchInstaller::CompletedSuccessfully ( ) const

overridevirtual

Get whether the process was successfully complete, meaning no errors, and was not cancelled. Only valid if complete.

Returns

true if installation process completed successfully.

Implements IBuildInstaller.

GetBuildStatistics()

FBuildInstallStats BuildPatchServices::FBuildPatchInstaller::GetBuildStatistics ( ) const

overridevirtual

Get the build stats for the process. This should only be called after the install has completed

Returns

A struct containing information about the build

Implements IBuildInstaller.

GetChunkDbChunkSourceStatistics()

const IChunkDbChunkSourceStatistics * BuildPatchServices::FBuildPatchInstaller::GetChunkDbChunkSourceStatistics

(

)

const

GetCloudChunkSourceStatistics()

const ICloudChunkSourceStatistics * BuildPatchServices::FBuildPatchInstaller::GetCloudChunkSourceStatistics

(

)

const

Returns

the cloud chunk source statistics interface.

GetConfiguration()

const FBuildInstallerConfiguration & BuildPatchServices::FBuildPatchInstaller::GetConfiguration ( ) const

overridevirtual

Get the installation configuration object

Returns

a const reference to the configuration

Implements IBuildInstaller.

GetDebugText()

void BuildPatchServices::FBuildPatchInstaller::GetDebugText ( TArray< FString > &  Output )

overridevirtual

Returns debug text for download screen to help troubleshoot download issues

Reimplemented from IBuildInstaller.

GetDiskReadSpeedRecorder()

const ISpeedRecorder * BuildPatchServices::FBuildPatchInstaller::GetDiskReadSpeedRecorder

(

)

const

Returns

the speed recorder for disk read speed.

GetDiskWriteSpeedRecorder()

const ISpeedRecorder * BuildPatchServices::FBuildPatchInstaller::GetDiskWriteSpeedRecorder

(

)

const

Returns

the speed recorder for disk write speed.

GetDownloadHealth()

EBuildPatchDownloadHealth BuildPatchServices::FBuildPatchInstaller::GetDownloadHealth ( ) const

overridevirtual

Get the current download health rating.

Returns

the enum representing the download health

Implements IBuildInstaller.

GetDownloadServiceStatistics()

const IDownloadServiceStatistics * BuildPatchServices::FBuildPatchInstaller::GetDownloadServiceStatistics

(

)

const

Returns

the download service statistics interface.

GetDownloadSpeed()

double BuildPatchServices::FBuildPatchInstaller::GetDownloadSpeed ( ) const

overridevirtual

Get the download speed for the current process

Returns

download speed progress

Implements IBuildInstaller.

GetDownloadSpeedRecorder()

const ISpeedRecorder * BuildPatchServices::FBuildPatchInstaller::GetDownloadSpeedRecorder

(

)

const

Returns

the speed recorder for download speed.

GetDownloadSpeedText()

FText BuildPatchServices::FBuildPatchInstaller::GetDownloadSpeedText ( ) const

overridevirtual

Implements IBuildInstaller.

GetErrorCode()

FString BuildPatchServices::FBuildPatchInstaller::GetErrorCode ( ) const

overridevirtual

Get the installation error code. This includes the failure type as well as specific code associated. The value is alphanumeric. This is only guaranteed to be set once the installation has completed.

Returns

the code as a string.

Implements IBuildInstaller.

GetErrorText()

FText BuildPatchServices::FBuildPatchInstaller::GetErrorText ( ) const

overridevirtual

Get the display text for the error that occurred. Only valid to call after completion

Returns

display error text

Implements IBuildInstaller.

GetErrorType()

EBuildPatchInstallError BuildPatchServices::FBuildPatchInstaller::GetErrorType ( ) const

overridevirtual

Get the type of error for a failure that has occurred.

Returns

the enum representing the type of error

Implements IBuildInstaller.

GetFileConstructorStatistics()

const IFileConstructorStatistics * BuildPatchServices::FBuildPatchInstaller::GetFileConstructorStatistics

(

)

const

Returns

the file constructor statistics interface.

GetFileOperationTracker()

const IFileOperationTracker * BuildPatchServices::FBuildPatchInstaller::GetFileOperationTracker

(

)

const

Returns

the file operation tracker for granular data progress states.

GetFilesInstalledToMemory()

TMap< FString, TArray64< uint8 > > & BuildPatchServices::FBuildPatchInstaller::GetFilesInstalledToMemory ( )

overridevirtual

Get the completed files when installing to memory. This must not be called before installation completes, and is non-const so that clients can Move the memory as needed. Once installation is complete the installer does not touch this other than to delete it on destruction.

Implements IBuildInstaller.

GetInstallChunkSourceStatistics()

const IInstallChunkSourceStatistics * BuildPatchServices::FBuildPatchInstaller::GetInstallChunkSourceStatistics

(

)

const

Returns

the install chunk source statistics interface.

GetPercentageText()

FText BuildPatchServices::FBuildPatchInstaller::GetPercentageText ( ) const

overridevirtual

Implements IBuildInstaller.

GetState()

EBuildPatchState BuildPatchServices::FBuildPatchInstaller::GetState ( ) const

overridevirtual

Get the status of the install process.

Returns

Status of the install process.

Implements IBuildInstaller.

GetStatusText()

PRAGMA_DISABLE_DEPRECATION_WARNINGS FText BuildPatchServices::FBuildPatchInstaller::GetStatusText ( ) const

overridevirtual

Implements IBuildInstaller.

GetTotalDownloaded()

int64 BuildPatchServices::FBuildPatchInstaller::GetTotalDownloaded ( ) const

overridevirtual

Get the total bytes downloaded

Returns

the total bytes downloaded

Implements IBuildInstaller.

GetTotalDownloadRequired()

int64 BuildPatchServices::FBuildPatchInstaller::GetTotalDownloadRequired ( ) const

overridevirtual

Get the total download bytes required to complete

Returns

the total required bytes

Implements IBuildInstaller.

GetUpdateProgress()

PRAGMA_ENABLE_DEPRECATION_WARNINGS float BuildPatchServices::FBuildPatchInstaller::GetUpdateProgress ( ) const

overridevirtual

Get the update progress

Returns

A float describing progress: Between 0 and 1 for known progress, or less than 0 for unknown progress.

Implements IBuildInstaller.

GetVerifierStatistics()

const IVerifierStatistics * BuildPatchServices::FBuildPatchInstaller::GetVerifierStatistics

(

)

const

Returns

the verifier statistics interface.

HasError()

bool BuildPatchServices::FBuildPatchInstaller::HasError ( ) const

overridevirtual

Get whether the install failed. Only valid if complete.

Returns

true if installation was a failure

Implements IBuildInstaller.

IsCanceled()

bool BuildPatchServices::FBuildPatchInstaller::IsCanceled ( ) const

overridevirtual

Get whether the install was canceled. Only valid if complete.

Returns

true if installation was canceled

Implements IBuildInstaller.

IsComplete()

bool BuildPatchServices::FBuildPatchInstaller::IsComplete ( ) const

overridevirtual

Get whether the install has complete

Returns

true if the thread completed

Implements IBuildInstaller.

IsPaused()

bool BuildPatchServices::FBuildPatchInstaller::IsPaused ( ) const

overridevirtual

Get whether the install is currently paused.

Returns

true if installation is paused

Implements IBuildInstaller.

IsResumable()

bool BuildPatchServices::FBuildPatchInstaller::IsResumable ( ) const

overridevirtual

Get whether the install can be resumed.

Returns

true if installation is resumable

Implements IBuildInstaller.

IsUpdate()

bool BuildPatchServices::FBuildPatchInstaller::IsUpdate ( ) const

overridevirtual

Get whether the install is performing an update of an existing install.

Returns

true if installation is an update

Implements IBuildInstaller.

PreExit()

void BuildPatchServices::FBuildPatchInstaller::PreExit

(

)

Called by the module during shutdown.

RegisterMessageHandler()

void BuildPatchServices::FBuildPatchInstaller::RegisterMessageHandler ( FMessageHandler *  MessageHandler )

overridevirtual

Registers a message handler with the installer.

Parameters

MessageHandler

Ptr to the message handler to add. Must not be null.

Implements IBuildInstaller.

Run()

uint32 BuildPatchServices::FBuildPatchInstaller::Run ( )

overridevirtual

Runs the runnable object.

This is where all per object thread work is done. This is only called if the initialization was successful.

Returns

The exit code of the runnable object

See also

Init, Stop, Exit

Implements FRunnable.

StartInstallation()

bool BuildPatchServices::FBuildPatchInstaller::StartInstallation ( )

overridevirtual

Begin the installation process.

Returns

true if the installation started successfully, or is already running.

Implements IBuildInstaller.

Tick()

bool BuildPatchServices::FBuildPatchInstaller::Tick

(

)

Tick function called from the module to give us game thread time.

TogglePauseInstall()

bool BuildPatchServices::FBuildPatchInstaller::TogglePauseInstall ( )

overridevirtual

Toggle the install paused state

Returns

true if the installer is now paused

Implements IBuildInstaller.

UnregisterMessageHandler()

void BuildPatchServices::FBuildPatchInstaller::UnregisterMessageHandler ( FMessageHandler *  MessageHandler )

overridevirtual

Unregisters a message handler, will no longer receive HandleMessage calls.

Parameters

MessageHandler

Ptr to the message handler to remove.

Implements IBuildInstaller.

---

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

• Engine/Source/Runtime/Online/BuildPatchServices/Private/BuildPatchInstaller.h
• Engine/Source/Runtime/Online/BuildPatchServices/Private/BuildPatchInstaller.cpp