UE::IoStore::IOnDemandIoStore Class Reference

#include <IoStoreOnDemand.h>

Inheritance diagram for UE::IoStore::IOnDemandIoStore:

Public Member Functions
virtual	~IOnDemandIoStore ()=default
virtual FIoStatus	InitializePostHotfix ()=0
virtual FOnDemandRegisterHostGroupResult	RegisterHostGroup (FOnDemandRegisterHostGroupArgs &&Args)=0
virtual void	Mount (FOnDemandMountArgs &&Args, FOnDemandMountCompleted &&OnCompleted)=0
virtual FIoStatus	Unmount (FStringView MountId)=0
virtual FOnDemandInstallRequest	Install (FOnDemandInstallArgs &&Args, FOnDemandInstallCompleted &&OnCompleted, FOnDemandInstallProgressed &&OnProgress=nullptr)=0
virtual void	Purge (FOnDemandPurgeArgs &&Args, FOnDemandPurgeCompleted &&OnCompleted)=0
virtual void	Defrag (FOnDemandDefragArgs &&Args, FOnDemandDefragCompleted &&OnCompleted)=0
virtual void	Verify (FOnDemandVerifyCacheCompleted &&OnCompleted)=0
virtual TIoStatusOr< FOnDemandInstallSizeResult >	GetInstallSize (const FOnDemandGetInstallSizeArgs &Args) const =0
virtual FIoStatus	GetInstallSizesByMountId (const FOnDemandGetInstallSizeArgs &Args, TMap< FString, uint64 > &OutSizesByMountId) const =0
virtual FOnDemandCacheUsage	GetCacheUsage (const FOnDemandGetCacheUsageArgs &Args) const =0
virtual void	DumpMountedContainersToLog () const =0
virtual bool	IsOnDemandStreamingEnabled () const =0
virtual void	SetStreamingOptions (EOnDemandStreamingOptions Options)=0
virtual void	ReportAnalytics (TArray< FAnalyticsEventAttribute > &OutAnalyticsArray) const =0
virtual TUniquePtr< IAnalyticsRecording >	StartAnalyticsRecording () const =0
virtual void	OnImmediateAnalytic (FOnDemandImmediateAnalyticHandler EventHandler)=0

Friends
class	FIoStoreOnDemandCoreModule
class	FOnDemandInternalContentHandle
class	FOnDemandInstallRequest

Detailed Description

Interface for installing and streaming content on-demand.

Constructor & Destructor Documentation

~IOnDemandIoStore()

virtual UE::IoStore::IOnDemandIoStore::~IOnDemandIoStore ( )

virtualdefault

Destroy the I/O store.

Member Function Documentation

Defrag()

virtual void UE::IoStore::IOnDemandIoStore::Defrag ( FOnDemandDefragArgs &&  Args, FOnDemandDefragCompleted &&  OnCompleted  )

pure virtual

Defrag the cache.

Parameters

Args	The defrag arguments.
OnComplete	Completion callback.

Implemented in UE::IoStore::FOnDemandIoStore.

DumpMountedContainersToLog()

virtual void UE::IoStore::IOnDemandIoStore::DumpMountedContainersToLog ( ) const

pure virtual

Dump information about mounted containers to the log

Implemented in UE::IoStore::FOnDemandIoStore.

GetCacheUsage()

virtual FOnDemandCacheUsage UE::IoStore::IOnDemandIoStore::GetCacheUsage ( const FOnDemandGetCacheUsageArgs &  Args ) const

pure virtual

Returns the total cache size in bytes.

Implemented in UE::IoStore::FOnDemandIoStore.

GetInstallSize()

virtual TIoStatusOr< FOnDemandInstallSizeResult > UE::IoStore::IOnDemandIoStore::GetInstallSize ( const FOnDemandGetInstallSizeArgs &  Args ) const

pure virtual

Get the total space in bytes needed to install the specified content.

Parameters

Args	Arguments for computing required install size.

Implemented in UE::IoStore::FOnDemandIoStore.

GetInstallSizesByMountId()

virtual FIoStatus UE::IoStore::IOnDemandIoStore::GetInstallSizesByMountId ( const FOnDemandGetInstallSizeArgs &  Args, TMap< FString, uint64 > &  OutSizesByMountId  ) const

pure virtual

Get the total space in bytes needed to install the specified content.

Parameters

Args	Arguments for computing required install size.

Returns

The total size by mount ID.

Implemented in UE::IoStore::FOnDemandIoStore.

InitializePostHotfix()

virtual FIoStatus UE::IoStore::IOnDemandIoStore::InitializePostHotfix ( )

