BuildPatchServices::IBuildStatistics Class Reference

#include <IBuildStatistics.h>

Inheritance diagram for BuildPatchServices::IBuildStatistics:

Public Member Functions
virtual	~IBuildStatistics ()
virtual const FBuildInstallerConfiguration &	GetConfiguration () const =0
virtual int64	GetDownloadSize () const =0
virtual int64	GetBuildSize () const =0
virtual int32	GetMemoryChunkStoreSize () const
virtual int32	GetMemoryChunksInStore () const
virtual int32	GetMemoryChunksBooted () const
virtual int32	GetMemoryChunksRetained () const
virtual FString	GetCurrentWorkingFileName () const =0
virtual float	GetCurrentWorkingFileProgress () const =0
virtual FGuid	GetCurrentWorkingData () const =0
virtual TArray< FDownload >	GetCurrentDownloads () const =0
virtual bool	IsDownloadActive () const =0
virtual bool	IsHardDiskActiveAdministering () const =0
virtual bool	IsHardDiskActiveWrite () const =0
virtual bool	IsHardDiskActiveRead () const =0
virtual const TArray< FFileOperation > &	GetFileOperationStates () const =0
virtual double	GetDownloadByteSpeed () const =0
virtual double	GetDiskReadByteSpeed () const =0
double	GetChunkDbReadByteSpeed () const
virtual double	GetDiskWriteByteSpeed () const =0
virtual int32	GetNumVerifyErrors () const =0
virtual TMap< EVerifyError, int32 >	GetVerifyErrorCounts () const =0

Detailed Description

An interface for accessing runtime statistical information about an installer.

Constructor & Destructor Documentation

~IBuildStatistics()

virtual BuildPatchServices::IBuildStatistics::~IBuildStatistics ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

GetBuildSize()

virtual int64 BuildPatchServices::IBuildStatistics::GetBuildSize ( ) const

pure virtual

Returns

the total install size for the installation.

Implemented in BuildPatchServices::FBuildStatistics.

GetChunkDbReadByteSpeed()

double BuildPatchServices::IBuildStatistics::GetChunkDbReadByteSpeed ( ) const

inline

Returns

the current chunkdb read speed in bytes per second.

GetConfiguration()

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

pure virtual

Returns

the configuration used when constructing the installer.

Implemented in BuildPatchServices::FBuildStatistics.

GetCurrentDownloads()

virtual TArray< FDownload > BuildPatchServices::IBuildStatistics::GetCurrentDownloads ( ) const

pure virtual

Returns

an array of currently active downloads.

Implemented in BuildPatchServices::FBuildStatistics.

GetCurrentWorkingData()

virtual FGuid BuildPatchServices::IBuildStatistics::GetCurrentWorkingData ( ) const

pure virtual

Returns

the chunk ID currently being used to write the current file.

Implemented in BuildPatchServices::FBuildStatistics.

GetCurrentWorkingFileName()

virtual FString BuildPatchServices::IBuildStatistics::GetCurrentWorkingFileName ( ) const

pure virtual

Returns

the filename of the file currently being worked on.

Implemented in BuildPatchServices::FBuildStatistics.

GetCurrentWorkingFileProgress()

virtual float BuildPatchServices::IBuildStatistics::GetCurrentWorkingFileProgress ( ) const

pure virtual

Returns

the progress of the file currently being worked on.

Implemented in BuildPatchServices::FBuildStatistics.

GetDiskReadByteSpeed()

virtual double BuildPatchServices::IBuildStatistics::GetDiskReadByteSpeed ( ) const

pure virtual

Returns

the current disk read speed in bytes per second.

Implemented in BuildPatchServices::FBuildStatistics.

GetDiskWriteByteSpeed()

virtual double BuildPatchServices::IBuildStatistics::GetDiskWriteByteSpeed ( ) const

pure virtual

Returns

the current disk write speed in bytes per second.

Implemented in BuildPatchServices::FBuildStatistics.

GetDownloadByteSpeed()

virtual double BuildPatchServices::IBuildStatistics::GetDownloadByteSpeed ( ) const

pure virtual

Returns

the current download speed in bytes per second.

Implemented in BuildPatchServices::FBuildStatistics.

GetDownloadSize()

virtual int64 BuildPatchServices::IBuildStatistics::GetDownloadSize ( ) const

pure virtual

Returns

the total download size for the installation.

Implemented in BuildPatchServices::FBuildStatistics.

GetFileOperationStates()

virtual const TArray< FFileOperation > & BuildPatchServices::IBuildStatistics::GetFileOperationStates ( ) const

pure virtual

Returns

an array containing the states for all file write operations being performed by this installation.

Implemented in BuildPatchServices::FBuildStatistics.

GetMemoryChunksBooted()

virtual int32 BuildPatchServices::IBuildStatistics::GetMemoryChunksBooted ( ) const

inlinevirtual

Returns

the number of chunks that have been booted from the memory store.

GetMemoryChunksInStore()

virtual int32 BuildPatchServices::IBuildStatistics::GetMemoryChunksInStore ( ) const

inlinevirtual

Returns

the number of chunks currently in the memory store.

GetMemoryChunksRetained()

virtual int32 BuildPatchServices::IBuildStatistics::GetMemoryChunksRetained ( ) const

inlinevirtual

Returns

the number of chunks currently in the memory store which are held due to multiple referencing.

GetMemoryChunkStoreSize()

virtual int32 BuildPatchServices::IBuildStatistics::GetMemoryChunkStoreSize ( ) const

inlinevirtual

Returns

the size in chunks of the memory store.

GetNumVerifyErrors()

virtual int32 BuildPatchServices::IBuildStatistics::GetNumVerifyErrors ( ) const

pure virtual

Returns

the total number of verify errors experienced during this installation.

Implemented in BuildPatchServices::FBuildStatistics.

GetVerifyErrorCounts()

virtual TMap< EVerifyError, int32 > BuildPatchServices::IBuildStatistics::GetVerifyErrorCounts ( ) const

pure virtual

Returns

the verify error counts per error type experienced during this installation.

Implemented in BuildPatchServices::FBuildStatistics.

IsDownloadActive()

virtual bool BuildPatchServices::IBuildStatistics::IsDownloadActive ( ) const

pure virtual

Returns

true if there are downloads currently active.

Implemented in BuildPatchServices::FBuildStatistics.

IsHardDiskActiveAdministering()

virtual bool BuildPatchServices::IBuildStatistics::IsHardDiskActiveAdministering ( ) const

pure virtual

Returns

true if the current operation is creating or opening files.

Implemented in BuildPatchServices::FBuildStatistics.

IsHardDiskActiveRead()

virtual bool BuildPatchServices::IBuildStatistics::IsHardDiskActiveRead ( ) const

pure virtual

Returns

true if currently reading data from disk.

Implemented in BuildPatchServices::FBuildStatistics.

IsHardDiskActiveWrite()

virtual bool BuildPatchServices::IBuildStatistics::IsHardDiskActiveWrite ( ) const

pure virtual

Returns

true if currently writing data to disk.

Implemented in BuildPatchServices::FBuildStatistics.

---

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

• Engine/Source/Runtime/Online/BuildPatchServices/Public/Interfaces/IBuildStatistics.h