BuildPatchServices::IFileConstructorStat Class Reference

#include <BuildPatchFileConstructor.h>

Inheritance diagram for BuildPatchServices::IFileConstructorStat:

Public Member Functions
virtual	~IFileConstructorStat ()
virtual void	OnResumeStarted ()=0
virtual void	OnResumeCompleted ()=0
virtual void	OnChunkGet (const FGuid &ChunkId)=0
virtual void	OnFileStarted (const FString &Filename, int64 FileSize)=0
virtual void	OnFileProgress (const FString &Filename, int64 TotalBytes)=0
virtual void	OnFileCompleted (const FString &Filename, bool bSuccess)=0
virtual void	OnConstructionCompleted ()=0
virtual void	OnProcessedDataUpdated (int64 TotalBytes)=0
virtual void	OnTotalRequiredUpdated (int64 TotalBytes)=0
virtual void	OnBeforeAdminister ()=0
virtual void	OnAfterAdminister (const ISpeedRecorder::FRecord &Record)=0
virtual void	OnBeforeRead ()=0
virtual void	OnAfterRead (const ISpeedRecorder::FRecord &Record)=0
virtual void	OnBeforeWrite ()=0
virtual void	OnAfterWrite (const ISpeedRecorder::FRecord &Record)=0

Detailed Description

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

Constructor & Destructor Documentation

~IFileConstructorStat()

virtual BuildPatchServices::IFileConstructorStat::~IFileConstructorStat ( )

inlinevirtual

Member Function Documentation

OnAfterAdminister()

virtual void BuildPatchServices::IFileConstructorStat::OnAfterAdminister ( const ISpeedRecorder::FRecord &  Record )

pure virtual

Called upon completing an admin operation, with activity recording.

Parameters

Record

The activity record.

Implemented in BuildPatchServices::FFileConstructorStatistics.

OnAfterRead()

virtual void BuildPatchServices::IFileConstructorStat::OnAfterRead ( const ISpeedRecorder::FRecord &  Record )

pure virtual

Called upon completing a read operation, with activity recording.

Parameters

Record

The activity record.

Implemented in BuildPatchServices::FFileConstructorStatistics.

OnAfterWrite()

virtual void BuildPatchServices::IFileConstructorStat::OnAfterWrite ( const ISpeedRecorder::FRecord &  Record )

pure virtual

Called upon completing a write operation, with activity recording.

Parameters

Record

The activity record.

Implemented in BuildPatchServices::FFileConstructorStatistics.

OnBeforeAdminister()

virtual void BuildPatchServices::IFileConstructorStat::OnBeforeAdminister ( )

pure virtual

Called when we are beginning a file administration, such as open, close, seek.

Implemented in BuildPatchServices::FFileConstructorStatistics.

OnBeforeRead()

virtual void BuildPatchServices::IFileConstructorStat::OnBeforeRead ( )

pure virtual

Called when we are beginning a read operation.

Implemented in BuildPatchServices::FFileConstructorStatistics.

OnBeforeWrite()

virtual void BuildPatchServices::IFileConstructorStat::OnBeforeWrite ( )

pure virtual

Called when we are beginning a write operation.

Implemented in BuildPatchServices::FFileConstructorStatistics.

OnChunkGet()

virtual void BuildPatchServices::IFileConstructorStat::OnChunkGet ( const FGuid &  ChunkId )

pure virtual

Called for each Get made to the chunk source.

Parameters

ChunkId

The id for the chunk required.

Implemented in BuildPatchServices::FFileConstructorStatistics.

OnConstructionCompleted()

virtual void BuildPatchServices::IFileConstructorStat::OnConstructionCompleted ( )

pure virtual

Called when the construction process completes.

Implemented in BuildPatchServices::FFileConstructorStatistics.

OnFileCompleted()

virtual void BuildPatchServices::IFileConstructorStat::OnFileCompleted ( const FString &  Filename, bool  bSuccess  )

pure virtual

Called when a file construction has completed.

Parameters

Filename	The filename of the file.
bSuccess	True if the file construction succeeded.

Implemented in BuildPatchServices::FFileConstructorStatistics.

OnFileProgress()

virtual void BuildPatchServices::IFileConstructorStat::OnFileProgress ( const FString &  Filename, int64  TotalBytes  )

pure virtual

Called during a file construction with the current progress.

Parameters

Filename	The filename of the file.
TotalBytes	The number of bytes processed so far.

Implemented in BuildPatchServices::FFileConstructorStatistics.

OnFileStarted()

virtual void BuildPatchServices::IFileConstructorStat::OnFileStarted ( const FString &  Filename, int64  FileSize  )

pure virtual

Called when a file construction has started.

Parameters

Filename	The filename of the file.
FileSize	The size of the file being constructed.

Implemented in BuildPatchServices::FFileConstructorStatistics.

OnProcessedDataUpdated()

virtual void BuildPatchServices::IFileConstructorStat::OnProcessedDataUpdated ( int64  TotalBytes )

pure virtual

Called to update the total amount of bytes which have been constructed.

Parameters

TotalBytes

The number of bytes constructed so far.

Implemented in BuildPatchServices::FFileConstructorStatistics.

OnResumeCompleted()

virtual void BuildPatchServices::IFileConstructorStat::OnResumeCompleted ( )

pure virtual

Called when the resume process completes.

Implemented in BuildPatchServices::FFileConstructorStatistics.

OnResumeStarted()

virtual void BuildPatchServices::IFileConstructorStat::OnResumeStarted ( )

pure virtual

Called when the resume process begins.

Implemented in BuildPatchServices::FFileConstructorStatistics.

OnTotalRequiredUpdated()

virtual void BuildPatchServices::IFileConstructorStat::OnTotalRequiredUpdated ( int64  TotalBytes )

pure virtual

Called to update the total number of bytes to be constructed.

Parameters

TotalBytes

The total number of bytes to be constructed.

Implemented in BuildPatchServices::FFileConstructorStatistics.

---

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

• Engine/Source/Runtime/Online/BuildPatchServices/Private/BuildPatchFileConstructor.h