BuildPatchServices::IInstallChunkSourceStat Class Reference

#include <InstallChunkSource.h>

Inheritance diagram for BuildPatchServices::IInstallChunkSourceStat:

Public Types
enum class	ELoadResult : uint8 {   Success = 0 , MissingHashInfo , MissingPartInfo , OpenFileFail ,   IncorrectFileSize_DEPRECATED , HashCheckFailed , Aborted , InvalidChunkParts }

Public Member Functions
virtual	~IInstallChunkSourceStat ()
virtual void	OnBatchStarted (const TArray< FGuid > &ChunkIds)
virtual void	OnLoadStarted (const FGuid &ChunkId)=0
virtual void	OnLoadComplete (const FGuid &ChunkId, const ELoadResult &Result, const ISpeedRecorder::FRecord &Record)=0
virtual void	OnAcceptedNewRequirements (const TSet< FGuid > &ChunkIds)

Detailed Description

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

Member Enumeration Documentation

ELoadResult

enum class BuildPatchServices::IInstallChunkSourceStat::ELoadResult : uint8

strong

Enum which describes success, or the reason for failure when loading a chunk.

Enumerator
Success
MissingHashInfo
MissingPartInfo
OpenFileFail
IncorrectFileSize_DEPRECATED
HashCheckFailed
Aborted
InvalidChunkParts

Constructor & Destructor Documentation

~IInstallChunkSourceStat()

virtual BuildPatchServices::IInstallChunkSourceStat::~IInstallChunkSourceStat ( )

inlinevirtual

Member Function Documentation

OnAcceptedNewRequirements()

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

inlinevirtual

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

Parameters

ChunkIds

The ids of each chunk.

OnBatchStarted()

virtual void BuildPatchServices::IInstallChunkSourceStat::OnBatchStarted ( const TArray< FGuid > &  ChunkIds )

inlinevirtual

Called when a batch of chunks are going to be loaded.

Parameters

ChunkIds

The ids of each chunk.

OnLoadComplete()

virtual void BuildPatchServices::IInstallChunkSourceStat::OnLoadComplete ( const FGuid &  ChunkId, const ELoadResult &  Result, const ISpeedRecorder::FRecord &  Record  )

pure virtual

Called each time a chunk load completes.

Parameters

ChunkId	The id of the chunk.
Result	The load result.
Record	The recording for the received data.

Implemented in BuildPatchServices::FInstallChunkSourceStatistics.

OnLoadStarted()

virtual void BuildPatchServices::IInstallChunkSourceStat::OnLoadStarted ( const FGuid &  ChunkId )

pure virtual

Called each time a chunk load begins.

Parameters

ChunkId

The id of the chunk.

Implemented in BuildPatchServices::FInstallChunkSourceStatistics.

---

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

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