Inheritance diagram for BuildPatchServices::FFileConstructorStatistics:

Public Member Functions
	FFileConstructorStatistics (ISpeedRecorder ReadSpeedRecorder, ISpeedRecorder WriteSpeedRecorder, FBuildPatchProgress BuildProgress, IFileOperationTracker FileOperationTracker)

	~FFileConstructorStatistics ()

virtual void	OnResumeStarted () override

virtual void	OnResumeCompleted () override

virtual void	OnChunkGet (const FGuid &ChunkId) override

virtual void	OnFileStarted (const FString &Filename, int64 FileSize) override

virtual void	OnFileProgress (const FString &Filename, int64 TotalBytes) override

virtual void	OnFileCompleted (const FString &Filename, bool bSuccess) override

virtual void	OnConstructionCompleted () override

virtual void	OnProcessedDataUpdated (int64 TotalBytes) override

virtual void	OnTotalRequiredUpdated (int64 TotalBytes) override

virtual void	OnBeforeAdminister () override

virtual void	OnAfterAdminister (const ISpeedRecorder::FRecord &Record) override

virtual void	OnBeforeRead () override

virtual void	OnAfterRead (const ISpeedRecorder::FRecord &Record) override

virtual void	OnBeforeWrite () override

virtual void	OnAfterWrite (const ISpeedRecorder::FRecord &Record) override

virtual int64	GetRequiredConstructSize () const override

virtual uint64	GetBytesConstructed () const override

virtual uint64	GetFilesConstructed () const override

virtual FGuid	GetCurrentChunk () const override

virtual FString	GetCurrentFile () const override

virtual float	GetCurrentFileProgress () const override

virtual bool	IsCurrentlyWriting () const override

virtual bool	IsCurrentlyReading () const override

virtual bool	IsCurrentlyAdministering () const override

Public Member Functions inherited from BuildPatchServices::IFileConstructorStat
virtual	~IFileConstructorStat ()

Constructor & Destructor Documentation

◆ FFileConstructorStatistics()

BuildPatchServices::FFileConstructorStatistics::FFileConstructorStatistics	(	ISpeedRecorder *	ReadSpeedRecorder,
		ISpeedRecorder *	WriteSpeedRecorder,
		FBuildPatchProgress *	BuildProgress,
		IFileOperationTracker *	FileOperationTracker
	)

◆ ~FFileConstructorStatistics()

BuildPatchServices::FFileConstructorStatistics::~FFileConstructorStatistics ( )

Member Function Documentation

◆ GetBytesConstructed()

uint64 BuildPatchServices::FFileConstructorStatistics::GetBytesConstructed ( ) const

overridevirtual

Returns: the total number of bytes constructed.

Implements BuildPatchServices::IFileConstructorStatistics.

◆ GetCurrentChunk()

FGuid BuildPatchServices::FFileConstructorStatistics::GetCurrentChunk ( ) const

overridevirtual

Returns: the current chunk data is being serialized from.

Implements BuildPatchServices::IFileConstructorStatistics.

◆ GetCurrentFile()

FString BuildPatchServices::FFileConstructorStatistics::GetCurrentFile ( ) const

overridevirtual

Returns: the current file data is being serialized to.

Implements BuildPatchServices::IFileConstructorStatistics.

◆ GetCurrentFileProgress()

float BuildPatchServices::FFileConstructorStatistics::GetCurrentFileProgress ( ) const

overridevirtual

Returns: the current file progress.

Implements BuildPatchServices::IFileConstructorStatistics.

◆ GetFilesConstructed()

uint64 BuildPatchServices::FFileConstructorStatistics::GetFilesConstructed ( ) const

overridevirtual

Returns: the total number of files constructed.

Implements BuildPatchServices::IFileConstructorStatistics.

◆ GetRequiredConstructSize()

int64 BuildPatchServices::FFileConstructorStatistics::GetRequiredConstructSize ( ) const

overridevirtual

Returns: the number of bytes to construct to complete the installation.

Implements BuildPatchServices::IFileConstructorStatistics.

◆ IsCurrentlyAdministering()

bool BuildPatchServices::FFileConstructorStatistics::IsCurrentlyAdministering ( ) const

overridevirtual

Returns: true if currently administering files.

Implements BuildPatchServices::IFileConstructorStatistics.

◆ IsCurrentlyReading()

bool BuildPatchServices::FFileConstructorStatistics::IsCurrentlyReading ( ) const

overridevirtual

Returns: true if currently reading disk data.

Implements BuildPatchServices::IFileConstructorStatistics.

◆ IsCurrentlyWriting()

bool BuildPatchServices::FFileConstructorStatistics::IsCurrentlyWriting ( ) const

overridevirtual

Returns: true if currently writing disk data.

Implements BuildPatchServices::IFileConstructorStatistics.

◆ OnAfterAdminister()

