BuildPatchServices::IFileOperationTracker Class Reference

#include <FileOperationTracker.h>

Inheritance diagram for BuildPatchServices::IFileOperationTracker:

Public Member Functions
virtual	~IFileOperationTracker ()
virtual const TArray< FFileOperation > &	GetStates () const =0
virtual void	OnManifestSelection (IBuildManifestSet *ManifestSet)=0
virtual void	OnDataStateUpdate (const FGuid &DataId, EFileOperationState State)=0
virtual void	OnDataStateUpdate (const TSet< FGuid > &DataIds, EFileOperationState State)=0
virtual void	OnDataStateUpdate (const TArray< FGuid > &DataIds, EFileOperationState State)=0
virtual void	OnFileStateUpdate (const FString &Filename, EFileOperationState State)=0
virtual void	OnFileStateUpdate (const TSet< FString > &Filenames, EFileOperationState State)=0
virtual void	OnFileStateUpdate (const TArray< FString > &Filenames, EFileOperationState State)=0
virtual void	OnFileByteRangeStateUpdate (const FString &Filename, FByteRange ByteRange, EFileOperationState State)=0

Detailed Description

An interface for tracking and querying states of granular file operations.

Constructor & Destructor Documentation

~IFileOperationTracker()

virtual BuildPatchServices::IFileOperationTracker::~IFileOperationTracker ( )

inlinevirtual

Member Function Documentation

GetStates()

virtual const TArray< FFileOperation > & BuildPatchServices::IFileOperationTracker::GetStates ( ) const

pure virtual

Returns

the array of states for each file operation performed by the installation.

Implemented in BuildPatchServices::FNullFileOperationTracker, and BuildPatchServices::FFileOperationTracker.

OnDataStateUpdate() [1/3]

virtual void BuildPatchServices::IFileOperationTracker::OnDataStateUpdate ( const FGuid &  DataId, EFileOperationState  State  )

pure virtual

Called when state is updated for chunk data.

Parameters

DataId	Chunk to update state of.
State	New state of the data.

Implemented in BuildPatchServices::FNullFileOperationTracker, and BuildPatchServices::FFileOperationTracker.

OnDataStateUpdate() [2/3]

virtual void BuildPatchServices::IFileOperationTracker::OnDataStateUpdate ( const TArray< FGuid > &  DataIds, EFileOperationState  State  )

pure virtual

Called when state is updated for chunk data.

Parameters

DataId	Chunk array to update state of.
State	New state of the data.

Implemented in BuildPatchServices::FNullFileOperationTracker, and BuildPatchServices::FFileOperationTracker.

OnDataStateUpdate() [3/3]

virtual void BuildPatchServices::IFileOperationTracker::OnDataStateUpdate ( const TSet< FGuid > &  DataIds, EFileOperationState  State  )

pure virtual

Called when state is updated for chunk data.

Parameters

DataIds	Chunk set to update state of.
State	New state of the data.

Implemented in BuildPatchServices::FNullFileOperationTracker, and BuildPatchServices::FFileOperationTracker.

OnFileByteRangeStateUpdate()

virtual void BuildPatchServices::IFileOperationTracker::OnFileByteRangeStateUpdate ( const FString &  Filename, FByteRange  ByteRange, EFileOperationState  State  )

pure virtual

Called when state is updated for file data byte range.

Parameters

Filename	File to update state of.
ByteRange	The byte range of the file to include.
State	New state of the data.

Implemented in BuildPatchServices::FNullFileOperationTracker, and BuildPatchServices::FFileOperationTracker.

OnFileStateUpdate() [1/3]

virtual void BuildPatchServices::IFileOperationTracker::OnFileStateUpdate ( const FString &  Filename, EFileOperationState  State  )

pure virtual

Called when state is updated for file data.

Parameters

Filename	File to update state of.
State	New state of the data.

Implemented in BuildPatchServices::FNullFileOperationTracker, and BuildPatchServices::FFileOperationTracker.

OnFileStateUpdate() [2/3]

virtual void BuildPatchServices::IFileOperationTracker::OnFileStateUpdate ( const TArray< FString > &  Filenames, EFileOperationState  State  )

pure virtual

Called when state is updated for file data.

Parameters

Filename	File array to update state of.
State	New state of the data.

Implemented in BuildPatchServices::FNullFileOperationTracker, and BuildPatchServices::FFileOperationTracker.

OnFileStateUpdate() [3/3]

virtual void BuildPatchServices::IFileOperationTracker::OnFileStateUpdate ( const TSet< FString > &  Filenames, EFileOperationState  State  )

pure virtual

Called when state is updated for file data.

Parameters

Filename	File set to update state of.
State	New state of the data.

Implemented in BuildPatchServices::FNullFileOperationTracker, and BuildPatchServices::FFileOperationTracker.

OnManifestSelection()

virtual void BuildPatchServices::IFileOperationTracker::OnManifestSelection ( IBuildManifestSet *  ManifestSet )

pure virtual

Called when manifest selection occurs. This will clear out internal states resetting them built from the provided manifest. All subsequent state updates must refer to data from within the provided manifest.

Parameters

Manifest

The manifest to be used to build up internal operation states.

Implemented in BuildPatchServices::FNullFileOperationTracker, and BuildPatchServices::FFileOperationTracker.

---

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

• Engine/Source/Runtime/Online/BuildPatchServices/Private/Installer/Statistics/FileOperationTracker.h