BuildPatchServices::ICloudChunkSourceStatistics Class Reference

#include <CloudChunkSourceStatistics.h>

Inheritance diagram for BuildPatchServices::ICloudChunkSourceStatistics:

Public Member Functions
virtual uint64	GetRequiredDownloadSize () const =0
virtual uint64	GetNumCorruptChunkDownloads () const =0
virtual uint64	GetNumAbortedChunkDownloads () const =0
virtual float	GetDownloadSuccessRate () const =0
virtual EBuildPatchDownloadHealth	GetDownloadHealth () const =0
virtual TArray< float >	GetDownloadHealthTimers () const =0
virtual uint32	GetCurrentRequestCount () const =0
virtual uint32	GetPeakRequestCount () const =0
Public Member Functions inherited from BuildPatchServices::ICloudChunkSourceStat
virtual	~ICloudChunkSourceStat ()
virtual void	OnDownloadRequested (const FGuid &ChunkId)=0
virtual void	OnDownloadSuccess (const FGuid &ChunkId)=0
virtual void	OnDownloadFailed (const FGuid &ChunkId, const FString &Url)=0
virtual void	OnDownloadCorrupt (const FGuid &ChunkId, const FString &Url, EChunkLoadResult LoadResult)=0
virtual void	OnDownloadAborted (const FGuid &ChunkId, const FString &Url, double DownloadTimeMean, double DownloadTimeStd, double DownloadTime, double BreakingPoint)=0
virtual void	OnReceivedDataUpdated (int64 TotalBytes)=0
virtual void	OnRequiredDataUpdated (int64 TotalBytes)=0
virtual void	OnDownloadHealthUpdated (EBuildPatchDownloadHealth DownloadHealth)=0
virtual void	OnSuccessRateUpdated (float SuccessRate)=0
virtual void	OnActiveRequestCountUpdated (uint32 RequestCount)=0
virtual void	OnAcceptedNewRequirements (const TSet< FGuid > &ChunkIds)=0

Detailed Description

Interface to the statistics class which provides access to tracked values from a cloud chunk source stat.

Member Function Documentation

GetCurrentRequestCount()

virtual uint32 BuildPatchServices::ICloudChunkSourceStatistics::GetCurrentRequestCount ( ) const

pure virtual

Returns

the current number of download requests.

Implemented in BuildPatchServices::FCloudChunkSourceStatistics.

GetDownloadHealth()

virtual EBuildPatchDownloadHealth BuildPatchServices::ICloudChunkSourceStatistics::GetDownloadHealth ( ) const

pure virtual

Returns

the EBuildPatchDownloadHealth value which the success rate applies to according to the configured ranges.

Implemented in BuildPatchServices::FCloudChunkSourceStatistics.

GetDownloadHealthTimers()

virtual TArray< float > BuildPatchServices::ICloudChunkSourceStatistics::GetDownloadHealthTimers ( ) const

pure virtual

Returns

an array of seconds spent in each download health range, indexable by EBuildPatchDownloadHealth.

Implemented in BuildPatchServices::FCloudChunkSourceStatistics.

GetDownloadSuccessRate()

virtual float BuildPatchServices::ICloudChunkSourceStatistics::GetDownloadSuccessRate ( ) const

pure virtual

Returns

the rate of success for chunks download requests, 1.0 being 100%.

Implemented in BuildPatchServices::FCloudChunkSourceStatistics.

GetNumAbortedChunkDownloads()

virtual uint64 BuildPatchServices::ICloudChunkSourceStatistics::GetNumAbortedChunkDownloads ( ) const

pure virtual

Returns

the number of chunk downloads which were aborted, having been determined as lagging.

Implemented in BuildPatchServices::FCloudChunkSourceStatistics.

GetNumCorruptChunkDownloads()

virtual uint64 BuildPatchServices::ICloudChunkSourceStatistics::GetNumCorruptChunkDownloads ( ) const

pure virtual

Returns

the number of successful chunk downloads which had invalid data.

Implemented in BuildPatchServices::FCloudChunkSourceStatistics.

GetPeakRequestCount()

virtual uint32 BuildPatchServices::ICloudChunkSourceStatistics::GetPeakRequestCount ( ) const

pure virtual

Returns

the peak number of download requests.

Implemented in BuildPatchServices::FCloudChunkSourceStatistics.

GetRequiredDownloadSize()

virtual uint64 BuildPatchServices::ICloudChunkSourceStatistics::GetRequiredDownloadSize ( ) const

pure virtual

Returns

the number of bytes that the installation required from cloud sources.

Implemented in BuildPatchServices::FCloudChunkSourceStatistics.

---

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

• Engine/Source/Runtime/Online/BuildPatchServices/Private/Installer/Statistics/CloudChunkSourceStatistics.h