UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
BuildPatchServices::FDownloadServiceStatistics Class Reference
+ Inheritance diagram for BuildPatchServices::FDownloadServiceStatistics:

Public Member Functions

 FDownloadServiceStatistics (ISpeedRecorder *SpeedRecorder, IDataSizeProvider *DataSizeProvider, IInstallerAnalytics *InstallerAnalytics)
 
virtual void OnDownloadStarted (int32 RequestId, const FString &Uri) override
 
virtual void OnDownloadProgress (int32 RequestId, uint64 BytesReceived) override
 
virtual void OnDownloadComplete (const FDownloadRecord &DownloadRecord) override
 
virtual uint64 GetBytesDownloaded () const override
 
virtual int32 GetNumSuccessfulChunkDownloads () const override
 
virtual int32 GetNumFailedChunkDownloads () const override
 
virtual int32 GetNumCurrentDownloads () const override
 
virtual TArray< FDownloadGetCurrentDownloads () const override
 
virtual TPair< double, uint32GetImmediateAverageSpeedPerRequest (uint32 MinCount) override
 
virtual void Reset () override
 
- Public Member Functions inherited from BuildPatchServices::IDownloadServiceStat
virtual ~IDownloadServiceStat ()
 

Constructor & Destructor Documentation

◆ FDownloadServiceStatistics()

BuildPatchServices::FDownloadServiceStatistics::FDownloadServiceStatistics ( ISpeedRecorder SpeedRecorder,
IDataSizeProvider DataSizeProvider,
IInstallerAnalytics InstallerAnalytics 
)

Member Function Documentation

◆ GetBytesDownloaded()

uint64 BuildPatchServices::FDownloadServiceStatistics::GetBytesDownloaded ( ) const
overridevirtual
Returns
the total number of bytes downloaded.

Implements BuildPatchServices::IDownloadServiceStatistics.

◆ GetCurrentDownloads()

TArray< FDownload > BuildPatchServices::FDownloadServiceStatistics::GetCurrentDownloads ( ) const
overridevirtual
Returns
an array of current request info.

Implements BuildPatchServices::IDownloadServiceStatistics.

◆ GetImmediateAverageSpeedPerRequest()

TPair< double, uint32 > BuildPatchServices::FDownloadServiceStatistics::GetImmediateAverageSpeedPerRequest ( uint32  MinCount)
overridevirtual

Calculates the average speed per request since the last time this function was called. NOT A CUMULATIVE AVERAGE

Parameters
MinCount– The smallest number of samples that will be used for calculating an average; if the minimum count isn't met, the same value as the previous call is returned, and the samples will continue to accumulate.
Returns
A pair containing an average of the per-request download speed SINCE THIS FUNCTION WAS LAST CALLED and the count of requests completed since the last call.

Implements BuildPatchServices::IDownloadServiceStatistics.

◆ GetNumCurrentDownloads()

int32 BuildPatchServices::FDownloadServiceStatistics::GetNumCurrentDownloads ( ) const
overridevirtual
Returns
the number of current requests.

Implements BuildPatchServices::IDownloadServiceStatistics.

◆ GetNumFailedChunkDownloads()

int32 BuildPatchServices::FDownloadServiceStatistics::GetNumFailedChunkDownloads ( ) const
overridevirtual
Returns
the number of chunk requests that failed.

Implements BuildPatchServices::IDownloadServiceStatistics.

◆ GetNumSuccessfulChunkDownloads()

int32 BuildPatchServices::FDownloadServiceStatistics::GetNumSuccessfulChunkDownloads ( ) const
overridevirtual
Returns
the number of successfully downloaded chunks.

Implements BuildPatchServices::IDownloadServiceStatistics.

◆ OnDownloadComplete()

void BuildPatchServices::FDownloadServiceStatistics::OnDownloadComplete ( const FDownloadRecord DownloadRecord)
overridevirtual

Called for each request completion.

Parameters
DownloadRecordThe struct containing the stats for this request.

Implements BuildPatchServices::IDownloadServiceStat.

◆ OnDownloadProgress()

void BuildPatchServices::FDownloadServiceStatistics::OnDownloadProgress ( int32  RequestId,
uint64  BytesReceived 
)
overridevirtual

Called for each request completion.

Parameters
RequestIdThe id for the request.
BytesReceivedThe bytes received so far.

Implements BuildPatchServices::IDownloadServiceStat.

◆ OnDownloadStarted()

void BuildPatchServices::FDownloadServiceStatistics::OnDownloadStarted ( int32  RequestId,
const FString &  Uri 
)
overridevirtual

Called as each request has started.

Parameters
RequestIdThe id for the request.
UriThe uri for the request.

Implements BuildPatchServices::IDownloadServiceStat.

◆ Reset()

void BuildPatchServices::FDownloadServiceStatistics::Reset ( )
overridevirtual

Resets all internal statistics.

Implements BuildPatchServices::IDownloadServiceStatistics.


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