Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
Classes | Public Member Functions | Private Member Functions | Private Attributes | List of all members
FPersistentStorageCategory Struct Reference

#include <IPlatformFileManagedStorageWrapper.h>

+ Collaboration diagram for FPersistentStorageCategory:

Classes

struct  CategoryStat
 

Public Member Functions

 FPersistentStorageCategory (FString InCategoryName, TArray< FString > InDirectories, const int64 InQuota, const int64 InOptionalQuota)
 
const FString & GetCategoryName () const
 
int64 GetCategoryQuota (bool bIncludeOptional=true) const
 
int64 GetCategoryOptionalQuota () const
 
int64 GetUsedSize () const
 
int64 GetAvailableSize (bool bIncludeOptionalStorage=true) const
 
bool IsInCategory (const FString &Path) const
 
bool IsCategoryFull () const
 
EPersistentStorageManagerFileSizeFlags AddOrUpdateFile (const FString &Filename, const int64 FileSize, EPersistentStorageManagerFileSizeFlags Flags)
 
bool RemoveFile (const FString &Filename)
 
const TArray< FString > & GetDirectories () const
 
CategoryStat GetStat () const
 
FManagedStorageFileLockRegistry & GetLockRegistry ()
 

Private Member Functions

EPersistentStorageManagerFileSizeFlags TryUpdateQuota (const int64 OldFileSize, const int64 NewFileSize, EPersistentStorageManagerFileSizeFlags Flags)
 
bool ShouldManageFile (const FString &Filename) const
 

Private Attributes

const FString CategoryName
 
const TArray< FString > Directories
 
const int64 StorageQuota = -1
 
const int64 OptionalStorageQuota = 0
 
std::atomic< int64 > UsedQuota { 0 }
 
TMap< FString, int64 > FileSizes
 
FRWLock FileSizesLock
 
FManagedStorageFileLockRegistry FileLockRegistry
 

Detailed Description

Definition at line 141 of file IPlatformFileManagedStorageWrapper.h.

Constructor & Destructor Documentation

◆ FPersistentStorageCategory()

FPersistentStorageCategory::FPersistentStorageCategory ( FString InCategoryName,
TArray< FString > InDirectories,
const int64 InQuota,
const int64 InOptionalQuota )
inline

Definition at line 144 of file IPlatformFileManagedStorageWrapper.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Function Documentation

◆ AddOrUpdateFile()

EPersistentStorageManagerFileSizeFlags FPersistentStorageCategory::AddOrUpdateFile ( const FString & Filename,
const int64 FileSize,
EPersistentStorageManagerFileSizeFlags Flags )
inline

Definition at line 207 of file IPlatformFileManagedStorageWrapper.h.

+ Here is the call graph for this function:

◆ GetAvailableSize()

int64 FPersistentStorageCategory::GetAvailableSize ( bool bIncludeOptionalStorage = true) const
inline

Definition at line 180 of file IPlatformFileManagedStorageWrapper.h.

+ Here is the caller graph for this function:

◆ GetCategoryName()

const FString & FPersistentStorageCategory::GetCategoryName ( ) const
inline

Definition at line 153 of file IPlatformFileManagedStorageWrapper.h.

◆ GetCategoryOptionalQuota()

int64 FPersistentStorageCategory::GetCategoryOptionalQuota ( ) const
inline

Definition at line 170 of file IPlatformFileManagedStorageWrapper.h.

+ Here is the caller graph for this function:

◆ GetCategoryQuota()

int64 FPersistentStorageCategory::GetCategoryQuota ( bool bIncludeOptional = true) const
inline

Definition at line 158 of file IPlatformFileManagedStorageWrapper.h.

+ Here is the caller graph for this function:

◆ GetDirectories()

const TArray< FString > & FPersistentStorageCategory::GetDirectories ( ) const
inline

Definition at line 253 of file IPlatformFileManagedStorageWrapper.h.

◆ GetLockRegistry()

FManagedStorageFileLockRegistry & FPersistentStorageCategory::GetLockRegistry ( )
inline

Definition at line 283 of file IPlatformFileManagedStorageWrapper.h.

◆ GetStat()

CategoryStat FPersistentStorageCategory::GetStat ( ) const
inline

Definition at line 277 of file IPlatformFileManagedStorageWrapper.h.

+ Here is the call graph for this function:

◆ GetUsedSize()

int64 FPersistentStorageCategory::GetUsedSize ( ) const
inline

Definition at line 175 of file IPlatformFileManagedStorageWrapper.h.

+ Here is the caller graph for this function:

◆ IsCategoryFull()

bool FPersistentStorageCategory::IsCategoryFull ( ) const
inline

Definition at line 202 of file IPlatformFileManagedStorageWrapper.h.

+ Here is the call graph for this function:

◆ IsInCategory()

bool FPersistentStorageCategory::IsInCategory ( const FString & Path) const
inline

Definition at line 197 of file IPlatformFileManagedStorageWrapper.h.

+ Here is the call graph for this function:

◆ RemoveFile()

bool FPersistentStorageCategory::RemoveFile ( const FString & Filename)
inline

Definition at line 233 of file IPlatformFileManagedStorageWrapper.h.

+ Here is the call graph for this function:

◆ ShouldManageFile()

bool FPersistentStorageCategory::ShouldManageFile ( const FString & Filename) const
inlineprivate

Definition at line 322 of file IPlatformFileManagedStorageWrapper.h.

+ Here is the caller graph for this function:

◆ TryUpdateQuota()

EPersistentStorageManagerFileSizeFlags FPersistentStorageCategory::TryUpdateQuota ( const int64 OldFileSize,
const int64 NewFileSize,
EPersistentStorageManagerFileSizeFlags Flags )
inlineprivate

Definition at line 286 of file IPlatformFileManagedStorageWrapper.h.

+ Here is the caller graph for this function:

Member Data Documentation

◆ CategoryName

const FString FPersistentStorageCategory::CategoryName
private

Definition at line 336 of file IPlatformFileManagedStorageWrapper.h.

◆ Directories

const TArray<FString> FPersistentStorageCategory::Directories
private

Definition at line 337 of file IPlatformFileManagedStorageWrapper.h.

◆ FileLockRegistry

FManagedStorageFileLockRegistry FPersistentStorageCategory::FileLockRegistry
private

Definition at line 347 of file IPlatformFileManagedStorageWrapper.h.

◆ FileSizes

TMap<FString, int64> FPersistentStorageCategory::FileSizes
private

Definition at line 344 of file IPlatformFileManagedStorageWrapper.h.

◆ FileSizesLock

FRWLock FPersistentStorageCategory::FileSizesLock
mutableprivate

Definition at line 345 of file IPlatformFileManagedStorageWrapper.h.

◆ OptionalStorageQuota

const int64 FPersistentStorageCategory::OptionalStorageQuota = 0
private

Definition at line 340 of file IPlatformFileManagedStorageWrapper.h.

◆ StorageQuota

const int64 FPersistentStorageCategory::StorageQuota = -1
private

Definition at line 339 of file IPlatformFileManagedStorageWrapper.h.

◆ UsedQuota

std::atomic<int64> FPersistentStorageCategory::UsedQuota { 0 }
private

Definition at line 342 of file IPlatformFileManagedStorageWrapper.h.

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