UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
BuildPatchServices::FMemoryChunkStoreStatistics Class Reference
+ Inheritance diagram for BuildPatchServices::FMemoryChunkStoreStatistics:

Public Member Functions

 FMemoryChunkStoreStatistics (IFileOperationTracker *FileOperationTracker)
 
 ~FMemoryChunkStoreStatistics ()
 
virtual void OnChunkStored (const FGuid &ChunkId) override
 
virtual void OnChunkReleased (const FGuid &ChunkId) override
 
virtual void OnChunkBooted (const FGuid &ChunkId) override
 
virtual void OnStoreUseUpdated (int32 ChunkCount) override
 
virtual void OnStoreSizeUpdated (int32 Size) override
 
virtual int32 GetStoreUse () const override
 
virtual int32 GetStoreRetained () const override
 
virtual int32 GetNumBooted () const override
 
virtual int32 GetStoreSize () const override
 
virtual float GetAverageStoreUse () const override
 
virtual int32 GetPeakStoreUse () const override
 
virtual float GetAverageStoreRetained () const override
 
virtual int32 GetPeakStoreRetained () const override
 
virtual void SetMultipleReferencedChunk (TSet< FGuid > MultipleReferencedChunks) override
 
- Public Member Functions inherited from BuildPatchServices::IMemoryChunkStoreStat
virtual ~IMemoryChunkStoreStat ()
 

Constructor & Destructor Documentation

◆ FMemoryChunkStoreStatistics()

BuildPatchServices::FMemoryChunkStoreStatistics::FMemoryChunkStoreStatistics ( IFileOperationTracker FileOperationTracker)

◆ ~FMemoryChunkStoreStatistics()

BuildPatchServices::FMemoryChunkStoreStatistics::~FMemoryChunkStoreStatistics ( )

Member Function Documentation

◆ GetAverageStoreRetained()

float BuildPatchServices::FMemoryChunkStoreStatistics::GetAverageStoreRetained ( ) const
overridevirtual
Returns
the average number of chunks held which are retained due to multiple references.

Implements BuildPatchServices::IMemoryChunkStoreStatistics.

◆ GetAverageStoreUse()

float BuildPatchServices::FMemoryChunkStoreStatistics::GetAverageStoreUse ( ) const
overridevirtual
Returns
the average number of chunks held.

Implements BuildPatchServices::IMemoryChunkStoreStatistics.

◆ GetNumBooted()

int32 BuildPatchServices::FMemoryChunkStoreStatistics::GetNumBooted ( ) const
overridevirtual
Returns
the number of chunks which have been booted.

Implements BuildPatchServices::IMemoryChunkStoreStatistics.

◆ GetPeakStoreRetained()

int32 BuildPatchServices::FMemoryChunkStoreStatistics::GetPeakStoreRetained ( ) const
overridevirtual
Returns
the peak number of chunks held which are retained due to multiple references.

Implements BuildPatchServices::IMemoryChunkStoreStatistics.

◆ GetPeakStoreUse()

int32 BuildPatchServices::FMemoryChunkStoreStatistics::GetPeakStoreUse ( ) const
overridevirtual
Returns
the peak number of chunks held.

Implements BuildPatchServices::IMemoryChunkStoreStatistics.

◆ GetStoreRetained()

int32 BuildPatchServices::FMemoryChunkStoreStatistics::GetStoreRetained ( ) const
overridevirtual
Returns
the number of chunks held which are retained due to multiple references.

Implements BuildPatchServices::IMemoryChunkStoreStatistics.

◆ GetStoreSize()

int32 BuildPatchServices::FMemoryChunkStoreStatistics::GetStoreSize ( ) const
overridevirtual
Returns
the maximum number of chunks which can be held.

Implements BuildPatchServices::IMemoryChunkStoreStatistics.

◆ GetStoreUse()

int32 BuildPatchServices::FMemoryChunkStoreStatistics::GetStoreUse ( ) const
overridevirtual
Returns
the number of chunks held.

Implements BuildPatchServices::IMemoryChunkStoreStatistics.

◆ OnChunkBooted()

void BuildPatchServices::FMemoryChunkStoreStatistics::OnChunkBooted ( const FGuid ChunkId)
overridevirtual

Called whenever a chunk has been booted from the store because a new one was added that is required sooner.

Parameters
ChunkIdThe id of the chunk.

Implements BuildPatchServices::IMemoryChunkStoreStat.

◆ OnChunkReleased()

void BuildPatchServices::FMemoryChunkStoreStatistics::OnChunkReleased ( const FGuid ChunkId)
overridevirtual

Called whenever a chunk has been release from the store as it was no longer referenced.

Parameters
ChunkIdThe id of the chunk.

Implements BuildPatchServices::IMemoryChunkStoreStat.

◆ OnChunkStored()

void BuildPatchServices::FMemoryChunkStoreStatistics::OnChunkStored ( const FGuid ChunkId)
overridevirtual

Called whenever a new chunk has been put into the store.

Parameters
ChunkIdThe id of the chunk.

Implements BuildPatchServices::IMemoryChunkStoreStat.

◆ OnStoreSizeUpdated()

void BuildPatchServices::FMemoryChunkStoreStatistics::OnStoreSizeUpdated ( int32  Size)
overridevirtual

Called whenever the total size allotted for the store is updated.

Parameters
SizeThe total number of chunks that can be stored.

Implements BuildPatchServices::IMemoryChunkStoreStat.

◆ OnStoreUseUpdated()

void BuildPatchServices::FMemoryChunkStoreStatistics::OnStoreUseUpdated ( int32  ChunkCount)
overridevirtual

Called whenever the number of chunks in the store is updated.

Parameters
ChunkCountThe number of chunks now contained in the store.

Implements BuildPatchServices::IMemoryChunkStoreStat.

◆ SetMultipleReferencedChunk()

void BuildPatchServices::FMemoryChunkStoreStatistics::SetMultipleReferencedChunk ( TSet< FGuid MultipleReferencedChunks)
overridevirtual

Sets the chunks that are referenced multiple times in order to track retained.

Parameters
MultipleReferencedChunksFor retained stats, the set of chunks which have multiple references.

Implements BuildPatchServices::IMemoryChunkStoreStatistics.


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