void BuildPatchServices::FFileConstructorStatistics::OnAfterAdminister ( const ISpeedRecorder::FRecord & Record )

overridevirtual

Called upon completing an admin operation, with activity recording.

Parameters

Record The activity record.

Implements BuildPatchServices::IFileConstructorStat.

◆ OnAfterRead()

void BuildPatchServices::FFileConstructorStatistics::OnAfterRead ( const ISpeedRecorder::FRecord & Record )

overridevirtual

Called upon completing a read operation, with activity recording.

Parameters

Record The activity record.

Implements BuildPatchServices::IFileConstructorStat.

◆ OnAfterWrite()

void BuildPatchServices::FFileConstructorStatistics::OnAfterWrite ( const ISpeedRecorder::FRecord & Record )

overridevirtual

Called upon completing a write operation, with activity recording.

Parameters

Record The activity record.

Implements BuildPatchServices::IFileConstructorStat.

◆ OnBeforeAdminister()

void BuildPatchServices::FFileConstructorStatistics::OnBeforeAdminister ( )

overridevirtual

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

Implements BuildPatchServices::IFileConstructorStat.

◆ OnBeforeRead()

void BuildPatchServices::FFileConstructorStatistics::OnBeforeRead ( )

overridevirtual

Called when we are beginning a read operation.

Implements BuildPatchServices::IFileConstructorStat.

◆ OnBeforeWrite()

void BuildPatchServices::FFileConstructorStatistics::OnBeforeWrite ( )

overridevirtual

Called when we are beginning a write operation.

Implements BuildPatchServices::IFileConstructorStat.

◆ OnChunkGet()

void BuildPatchServices::FFileConstructorStatistics::OnChunkGet ( const FGuid & ChunkId )

overridevirtual

Called for each Get made to the chunk source.

Parameters

ChunkId The id for the chunk required.

Implements BuildPatchServices::IFileConstructorStat.

◆ OnConstructionCompleted()

void BuildPatchServices::FFileConstructorStatistics::OnConstructionCompleted ( )

overridevirtual

Called when the construction process completes.

Implements BuildPatchServices::IFileConstructorStat.

◆ OnFileCompleted()

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

overridevirtual

Called when a file construction has completed.

Parameters

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

Implements BuildPatchServices::IFileConstructorStat.

◆ OnFileProgress()

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

overridevirtual

Called during a file construction with the current progress.

Parameters

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

Implements BuildPatchServices::IFileConstructorStat.

◆ OnFileStarted()

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

overridevirtual

Called when a file construction has started.

Parameters

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

Implements BuildPatchServices::IFileConstructorStat.

◆ OnProcessedDataUpdated()

void BuildPatchServices::FFileConstructorStatistics::OnProcessedDataUpdated ( int64 TotalBytes )

overridevirtual

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

Parameters

TotalBytes The number of bytes constructed so far.

Implements BuildPatchServices::IFileConstructorStat.

◆ OnResumeCompleted()

void BuildPatchServices::FFileConstructorStatistics::OnResumeCompleted ( )

overridevirtual

Called when the resume process completes.

Implements BuildPatchServices::IFileConstructorStat.

◆ OnResumeStarted()

void BuildPatchServices::FFileConstructorStatistics::OnResumeStarted ( )

overridevirtual

Called when the resume process begins.

Implements BuildPatchServices::IFileConstructorStat.

◆ OnTotalRequiredUpdated()

void BuildPatchServices::FFileConstructorStatistics::OnTotalRequiredUpdated ( int64 TotalBytes )

overridevirtual

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

Parameters

TotalBytes The total number of bytes to be constructed.

Implements BuildPatchServices::IFileConstructorStat.

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

Engine/Source/Runtime/Online/BuildPatchServices/Private/Installer/Statistics/FileConstructorStatistics.cpp

Public Member Functions

Constructor & Destructor Documentation

◆ FFileConstructorStatistics()

◆ ~FFileConstructorStatistics()

Member Function Documentation

◆ GetBytesConstructed()

◆ GetCurrentChunk()

◆ GetCurrentFile()

◆ GetCurrentFileProgress()

◆ GetFilesConstructed()

◆ GetRequiredConstructSize()

◆ IsCurrentlyAdministering()

◆ IsCurrentlyReading()

◆ IsCurrentlyWriting()

◆ OnAfterAdminister()

◆ OnAfterRead()

◆ OnAfterWrite()

◆ OnBeforeAdminister()

◆ OnBeforeRead()

◆ OnBeforeWrite()

◆ OnChunkGet()

◆ OnConstructionCompleted()

◆ OnFileCompleted()

◆ OnFileProgress()

◆ OnFileStarted()

◆ OnProcessedDataUpdated()

◆ OnResumeCompleted()

◆ OnResumeStarted()

◆ OnTotalRequiredUpdated()