pure virtual

Initialize the I/O store. Called after the module feature has been registered.

Implemented in UE::IoStore::FOnDemandIoStore.

Install()

virtual FOnDemandInstallRequest UE::IoStore::IOnDemandIoStore::Install ( FOnDemandInstallArgs &&  Args, FOnDemandInstallCompleted &&  OnCompleted, FOnDemandInstallProgressed &&  OnProgress = nullptr  )

pure virtual

Install content.

Parameters

Args	The install arguments.
OnCompleted	Completion callback.
OnProgress	Optional progress callback.
CancellationToken	Optional cancellation token.

Implemented in UE::IoStore::FOnDemandIoStore.

IsOnDemandStreamingEnabled()

virtual bool UE::IoStore::IOnDemandIoStore::IsOnDemandStreamingEnabled ( ) const

pure virtual

Return if the OnDemand streaming system is enabled.

Implemented in UE::IoStore::FOnDemandIoStore.

Mount()

virtual void UE::IoStore::IOnDemandIoStore::Mount ( FOnDemandMountArgs &&  Args, FOnDemandMountCompleted &&  OnCompleted  )

pure virtual

Mount an on-demand container.

Parameters

Args	Mount arguments.
OnCompleted	Completion callback.

Implemented in UE::IoStore::FOnDemandIoStore.

OnImmediateAnalytic()

virtual void UE::IoStore::IOnDemandIoStore::OnImmediateAnalytic ( FOnDemandImmediateAnalyticHandler  EventHandler )

pure virtual

Report immediate analytics events that are not recorded over a timespan. Useful for analytics that are better reported as single events.

Implemented in UE::IoStore::FOnDemandIoStore.

Purge()

virtual void UE::IoStore::IOnDemandIoStore::Purge ( FOnDemandPurgeArgs &&  Args, FOnDemandPurgeCompleted &&  OnCompleted  )

pure virtual

Purge the cache.

Parameters

Args	The purge arguments.
OnComplete	Completion callback.

Implemented in UE::IoStore::FOnDemandIoStore.

RegisterHostGroup()

virtual FOnDemandRegisterHostGroupResult UE::IoStore::IOnDemandIoStore::RegisterHostGroup ( FOnDemandRegisterHostGroupArgs &&  Args )

pure virtual

Register a new host group.

Parameters

Args	Request arguments.

Returns

Error information about the request.

Implemented in UE::IoStore::FOnDemandIoStore.

ReportAnalytics()

virtual void UE::IoStore::IOnDemandIoStore::ReportAnalytics ( TArray< FAnalyticsEventAttribute > &  OutAnalyticsArray ) const

pure virtual

Reports the statistics for the current OnDemandBackend. It will record any events that have occurred from the last time that this was called. This is a legacy method, prefer using StartAnalyticsRecording instead.

Implemented in UE::IoStore::FOnDemandIoStore.

SetStreamingOptions()

virtual void UE::IoStore::IOnDemandIoStore::SetStreamingOptions ( EOnDemandStreamingOptions  Options )

pure virtual

Set streaming options.

Implemented in UE::IoStore::FOnDemandIoStore.

StartAnalyticsRecording()

virtual TUniquePtr< IAnalyticsRecording > UE::IoStore::IOnDemandIoStore::StartAnalyticsRecording ( ) const

pure virtual

Create a new analytics interface for the current OnDemandBackend, can be used to record statistics for a set period of time. This can return a nullptr if the analytics system is not enabled.

Implemented in UE::IoStore::FOnDemandIoStore.

Unmount()

virtual FIoStatus UE::IoStore::IOnDemandIoStore::Unmount ( FStringView  MountId )

pure virtual

Unmount all container(s) associated with the specified mount ID.

Parameters

MountId

The Mount ID passed to the mount call.

Implemented in UE::IoStore::FOnDemandIoStore.

Verify()

virtual void UE::IoStore::IOnDemandIoStore::Verify ( FOnDemandVerifyCacheCompleted &&  OnCompleted )

pure virtual

Verify the install cache.

Parameters

OnComplete

Completion callback.

Implemented in UE::IoStore::FOnDemandIoStore.

Friends And Related Symbol Documentation

FIoStoreOnDemandCoreModule

friend class FIoStoreOnDemandCoreModule

friend

FOnDemandInstallRequest

friend class FOnDemandInstallRequest

friend

FOnDemandInternalContentHandle

friend class FOnDemandInternalContentHandle

friend

---

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

• Engine/Source/Runtime/Experimental/IoStore/OnDemandCore/Public/IO/IoStoreOnDemand.h