BuildPatchServices::FCloudChunkSource Class Reference

Inheritance diagram for BuildPatchServices::FCloudChunkSource:

Public Member Functions
	FCloudChunkSource (FCloudSourceConfig InConfiguration, IPlatform *Platform, IChunkStore *InChunkStore, IDownloadService *InDownloadService, IChunkReferenceTracker *InChunkReferenceTracker, IChunkDataSerialization *InChunkDataSerialization, IMessagePump *InMessagePump, IInstallerError *InInstallerError, IDownloadConnectionCount *InDownloadConnectionCount, ICloudChunkSourceStat *InCloudChunkSourceStat, IBuildManifestSet *ManifestSet, TSet< FGuid > InInitialDownloadSet)
	~FCloudChunkSource ()
virtual void	SetPaused (bool bInIsPaused) override
virtual void	Abort () override
virtual IChunkDataAccess *	Get (const FGuid &DataId) override
virtual TSet< FGuid >	AddRuntimeRequirements (TSet< FGuid > NewRequirements) override
virtual bool	AddRepeatRequirement (const FGuid &RepeatRequirement) override
virtual void	SetUnavailableChunksCallback (TFunction< void(TSet< FGuid >)> Callback) override
virtual void	ThreadRun () override
Public Member Functions inherited from BuildPatchServices::ICloudChunkSource
virtual	~ICloudChunkSource ()
Public Member Functions inherited from BuildPatchServices::IChunkSource
virtual	~IChunkSource ()
Public Member Functions inherited from BuildPatchServices::IControllable
virtual	~IControllable ()

Detailed Description

The concrete implementation of ICloudChunkSource

Constructor & Destructor Documentation

FCloudChunkSource()

BuildPatchServices::FCloudChunkSource::FCloudChunkSource	(	FCloudSourceConfig	InConfiguration,
		IPlatform *	Platform,
		IChunkStore *	InChunkStore,
		IDownloadService *	InDownloadService,
		IChunkReferenceTracker *	InChunkReferenceTracker,
		IChunkDataSerialization *	InChunkDataSerialization,
		IMessagePump *	InMessagePump,
		IInstallerError *	InInstallerError,
		IDownloadConnectionCount *	InDownloadConnectionCount,
		ICloudChunkSourceStat *	InCloudChunkSourceStat,
		IBuildManifestSet *	ManifestSet,
		TSet< FGuid >	InInitialDownloadSet
	)

~FCloudChunkSource()

BuildPatchServices::FCloudChunkSource::~FCloudChunkSource

(

)

Member Function Documentation

Abort()

void BuildPatchServices::FCloudChunkSource::Abort ( )

overridevirtual

Called to instruct the class to cease all activity, and perform any shutdown.

Implements BuildPatchServices::IControllable.

AddRepeatRequirement()

bool BuildPatchServices::FCloudChunkSource::AddRepeatRequirement ( const FGuid &  RepeatRequirement )

overridevirtual

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.

Implements BuildPatchServices::IChunkSource.

AddRuntimeRequirements()

TSet< FGuid > BuildPatchServices::FCloudChunkSource::AddRuntimeRequirements ( TSet< FGuid >  NewRequirements )

overridevirtual

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.

Implements BuildPatchServices::IChunkSource.

Get()

IChunkDataAccess * BuildPatchServices::FCloudChunkSource::Get ( const FGuid &  DataId )

overridevirtual

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.

Implements BuildPatchServices::IChunkSource.

SetPaused()

void BuildPatchServices::FCloudChunkSource::SetPaused ( bool  bIsPaused )

overridevirtual

Sets whether the class should pause current activities and wait.

Parameters

bIsPaused

True if the class should pause.

Implements BuildPatchServices::IControllable.

SetUnavailableChunksCallback()

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

overridevirtual

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.

Implements BuildPatchServices::IChunkSource.

ThreadRun()

void BuildPatchServices::FCloudChunkSource::ThreadRun ( )

overridevirtual

Should be called from the desired thread if bRunOwnThread is false. It will block until until aborted by the owning system.

Implements BuildPatchServices::ICloudChunkSource.

---

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

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