BuildPatchServices::FCloudChunkSourceStatistics Class Reference

Inheritance diagram for BuildPatchServices::FCloudChunkSourceStatistics:

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

Constructor & Destructor Documentation

FCloudChunkSourceStatistics()

BuildPatchServices::FCloudChunkSourceStatistics::FCloudChunkSourceStatistics	(	IInstallerAnalytics *	InstallerAnalytics,
		FBuildPatchProgress *	BuildProgress,
		IFileOperationTracker *	FileOperationTracker
	)

~FCloudChunkSourceStatistics()

BuildPatchServices::FCloudChunkSourceStatistics::~FCloudChunkSourceStatistics

(

)

Member Function Documentation

GetCurrentRequestCount()

uint32 BuildPatchServices::FCloudChunkSourceStatistics::GetCurrentRequestCount ( ) const

overridevirtual

Returns

the current number of download requests.

Implements BuildPatchServices::ICloudChunkSourceStatistics.

GetDownloadHealth()

EBuildPatchDownloadHealth BuildPatchServices::FCloudChunkSourceStatistics::GetDownloadHealth ( ) const

overridevirtual

Returns

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

Implements BuildPatchServices::ICloudChunkSourceStatistics.

GetDownloadHealthTimers()

TArray< float > BuildPatchServices::FCloudChunkSourceStatistics::GetDownloadHealthTimers ( ) const

overridevirtual

Returns

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

Implements BuildPatchServices::ICloudChunkSourceStatistics.

GetDownloadSuccessRate()

float BuildPatchServices::FCloudChunkSourceStatistics::GetDownloadSuccessRate ( ) const

overridevirtual

Returns

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

Implements BuildPatchServices::ICloudChunkSourceStatistics.

GetNumAbortedChunkDownloads()

uint64 BuildPatchServices::FCloudChunkSourceStatistics::GetNumAbortedChunkDownloads ( ) const

overridevirtual

Returns

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

Implements BuildPatchServices::ICloudChunkSourceStatistics.

GetNumCorruptChunkDownloads()

uint64 BuildPatchServices::FCloudChunkSourceStatistics::GetNumCorruptChunkDownloads ( ) const

overridevirtual

Returns

the number of successful chunk downloads which had invalid data.

Implements BuildPatchServices::ICloudChunkSourceStatistics.

GetPeakRequestCount()

uint32 BuildPatchServices::FCloudChunkSourceStatistics::GetPeakRequestCount ( ) const

overridevirtual

Returns

the peak number of download requests.

Implements BuildPatchServices::ICloudChunkSourceStatistics.

GetRequiredDownloadSize()

uint64 BuildPatchServices::FCloudChunkSourceStatistics::GetRequiredDownloadSize ( ) const

overridevirtual

Returns

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

Implements BuildPatchServices::ICloudChunkSourceStatistics.

OnAcceptedNewRequirements()

void BuildPatchServices::FCloudChunkSourceStatistics::OnAcceptedNewRequirements ( const TSet< FGuid > &  ChunkIds )

overridevirtual

Called when a batch of chunks are added and accepted via IChunkSource::AddRuntimeRequirements.

Parameters

ChunkIds

The ids of each chunk.

Implements BuildPatchServices::ICloudChunkSourceStat.

OnActiveRequestCountUpdated()

void BuildPatchServices::FCloudChunkSourceStatistics::OnActiveRequestCountUpdated ( uint32  RequestCount )

overridevirtual

Called whenever the current number of active requests updates.

Parameters

RequestCount

The number of currently active requests, this will range between 0 and NumSimultaneousDownloads config.

Implements BuildPatchServices::ICloudChunkSourceStat.

OnDownloadAborted()

void BuildPatchServices::FCloudChunkSourceStatistics::OnDownloadAborted ( const FGuid &  ChunkId, const FString &  Url, double  DownloadTimeMean, double  DownloadTimeStd, double  DownloadTime, double  BreakingPoint  )

overridevirtual

Called whenever a chunk was aborted because it was determined as taking too long.

Parameters

ChunkId	The id of the chunk.
Url	The url used to request the chunk.
DownloadTimeMean	The current mean time for chunk downloads when this abort was made.
DownloadTimeStd	The current standard deviation for chunk download times when this abort was made.
DownloadTime	The time this request had been running for.
BreakingPoint	The calculated breaking point which this request has overran.

Implements BuildPatchServices::ICloudChunkSourceStat.

OnDownloadCorrupt()

void BuildPatchServices::FCloudChunkSourceStatistics::OnDownloadCorrupt ( const FGuid &  ChunkId, const FString &  Url, EChunkLoadResult  LoadResult  )

overridevirtual

Called whenever a chunk download request succeeded but the data was not valid.

Parameters

ChunkId	The id of the chunk.
Url	The url used to request the chunk.
LoadResult	The result from attempting to serialize the downloaded data.

Implements BuildPatchServices::ICloudChunkSourceStat.

OnDownloadFailed()

void BuildPatchServices::FCloudChunkSourceStatistics::OnDownloadFailed ( const FGuid &  ChunkId, const FString &  Url  )

overridevirtual

Called whenever a chunk download request has failed.

Parameters

ChunkId	The id of the chunk.
Url	The url used to request the chunk.

Implements BuildPatchServices::ICloudChunkSourceStat.

OnDownloadHealthUpdated()

void BuildPatchServices::FCloudChunkSourceStatistics::OnDownloadHealthUpdated ( EBuildPatchDownloadHealth  DownloadHealth )

overridevirtual

Called whenever the perceived download health changes, according to the provided configuration.

Parameters

DownloadHealth

The new download health value.

Implements BuildPatchServices::ICloudChunkSourceStat.

OnDownloadRequested()

void BuildPatchServices::FCloudChunkSourceStatistics::OnDownloadRequested ( const FGuid &  ChunkId )

overridevirtual

Called whenever a chunk download request is made.

Parameters

ChunkId

The id of the chunk.

Implements BuildPatchServices::ICloudChunkSourceStat.

OnDownloadSuccess()

void BuildPatchServices::FCloudChunkSourceStatistics::OnDownloadSuccess ( const FGuid &  ChunkId )

overridevirtual

Called whenever a chunk download request has succeeded.

Parameters

ChunkId

The id of the chunk.

Implements BuildPatchServices::ICloudChunkSourceStat.

OnReceivedDataUpdated()

void BuildPatchServices::FCloudChunkSourceStatistics::OnReceivedDataUpdated ( int64  TotalBytes )

overridevirtual

Called to update the amount of bytes which have been downloaded.

Parameters

TotalBytes

The number of bytes downloaded so far.

Implements BuildPatchServices::ICloudChunkSourceStat.

OnRequiredDataUpdated()

void BuildPatchServices::FCloudChunkSourceStatistics::OnRequiredDataUpdated ( int64  TotalBytes )

overridevirtual

Called whenever the total number of bytes intended to download updates. This can occur after initialization if a chunk is requested which was not in the original list.

Parameters

TotalBytes

The number of bytes downloaded so far.

Implements BuildPatchServices::ICloudChunkSourceStat.

OnSuccessRateUpdated()

void BuildPatchServices::FCloudChunkSourceStatistics::OnSuccessRateUpdated ( float  SuccessRate )

overridevirtual

Called whenever the success rate of requests has been updated.

Parameters

SuccessRate

The new success rate value, when 1.0 is all requests made so far have been successful, and 0.0 is all requests failed so far.

Implements BuildPatchServices::ICloudChunkSourceStat.

---

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

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