BuildPatchServices::ICloudChunkSourceStat Class Reference

#include <CloudChunkSource.h>

Inheritance diagram for BuildPatchServices::ICloudChunkSourceStat:

Public Member Functions
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

This interface defines the statistics class required by the cloud source. It should be implemented in order to collect desired information which is being broadcast by the system.

Constructor & Destructor Documentation

~ICloudChunkSourceStat()

virtual BuildPatchServices::ICloudChunkSourceStat::~ICloudChunkSourceStat ( )

inlinevirtual

Member Function Documentation

OnAcceptedNewRequirements()

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

pure virtual

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

Parameters

ChunkIds

The ids of each chunk.

Implemented in DeltaStats::FNoCloudChunkSourceStat, and BuildPatchServices::FCloudChunkSourceStatistics.

OnActiveRequestCountUpdated()

virtual void BuildPatchServices::ICloudChunkSourceStat::OnActiveRequestCountUpdated ( uint32  RequestCount )

pure virtual

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.

Implemented in DeltaStats::FNoCloudChunkSourceStat, and BuildPatchServices::FCloudChunkSourceStatistics.

OnDownloadAborted()

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

pure virtual

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.

Implemented in DeltaStats::FNoCloudChunkSourceStat, and BuildPatchServices::FCloudChunkSourceStatistics.

OnDownloadCorrupt()

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

pure virtual

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.

Implemented in BuildPatchServices::FCloudChunkSourceStatistics.

OnDownloadFailed()

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

pure virtual

Called whenever a chunk download request has failed.

Parameters

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

Implemented in DeltaStats::FNoCloudChunkSourceStat, and BuildPatchServices::FCloudChunkSourceStatistics.

OnDownloadHealthUpdated()

virtual void BuildPatchServices::ICloudChunkSourceStat::OnDownloadHealthUpdated ( EBuildPatchDownloadHealth  DownloadHealth )

pure virtual

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

Parameters

DownloadHealth

The new download health value.

Implemented in DeltaStats::FNoCloudChunkSourceStat, and BuildPatchServices::FCloudChunkSourceStatistics.

OnDownloadRequested()

virtual void BuildPatchServices::ICloudChunkSourceStat::OnDownloadRequested ( const FGuid &  ChunkId )

pure virtual

Called whenever a chunk download request is made.

Parameters

ChunkId

The id of the chunk.

Implemented in DeltaStats::FNoCloudChunkSourceStat, and BuildPatchServices::FCloudChunkSourceStatistics.

OnDownloadSuccess()

virtual void BuildPatchServices::ICloudChunkSourceStat::OnDownloadSuccess ( const FGuid &  ChunkId )

pure virtual

Called whenever a chunk download request has succeeded.

Parameters

ChunkId

The id of the chunk.

Implemented in DeltaStats::FNoCloudChunkSourceStat, and BuildPatchServices::FCloudChunkSourceStatistics.

OnReceivedDataUpdated()

virtual void BuildPatchServices::ICloudChunkSourceStat::OnReceivedDataUpdated ( int64  TotalBytes )

pure virtual

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

Parameters

TotalBytes

The number of bytes downloaded so far.

Implemented in DeltaStats::FNoCloudChunkSourceStat, and BuildPatchServices::FCloudChunkSourceStatistics.

OnRequiredDataUpdated()

virtual void BuildPatchServices::ICloudChunkSourceStat::OnRequiredDataUpdated ( int64  TotalBytes )

pure virtual

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.

Implemented in DeltaStats::FNoCloudChunkSourceStat, and BuildPatchServices::FCloudChunkSourceStatistics.

OnSuccessRateUpdated()

virtual void BuildPatchServices::ICloudChunkSourceStat::OnSuccessRateUpdated ( float  SuccessRate )

pure virtual

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.

Implemented in DeltaStats::FNoCloudChunkSourceStat, and BuildPatchServices::FCloudChunkSourceStatistics.

---

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

• Engine/Source/Runtime/Online/BuildPatchServices/Private/Installer/CloudChunkSource.h