BuildPatchServices::FChunkReferenceTracker Class Reference

Inheritance diagram for BuildPatchServices::FChunkReferenceTracker:

Public Member Functions
	FChunkReferenceTracker (const IBuildManifestSet *ManifestSet, const TSet< FString > &FilesToConstruct)
	FChunkReferenceTracker (TArray< FGuid > CustomUseList)
	~FChunkReferenceTracker ()
virtual void	CopyOutOrderedUseList (TArray< FGuid > &OutUseList) const override
virtual TSet< FGuid >	GetReferencedChunks () const override
virtual int32	GetReferenceCount (const FGuid &ChunkId) const override
virtual void	SortByUseOrder (TArray< FGuid > &ChunkList, ESortDirection Direction) const override
virtual TArray< FGuid >	GetNextReferences (int32 Count, const TFunction< bool(const FGuid &)> &SelectPredicate) const override
virtual TArray< FGuid >	SelectFromNextReferences (int32 Count, const TFunction< bool(const FGuid &)> &SelectPredicate) const override
virtual bool	PopReference (const FGuid &ChunkId) override
virtual int32	GetRemainingChunkCount () const override
virtual int32	GetNextUsageForChunk (const FGuid &ChunkId, int32 &OutLastUsageIndex) const override
virtual int32	GetCurrentUsageIndex () const override
Public Member Functions inherited from BuildPatchServices::IChunkReferenceTracker
virtual	~IChunkReferenceTracker ()

Additional Inherited Members
Public Types inherited from BuildPatchServices::IChunkReferenceTracker
enum class	ESortDirection : uint8 { Ascending = 0 , Descending }

Constructor & Destructor Documentation

FChunkReferenceTracker() [1/2]

BuildPatchServices::FChunkReferenceTracker::FChunkReferenceTracker	(	const IBuildManifestSet *	ManifestSet,
		const TSet< FString > &	FilesToConstruct
	)

FChunkReferenceTracker() [2/2]

BuildPatchServices::FChunkReferenceTracker::FChunkReferenceTracker

(

TArray< FGuid >

CustomUseList

)

~FChunkReferenceTracker()

BuildPatchServices::FChunkReferenceTracker::~FChunkReferenceTracker

(

)

Member Function Documentation

CopyOutOrderedUseList()

virtual void BuildPatchServices::FChunkReferenceTracker::CopyOutOrderedUseList ( TArray< FGuid > &  OutUseList ) const

inlineoverridevirtual

Implements BuildPatchServices::IChunkReferenceTracker.

GetCurrentUsageIndex()

virtual int32 BuildPatchServices::FChunkReferenceTracker::GetCurrentUsageIndex ( ) const

inlineoverridevirtual

Implements BuildPatchServices::IChunkReferenceTracker.

GetNextReferences()

TArray< FGuid > BuildPatchServices::FChunkReferenceTracker::GetNextReferences ( int32  Count, const TFunction< bool(const FGuid &)> &  SelectPredicate  ) const

overridevirtual

Find the next X chunk references that match the provided predicate.

Parameters

Count	The number of chunk entries that are desired.
SelectPredicate	The predicate used to select each chunk.

Returns

an array of unique chunk id entries, in the order in which they are required.

Implements BuildPatchServices::IChunkReferenceTracker.

GetNextUsageForChunk()

int32 BuildPatchServices::FChunkReferenceTracker::GetNextUsageForChunk ( const FGuid &  ChunkId, int32 &  OutLastUsageIndex  ) const

overridevirtual

Implements BuildPatchServices::IChunkReferenceTracker.

GetReferenceCount()

int32 BuildPatchServices::FChunkReferenceTracker::GetReferenceCount ( const FGuid &  ChunkId ) const

overridevirtual

Gets the number of times a specific chunk is still referenced for the associated installation.

Parameters

ChunkId

The id for the chunk in question.

Returns

the number of references remaining.

Implements BuildPatchServices::IChunkReferenceTracker.

GetReferencedChunks()

TSet< FGuid > BuildPatchServices::FChunkReferenceTracker::GetReferencedChunks ( ) const

overridevirtual

Gets a set of all chunks referenced by the installation this tracker refers to. This returns the remaining referenced chunks!

Returns

set of GUID containing every chunk used.

Implements BuildPatchServices::IChunkReferenceTracker.

GetRemainingChunkCount()

int32 BuildPatchServices::FChunkReferenceTracker::GetRemainingChunkCount ( ) const

overridevirtual

Implements BuildPatchServices::IChunkReferenceTracker.

PopReference()

bool BuildPatchServices::FChunkReferenceTracker::PopReference ( const FGuid &  ChunkId )

overridevirtual

Poorly named - Should be named "DoneWithChunk". The expectation is that we finish with chunks in the expected use order.

Pop the top reference from the tracker, indicating that operation has been performed. It is not valid to pop anything but the top guid, so it must be provided for verification of behavior.

Parameters

ChunkId

The id of the top chunk, this is used to verify behavior.

Returns

true if the correct guid was provided and the reference was popped, false if the wrong guid was provided and thus no change was made.

Implements BuildPatchServices::IChunkReferenceTracker.

SelectFromNextReferences()

TArray< FGuid > BuildPatchServices::FChunkReferenceTracker::SelectFromNextReferences ( int32  Count, const TFunction< bool(const FGuid &)> &  SelectPredicate  ) const

overridevirtual

Select from the next X chunk references, entries that match the provided predicate.

Parameters

Count	The number of chunk entries to search through.
SelectPredicate	The predicate used to select each chunk.

Returns

an array of unique chunk id entries, in the order in which they are required.

Implements BuildPatchServices::IChunkReferenceTracker.

SortByUseOrder()

void BuildPatchServices::FChunkReferenceTracker::SortByUseOrder ( TArray< FGuid > &  ChunkList, ESortDirection  Direction  ) const

overridevirtual

Sorts a given array of chunk ids by the order in which they are required for the installation.

Parameters

ChunkList	The array to be sorted.
Direction	The direction of sort. Ascending places soonest required chunk first.

Implements BuildPatchServices::IChunkReferenceTracker.

---

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

• Engine/Source/Runtime/Online/BuildPatchServices/Private/Installer/ChunkReferenceTracker.cpp