BuildPatchServices::IChunkSource Class Reference

#include <ChunkSource.h>

Inheritance diagram for BuildPatchServices::IChunkSource:

Public Member Functions
virtual	~IChunkSource ()
virtual IChunkDataAccess *	Get (const FGuid &DataId)=0
virtual TSet< FGuid >	AddRuntimeRequirements (TSet< FGuid > NewRequirements)=0
virtual bool	AddRepeatRequirement (const FGuid &RepeatRequirement)=0
virtual void	SetUnavailableChunksCallback (TFunction< void(TSet< FGuid >)> Callback)=0

Detailed Description

An interface providing basic access to retrieving chunk data.

Constructor & Destructor Documentation

~IChunkSource()

virtual BuildPatchServices::IChunkSource::~IChunkSource ( )

inlinevirtual

Member Function Documentation

AddRepeatRequirement()

virtual bool BuildPatchServices::IChunkSource::AddRepeatRequirement ( const FGuid &  RepeatRequirement )

pure virtual

Adds a requirement to reacquire a chunk that may have already been acquired before by this source. This allows the source implementation to to support forward reading of chunks, and track which it would not need to request.

Parameters

RepeatRequirement

The chunk that needs reacquiring.

Returns

true if the chunk provided can be acquired by this source.

Implemented in BuildPatchServices::FCloudChunkSource.

AddRuntimeRequirements()

virtual TSet< FGuid > BuildPatchServices::IChunkSource::AddRuntimeRequirements ( TSet< FGuid >  NewRequirements )

pure virtual

Adds additional chunk requirements to the source, the implementation will return the resulting set of chunks that could not be accessed via this source.

Parameters

NewRequirements

The set of chunks that are now additionally desired.

Returns

the set of chunks provided which can not be acquired via this chunk.

Implemented in BuildPatchServices::FCloudChunkSource.

Get()

virtual IChunkDataAccess * BuildPatchServices::IChunkSource::Get ( const FGuid &  DataId )

pure virtual

Gets the chunk data for the given id if this source has that chunk.

Parameters

DataId

The id for the chunk.

Returns

pointer to the chunk data. or nullptr if this source does not contain the requested chunk.

Implemented in BuildPatchServices::FCloudChunkSource.

SetUnavailableChunksCallback()

virtual void BuildPatchServices::IChunkSource::SetUnavailableChunksCallback ( TFunction< void(TSet< FGuid >)>  Callback )

pure virtual

Sets a callback to be used when chunks that are being fetched by this source are no longer available.

Parameters

Callback

The function to call with the set of chunks no longer still available.

Implemented in BuildPatchServices::FCloudChunkSource.

---

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

• Engine/Source/Runtime/Online/BuildPatchServices/Private/Installer/ChunkSource.h