FPlatformFileManager Class Reference

#include <PlatformFileManager.h>

Collaboration diagram for FPlatformFileManager:

Public Member Functions
	FPlatformFileManager ()
IPlatformFile &	GetPlatformFile ()
void	SetPlatformFile (IPlatformFile &NewTopmostPlatformFile)
IPlatformFile *	FindPlatformFile (const TCHAR *Name)
IPlatformFile *	GetPlatformFile (const TCHAR *Name)
void	TickActivePlatformFile ()
void	InitializeNewAsyncIO ()
void	RemovePlatformFile (IPlatformFile *PlatformFileToRemove)
bool	InsertPlatformFile (IPlatformFile *NewPlatformFile)

Static Public Member Functions
static FPlatformFileManager &	Get ()

Private Attributes
class IPlatformFile *	TopmostPlatformFile

Detailed Description

Platform File chain manager.

Definition at line 16 of file PlatformFileManager.h.

Constructor & Destructor Documentation

FPlatformFileManager()

FPlatformFileManager::FPlatformFileManager

(

)

Constructor.

Member Function Documentation

FindPlatformFile()

IPlatformFile * FPlatformFileManager::FindPlatformFile

(

const TCHAR *

Name

)

Finds a platform file in the chain of active platform files.

Parameters

Name	of the platform file.

Returns

Pointer to the active platform file or nullptr if the platform file was not found.

Get()

static FPlatformFileManager & FPlatformFileManager::Get ( )

static

Gets FPlatformFileManager Singleton.

Here is the caller graph for this function:

GetPlatformFile() [1/2]

IPlatformFile & FPlatformFileManager::GetPlatformFile

(

)

Gets the currently used platform file.

Returns

Reference to the currently used platform file.

Here is the caller graph for this function:

GetPlatformFile() [2/2]

IPlatformFile * FPlatformFileManager::GetPlatformFile

(

const TCHAR *

Name

)

Creates a new platform file instance.

Parameters

Name	of the platform file to create.

Returns

Platform file instance of the platform file type was found, nullptr otherwise.

InitializeNewAsyncIO()

void FPlatformFileManager::InitializeNewAsyncIO

(

)

Performs additional initialization when the new async IO is enabled.

InsertPlatformFile()

bool FPlatformFileManager::InsertPlatformFile

(

IPlatformFile *

NewPlatformFile

)

Inserts a new platform file into the platform file wrapper chain. The file is inserted before NewPlatformFile->GetLowerLevel().

THIS IS EXTREMELY DANGEROUS AFTER THE ENGINE HAS BEEN INITIALIZED AS WE MAY BE MODIFYING THE WRAPPER CHAIN WHILE THINGS ARE BEING LOADED

Parameters

The	platform file to insert.

Returns

true if the platform file was inserted.

RemovePlatformFile()

void FPlatformFileManager::RemovePlatformFile

(

IPlatformFile *

PlatformFileToRemove

)

Removes the specified file wrapper from the platform file wrapper chain.

THIS IS EXTREMELY DANGEROUS AFTER THE ENGINE HAS BEEN INITIALIZED AS WE MAY BE MODIFYING THE WRAPPER CHAIN WHILE THINGS ARE BEING LOADED

Parameters

The	platform file to remove.

SetPlatformFile()

void FPlatformFileManager::SetPlatformFile

(

IPlatformFile &

NewTopmostPlatformFile

)

Sets the current platform file.

Parameters

NewTopmostPlatformFile

Platform file to be used.

TickActivePlatformFile()

void FPlatformFileManager::TickActivePlatformFile

(

)

calls Tick on the platform files in the TopmostPlatformFile chain

Member Data Documentation

TopmostPlatformFile

class IPlatformFile* FPlatformFileManager::TopmostPlatformFile

private

Currently used platform file.

Definition at line 23 of file PlatformFileManager.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/PlatformFileManager.h