FPlatformFileManager Class Reference

#include <PlatformFileManager.h>

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

Static Public Member Functions
static CORE_API FPlatformFileManager &	Get ()

Detailed Description

Platform File chain manager.

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()

FPlatformFileManager & FPlatformFileManager::Get ( )

static

Gets FPlatformFileManager Singleton.

GetPlatformFile() [1/2]

IPlatformFile & FPlatformFileManager::GetPlatformFile

(

)

Gets the currently used platform file.

Returns

Reference to the currently used platform file.

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.

GetPlatformPhysical()

CORE_API IPlatformFile & FPlatformFileManager::GetPlatformPhysical

(

)

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.

SetPlatformPhysical()

void FPlatformFileManager::SetPlatformPhysical

(

IPlatformFile &

NewPhysicalPlatformFile

)

TickActivePlatformFile()

void FPlatformFileManager::TickActivePlatformFile

(

)

calls Tick on the platform files in the TopmostPlatformFile chain

---

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

• Engine/Source/Runtime/Core/Public/HAL/PlatformFileManager.h
• Engine/Source/Runtime/Core/Private/HAL/PlatformFileManager.cpp