FPersistentStorageManager Class Reference

#include <IPlatformFileManagedStorageWrapper.h>

Collaboration diagram for FPersistentStorageManager:

Classes
struct	FCategoryInfo
struct	FRootDirInfo

Public Member Functions
	FPersistentStorageManager ()
void	Initialize ()
FPersistentManagedFile	TryManageFile (const FString &Filename)
FPersistentManagedFile	TryManageFile (FString &&Filename)
EPersistentStorageManagerFileSizeFlags	AddOrUpdateFile (const FPersistentManagedFile &File, const int64 FileSize, EPersistentStorageManagerFileSizeFlags Flags=EPersistentStorageManagerFileSizeFlags::None)
bool	RemoveFileFromManager (FPersistentManagedFile &File)
int64	GetTotalUsedSize () const
bool	GetPersistentStorageUsage (FString Path, int64 &UsedSpace, int64 &RemainingSpace, int64 &Quota, int64 *OptionalQuota=nullptr)
bool	GetPersistentStorageUsageByCategory (const FString &InCategory, int64 &UsedSpace, int64 &RemainingSpace, int64 &Quota, int64 *OptionalQuota=nullptr)
bool	GetPersistentStorageSize (int64 &UsedSpace, int64 &RequiredSpace, int64 &OptionalSpace) const
	Returns any additional required free space and optional free space.
bool	IsInitialized () const
bool	IsCategoryForFileFull (const FPersistentManagedFile &File) const
TMap< FString, FPersistentStorageCategory::CategoryStat >	GenerateCategoryStats () const
TOptional< FPersistentStorageCategory::CategoryStat >	GetCategoryStat (const FString &InCategory) const
TArrayView< const FString >	GetRootDirectories () const

Static Public Member Functions
static bool	IsReady ()
static FPersistentStorageManager &	Get ()

Private Member Functions
void	TryManageFileInternal (FPersistentManagedFile &OutFile)

Static Private Member Functions
static FCategoryInfo	InitCategories ()

Private Attributes
bool	bInitialized
FRootDirInfo	RootDirectories
FCategoryInfo	Categories

Friends
class	FManagedStorageScopeFileLock

Detailed Description

Definition at line 352 of file IPlatformFileManagedStorageWrapper.h.

Constructor & Destructor Documentation

FPersistentStorageManager()

FPersistentStorageManager::FPersistentStorageManager

(

)

Member Function Documentation

AddOrUpdateFile()

EPersistentStorageManagerFileSizeFlags FPersistentStorageManager::AddOrUpdateFile ( const FPersistentManagedFile & File, const int64 FileSize, EPersistentStorageManagerFileSizeFlags Flags = EPersistentStorageManagerFileSizeFlags::None )

inline

Definition at line 473 of file IPlatformFileManagedStorageWrapper.h.

GenerateCategoryStats()

TMap< FString, FPersistentStorageCategory::CategoryStat > FPersistentStorageManager::GenerateCategoryStats ( ) const

inline

Definition at line 585 of file IPlatformFileManagedStorageWrapper.h.

Get()

static FPersistentStorageManager & FPersistentStorageManager::Get ( )

static

Singleton access

Here is the caller graph for this function:

GetCategoryStat()

TOptional< FPersistentStorageCategory::CategoryStat > FPersistentStorageManager::GetCategoryStat ( const FString & InCategory ) const

inline

Definition at line 598 of file IPlatformFileManagedStorageWrapper.h.

GetPersistentStorageSize()

bool FPersistentStorageManager::GetPersistentStorageSize ( int64 & UsedSpace, int64 & RequiredSpace, int64 & OptionalSpace ) const

inline

Returns any additional required free space and optional free space.

Parameters

RequiredSpace	Required persistent storage space to run
OptionalSpace	persistent storage categories marked as optional

Returns

Definition at line 559 of file IPlatformFileManagedStorageWrapper.h.

GetPersistentStorageUsage()

