Inheritance diagram for Experimental::FGenericIndexedCacheStorage:

Public Member Functions
virtual bool	SupportsIndexedCacheStorage () override

virtual uint32	GetNumIndexedCacheStorages () override

virtual bool	CreateCacheStorage (uint64 InRequestNumberOfBytes, int32 CacheStorageIndex) override

virtual bool	DestroyCacheStorage (int32 InCacheStorageIndex) override

virtual void	EnumerateCacheStorages (TArray< int32 > &OutCacheStorageIndices) override

virtual void	GetCacheStorageInfo (int32 InCacheStorageIndex, uint64 &OutCacheStorageDataSize, uint64 &OutCacheStorageJournalSize) override

virtual void	GetCacheStorageMountPath (FString &OutPlatformMountPath, const FString &InMountName) override

virtual bool	MountCacheStorage (FString &OutPlatformMountPath, int32 InCacheStorageIndex, const FString &InMountName) override

virtual void	UnmountCacheStorage (const FString &InMountName) override

virtual uint64	GetPersistentDownloadDirEarlyStartupSize () override

virtual uint64	GetCacheStorageJournalSize (uint64 CacheDataSize, uint32 CacheIndex) override

Additional Inherited Members
Static Public Member Functions inherited from Experimental::IIndexedCacheStorage
static IIndexedCacheStorage &	Get ()

static IIndexedCacheStorage &	GetOrCreateIndexedCacheStorage ()

Detailed Description

Generic implementation of IIndexedCacheStorage

Member Function Documentation

◆ CreateCacheStorage()

virtual bool Experimental::FGenericIndexedCacheStorage::CreateCacheStorage	(	uint64	InRequestNumberOfBytes,
		int32	CacheStorageIndex
	)

inlineoverridevirtual

Requests a new indexed cache entry, capable of holding up to RequestNumberOfBytes.

Parameters

InRequestNumberOfBytes	number of bytes this entry needs to hold
CacheStorageIndex	- the index of the entry to create

Returns: True on success, otherwise false

Implements Experimental::IIndexedCacheStorage.

◆ DestroyCacheStorage()

virtual bool Experimental::FGenericIndexedCacheStorage::DestroyCacheStorage ( int32 InCacheStorageIndex )

inlineoverridevirtual

Destroy an indexed cache entry.

Parameters

InCacheStorageIndex - the index of the entry

Returns: True on success, otherwise false

Implements Experimental::IIndexedCacheStorage.

◆ EnumerateCacheStorages()

virtual void Experimental::FGenericIndexedCacheStorage::EnumerateCacheStorages ( TArray< int32 > & OutCacheStorageIndices )

inlineoverridevirtual

Enumerate existing cache entries.

Parameters

OutCacheStorageIndices - indices of existing cache storages

Implements Experimental::IIndexedCacheStorage.

◆ GetCacheStorageInfo()

virtual void Experimental::FGenericIndexedCacheStorage::GetCacheStorageInfo	(	int32	InCacheStorageIndex,
		uint64 &	OutCacheStorageDataSize,
		uint64 &	OutCacheStorageJournalSize
	)

inlineoverridevirtual

Queries cache storage.

Parameters

InCacheStorageIndex	- the index of the cache
OutCacheStorageSize	- How large the cache storage is

Implements Experimental::IIndexedCacheStorage.

◆ GetCacheStorageJournalSize()

virtual uint64 Experimental::FGenericIndexedCacheStorage::GetCacheStorageJournalSize	(	uint64	CacheDataSize,
		uint32	CacheIndex
	)

inlineoverridevirtual

Implements Experimental::IIndexedCacheStorage.

◆ GetCacheStorageMountPath()

virtual void Experimental::FGenericIndexedCacheStorage::GetCacheStorageMountPath	(	FString &	OutPlatformMountPath,
		const FString &	InMountName
	)

inlineoverridevirtual

Gets the platform mount path for a cached storage based on its generic Name

Parameters

OutPlatformMountPath	- the platform specific mount path
InMountName	- the generic mount name

Implements Experimental::IIndexedCacheStorage.

◆ GetNumIndexedCacheStorages()

virtual uint32 Experimental::FGenericIndexedCacheStorage::GetNumIndexedCacheStorages ( )

inlineoverridevirtual

Retrieve the number of indexed cache entries available on the platform.

Returns: number of indexed cache entries available on the platform.

Implements Experimental::IIndexedCacheStorage.

◆ GetPersistentDownloadDirEarlyStartupSize()

virtual uint64 Experimental::FGenericIndexedCacheStorage::GetPersistentDownloadDirEarlyStartupSize ( )

inlineoverridevirtual

Implements Experimental::IIndexedCacheStorage.

◆ MountCacheStorage()

virtual bool Experimental::FGenericIndexedCacheStorage::MountCacheStorage	(	FString &	OutPlatformMountPath,
		int32	InCacheStorageIndex,
		const FString &	InMountName
	)

inlineoverridevirtual

Mounts a cache storage so file operations can be done

Parameters

OutPlatformMountPath	- the platform specific mount path. Same name as the one returned by GetCacheStorageMountPath
InCacheStorageIndex	- the index of the cache
InMountName	- the generic mount name

Implements Experimental::IIndexedCacheStorage.

◆ SupportsIndexedCacheStorage()

virtual bool Experimental::FGenericIndexedCacheStorage::SupportsIndexedCacheStorage ( )

inlineoverridevirtual

Check if indexed cache storage is available on the current platform.

Returns: True is available, false otherwise.

Implements Experimental::IIndexedCacheStorage.

◆ UnmountCacheStorage()

virtual void Experimental::FGenericIndexedCacheStorage::UnmountCacheStorage ( const FString & InMountName )

inlineoverridevirtual

Unmounts a cache storage

Parameters

InMountName - the generic mount name

Implements Experimental::IIndexedCacheStorage.

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

Engine/Source/Runtime/Experimental/IndexedCacheStorage/Private/IndexedCacheStorage.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateCacheStorage()

◆ DestroyCacheStorage()

◆ EnumerateCacheStorages()

◆ GetCacheStorageInfo()

◆ GetCacheStorageJournalSize()

◆ GetCacheStorageMountPath()

◆ GetNumIndexedCacheStorages()

◆ GetPersistentDownloadDirEarlyStartupSize()

◆ MountCacheStorage()

◆ SupportsIndexedCacheStorage()

◆ UnmountCacheStorage()