#include <IBuildInstaller.h>

Inheritance diagram for IBuildInstaller:

Public Member Functions
virtual	~IBuildInstaller ()

virtual bool	StartInstallation ()=0

virtual bool	IsComplete () const =0

virtual bool	IsCanceled () const =0

virtual bool	IsPaused () const =0

virtual bool	IsResumable () const =0

virtual bool	IsUpdate () const =0

virtual bool	CompletedSuccessfully () const =0

virtual bool	HasError () const =0

virtual EBuildPatchInstallError	GetErrorType () const =0

virtual FText	GetPercentageText () const =0

virtual FText	GetDownloadSpeedText () const =0

virtual double	GetDownloadSpeed () const =0

virtual int64	GetInitialDownloadSize () const

virtual int64	GetTotalDownloadRequired () const =0

virtual int64	GetTotalDownloaded () const =0

virtual BuildPatchServices::EBuildPatchState	GetState () const =0

virtual FText	GetStatusText () const =0

virtual float	GetUpdateProgress () const =0

virtual FBuildInstallStats	GetBuildStatistics () const =0

virtual EBuildPatchDownloadHealth	GetDownloadHealth () const =0

virtual FText	GetErrorText () const =0

virtual FString	GetErrorCode () const =0

virtual void	CancelInstall ()=0

virtual bool	TogglePauseInstall ()=0

virtual void	RegisterMessageHandler (BuildPatchServices::FMessageHandler *MessageHandler)=0

virtual void	UnregisterMessageHandler (BuildPatchServices::FMessageHandler *MessageHandler)=0

virtual const BuildPatchServices::FBuildInstallerConfiguration &	GetConfiguration () const =0

virtual void	GetDebugText (TArray< FString > &Output)

virtual TMap< FString, TArray64< uint8 > > &	GetFilesInstalledToMemory ()=0

Detailed Description

Interface to a Build Installer, exposes installation control, progress, and state information.

Constructor & Destructor Documentation

◆ ~IBuildInstaller()

virtual IBuildInstaller::~IBuildInstaller ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

◆ CancelInstall()

virtual void IBuildInstaller::CancelInstall ( )

pure virtual

Cancel the current install

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ CompletedSuccessfully()

virtual bool IBuildInstaller::CompletedSuccessfully ( ) const

pure virtual

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.

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ GetBuildStatistics()

virtual FBuildInstallStats IBuildInstaller::GetBuildStatistics ( ) const

pure virtual

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

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ GetConfiguration()

virtual const BuildPatchServices::FBuildInstallerConfiguration & IBuildInstaller::GetConfiguration ( ) const

pure virtual

Get the installation configuration object

Returns: a const reference to the configuration

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ GetDebugText()

virtual void IBuildInstaller::GetDebugText ( TArray< FString > & Output )

inlinevirtual

Returns debug text for download screen to help troubleshoot download issues

Reimplemented in BuildPatchServices::FBuildPatchInstaller.

◆ GetDownloadHealth()

virtual EBuildPatchDownloadHealth IBuildInstaller::GetDownloadHealth ( ) const

pure virtual

Get the current download health rating.

Returns: the enum representing the download health

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ GetDownloadSpeed()

virtual double IBuildInstaller::GetDownloadSpeed ( ) const

pure virtual

Get the download speed for the current process

Returns: download speed progress

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ GetDownloadSpeedText()

virtual FText IBuildInstaller::GetDownloadSpeedText ( ) const

pure virtual

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ GetErrorCode()

virtual FString IBuildInstaller::GetErrorCode ( ) const

pure virtual

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.

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ GetErrorText()

virtual FText IBuildInstaller::GetErrorText ( ) const

pure virtual

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

Returns: display error text

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ GetErrorType()

virtual EBuildPatchInstallError IBuildInstaller::GetErrorType ( ) const

pure virtual

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

Returns: the enum representing the type of error

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ GetFilesInstalledToMemory()

virtual TMap< FString, TArray64< uint8 > > & IBuildInstaller::GetFilesInstalledToMemory ( )