bool FPersistentStorageManager::GetPersistentStorageUsage ( FString Path, int64 & UsedSpace, int64 & RemainingSpace, int64 & Quota, int64 * OptionalQuota = nullptr )

inline

Parameters

Path	path to check for free space
UsedSpace	amount of used space
RemainingSpace	amount of remaining free space
Quota	total storage allocated to the related category
OptionalQuota	subset of the storage which is optional i.e. will always be smaller then total Quota

Returns

returns if function succeeds

Definition at line 515 of file IPlatformFileManagedStorageWrapper.h.

GetPersistentStorageUsageByCategory()

bool FPersistentStorageManager::GetPersistentStorageUsageByCategory ( const FString & InCategory, int64 & UsedSpace, int64 & RemainingSpace, int64 & Quota, int64 * OptionalQuota = nullptr )

inline

Definition at line 536 of file IPlatformFileManagedStorageWrapper.h.

Here is the call graph for this function:

GetRootDirectories()

TArrayView< const FString > FPersistentStorageManager::GetRootDirectories ( ) const

inline

Definition at line 614 of file IPlatformFileManagedStorageWrapper.h.

GetTotalUsedSize()

int64 FPersistentStorageManager::GetTotalUsedSize ( ) const

inline

Definition at line 495 of file IPlatformFileManagedStorageWrapper.h.

InitCategories()

static FCategoryInfo FPersistentStorageManager::InitCategories ( )

staticprivate

Initialize()

void FPersistentStorageManager::Initialize ( )

inline

Definition at line 369 of file IPlatformFileManagedStorageWrapper.h.

IsCategoryForFileFull()

bool FPersistentStorageManager::IsCategoryForFileFull ( const FPersistentManagedFile & File ) const

inline

Definition at line 575 of file IPlatformFileManagedStorageWrapper.h.

IsInitialized()

bool FPersistentStorageManager::IsInitialized ( ) const

inline

Definition at line 570 of file IPlatformFileManagedStorageWrapper.h.

IsReady()

static bool FPersistentStorageManager::IsReady ( )

inlinestatic

Definition at line 355 of file IPlatformFileManagedStorageWrapper.h.

Here is the call graph for this function:

Here is the caller graph for this function:

RemoveFileFromManager()

bool FPersistentStorageManager::RemoveFileFromManager ( FPersistentManagedFile & File )

inline

Definition at line 484 of file IPlatformFileManagedStorageWrapper.h.

Here is the call graph for this function:

TryManageFile() [1/2]

FPersistentManagedFile FPersistentStorageManager::TryManageFile ( const FString & Filename )

inline

Definition at line 431 of file IPlatformFileManagedStorageWrapper.h.

Here is the call graph for this function:

TryManageFile() [2/2]

FPersistentManagedFile FPersistentStorageManager::TryManageFile ( FString && Filename )

inline

Definition at line 441 of file IPlatformFileManagedStorageWrapper.h.

Here is the call graph for this function:

TryManageFileInternal()

void FPersistentStorageManager::TryManageFileInternal ( FPersistentManagedFile & OutFile )

inlineprivate

Definition at line 452 of file IPlatformFileManagedStorageWrapper.h.

Here is the caller graph for this function:

Friends And Related Symbol Documentation

FManagedStorageScopeFileLock

friend class FManagedStorageScopeFileLock

friend

Definition at line 617 of file IPlatformFileManagedStorageWrapper.h.

Member Data Documentation

bInitialized

bool FPersistentStorageManager::bInitialized

private

Definition at line 619 of file IPlatformFileManagedStorageWrapper.h.

Categories

FCategoryInfo FPersistentStorageManager::Categories

private

Definition at line 652 of file IPlatformFileManagedStorageWrapper.h.

RootDirectories

FRootDirInfo FPersistentStorageManager::RootDirectories

private

Definition at line 632 of file IPlatformFileManagedStorageWrapper.h.

---

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

• C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/HAL/IPlatformFileManagedStorageWrapper.h