UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
BuildPatchServices::IDownloadServiceStatistics Class Referenceabstract

#include <DownloadServiceStatistics.h>

+ Inheritance diagram for BuildPatchServices::IDownloadServiceStatistics:

Public Member Functions

virtual uint64 GetBytesDownloaded () const =0
 
virtual int32 GetNumSuccessfulChunkDownloads () const =0
 
virtual int32 GetNumFailedChunkDownloads () const =0
 
virtual int32 GetNumCurrentDownloads () const =0
 
virtual TArray< FDownloadGetCurrentDownloads () const =0
 
virtual TPair< double, uint32GetImmediateAverageSpeedPerRequest (uint32 MinCount)=0
 
virtual void Reset ()=0
 
- Public Member Functions inherited from BuildPatchServices::IDownloadServiceStat
virtual ~IDownloadServiceStat ()
 
virtual void OnDownloadStarted (int32 RequestId, const FString &Uri)=0
 
virtual void OnDownloadProgress (int32 RequestId, uint64 BytesReceived)=0
 
virtual void OnDownloadComplete (const FDownloadRecord &DownloadRecord)=0
 

Detailed Description

Interface to the statistics class which provides access to tracked values from a download service stat.

Member Function Documentation

◆ GetBytesDownloaded()

virtual uint64 BuildPatchServices::IDownloadServiceStatistics::GetBytesDownloaded ( ) const
pure virtual
Returns
the total number of bytes downloaded.

Implemented in BuildPatchServices::FDownloadServiceStatistics.

◆ GetCurrentDownloads()

virtual TArray< FDownload > BuildPatchServices::IDownloadServiceStatistics::GetCurrentDownloads ( ) const
pure virtual
Returns
an array of current request info.

Implemented in BuildPatchServices::FDownloadServiceStatistics.

◆ GetImmediateAverageSpeedPerRequest()

virtual TPair< double, uint32 > BuildPatchServices::IDownloadServiceStatistics::GetImmediateAverageSpeedPerRequest ( uint32  MinCount)
pure virtual

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.

Implemented in BuildPatchServices::FDownloadServiceStatistics.

◆ GetNumCurrentDownloads()

virtual int32 BuildPatchServices::IDownloadServiceStatistics::GetNumCurrentDownloads ( ) const
pure virtual
Returns
the number of current requests.

Implemented in BuildPatchServices::FDownloadServiceStatistics.

◆ GetNumFailedChunkDownloads()

virtual int32 BuildPatchServices::IDownloadServiceStatistics::GetNumFailedChunkDownloads ( ) const
pure virtual
Returns
the number of chunk requests that failed.

Implemented in BuildPatchServices::FDownloadServiceStatistics.

◆ GetNumSuccessfulChunkDownloads()

virtual int32 BuildPatchServices::IDownloadServiceStatistics::GetNumSuccessfulChunkDownloads ( ) const
pure virtual
Returns
the number of successfully downloaded chunks.

Implemented in BuildPatchServices::FDownloadServiceStatistics.

◆ Reset()

virtual void BuildPatchServices::IDownloadServiceStatistics::Reset ( )
pure virtual

Resets all internal statistics.

Implemented in BuildPatchServices::FDownloadServiceStatistics.


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