pure virtual

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.

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ GetInitialDownloadSize()

virtual int64 IBuildInstaller::GetInitialDownloadSize ( ) const

inlinevirtual

◆ GetPercentageText()

virtual FText IBuildInstaller::GetPercentageText ( ) const

pure virtual

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ GetState()

virtual BuildPatchServices::EBuildPatchState IBuildInstaller::GetState ( ) const

pure virtual

Get the status of the install process.

Returns: Status of the install process.

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ GetStatusText()

virtual FText IBuildInstaller::GetStatusText ( ) const

pure virtual

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ GetTotalDownloaded()

virtual int64 IBuildInstaller::GetTotalDownloaded ( ) const

pure virtual

Get the total bytes downloaded

Returns: the total bytes downloaded

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ GetTotalDownloadRequired()

virtual int64 IBuildInstaller::GetTotalDownloadRequired ( ) const

pure virtual

Get the total download bytes required to complete

Returns: the total required bytes

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ GetUpdateProgress()

virtual float IBuildInstaller::GetUpdateProgress ( ) const

pure virtual

Get the update progress

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

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ HasError()

virtual bool IBuildInstaller::HasError ( ) const

pure virtual

Get whether the install failed. Only valid if complete.

Returns: true if installation was a failure

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ IsCanceled()

virtual bool IBuildInstaller::IsCanceled ( ) const

pure virtual

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

Returns: true if installation was canceled

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ IsComplete()

virtual bool IBuildInstaller::IsComplete ( ) const

pure virtual

Get whether the install has complete

Returns: true if the thread completed

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ IsPaused()

virtual bool IBuildInstaller::IsPaused ( ) const

pure virtual

Get whether the install is currently paused.

Returns: true if installation is paused

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ IsResumable()

virtual bool IBuildInstaller::IsResumable ( ) const

pure virtual

Get whether the install can be resumed.

Returns: true if installation is resumable

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ IsUpdate()

virtual bool IBuildInstaller::IsUpdate ( ) const

pure virtual

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

Returns: true if installation is an update

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ RegisterMessageHandler()

virtual void IBuildInstaller::RegisterMessageHandler ( BuildPatchServices::FMessageHandler * MessageHandler )

pure virtual

Registers a message handler with the installer.

Parameters

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

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ StartInstallation()

virtual bool IBuildInstaller::StartInstallation ( )

pure virtual

Begin the installation process.

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

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ TogglePauseInstall()

virtual bool IBuildInstaller::TogglePauseInstall ( )

pure virtual

Toggle the install paused state

Returns: true if the installer is now paused

Implemented in BuildPatchServices::FBuildPatchInstaller.

◆ UnregisterMessageHandler()

virtual void IBuildInstaller::UnregisterMessageHandler ( BuildPatchServices::FMessageHandler * MessageHandler )

pure virtual

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

Parameters

MessageHandler Ptr to the message handler to remove.

Implemented in BuildPatchServices::FBuildPatchInstaller.

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

Engine/Source/Runtime/Online/BuildPatchServices/Public/Interfaces/IBuildInstaller.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IBuildInstaller()

Member Function Documentation

◆ CancelInstall()

◆ CompletedSuccessfully()

◆ GetBuildStatistics()

◆ GetConfiguration()

◆ GetDebugText()

◆ GetDownloadHealth()

◆ GetDownloadSpeed()

◆ GetDownloadSpeedText()

◆ GetErrorCode()

◆ GetErrorText()

◆ GetErrorType()

◆ GetFilesInstalledToMemory()

◆ GetInitialDownloadSize()

◆ GetPercentageText()

◆ GetState()

◆ GetStatusText()

◆ GetTotalDownloaded()

◆ GetTotalDownloadRequired()

◆ GetUpdateProgress()

◆ HasError()

◆ IsCanceled()

◆ IsComplete()

◆ IsPaused()

◆ IsResumable()

◆ IsUpdate()

◆ RegisterMessageHandler()

◆ StartInstallation()

◆ TogglePauseInstall()

◆ UnregisterMessageHandler()