#include <IPlatformFileCachedWrapper.h>

Inheritance diagram for FCachedReadPlatformFile:

Collaboration diagram for FCachedReadPlatformFile:

Public Member Functions
	FCachedReadPlatformFile ()

virtual bool	Initialize (IPlatformFile Inner, const TCHAR CommandLineParam) override

virtual bool	ShouldBeUsed (IPlatformFile Inner, const TCHAR CmdLine) const override

IPlatformFile *	GetLowerLevel () override

virtual void	SetLowerLevel (IPlatformFile *NewLowerLevel) override

virtual const TCHAR *	GetName () const override

virtual bool	FileExists (const TCHAR *Filename) override

virtual int64	FileSize (const TCHAR *Filename) override

virtual bool	DeleteFile (const TCHAR *Filename) override

virtual bool	IsReadOnly (const TCHAR *Filename) override

virtual bool	MoveFile (const TCHAR To, const TCHAR From) override

virtual bool	SetReadOnly (const TCHAR *Filename, bool bNewReadOnlyValue) override

virtual FDateTime	GetTimeStamp (const TCHAR *Filename) override

virtual void	SetTimeStamp (const TCHAR *Filename, FDateTime DateTime) override

virtual FDateTime	GetAccessTimeStamp (const TCHAR *Filename) override

virtual FString	GetFilenameOnDisk (const TCHAR *Filename) override

virtual IFileHandle *	OpenRead (const TCHAR *Filename, bool bAllowWrite) override

virtual IFileHandle *	OpenWrite (const TCHAR *Filename, bool bAppend=false, bool bAllowRead=false) override

virtual bool	DirectoryExists (const TCHAR *Directory) override

virtual bool	CreateDirectory (const TCHAR *Directory) override

virtual bool	DeleteDirectory (const TCHAR *Directory) override

virtual FFileStatData	GetStatData (const TCHAR *FilenameOrDirectory) override

virtual bool	IterateDirectory (const TCHAR *Directory, IPlatformFile::FDirectoryVisitor &Visitor) override

virtual bool	IterateDirectoryRecursively (const TCHAR *Directory, IPlatformFile::FDirectoryVisitor &Visitor) override

virtual bool	IterateDirectoryStat (const TCHAR *Directory, IPlatformFile::FDirectoryStatVisitor &Visitor) override

virtual bool	IterateDirectoryStatRecursively (const TCHAR *Directory, IPlatformFile::FDirectoryStatVisitor &Visitor) override

virtual void	FindFiles (TArray< FString > &FoundFiles, const TCHAR Directory, const TCHAR FileExtension)

virtual void	FindFilesRecursively (TArray< FString > &FoundFiles, const TCHAR Directory, const TCHAR FileExtension)

virtual bool	DeleteDirectoryRecursively (const TCHAR *Directory) override

virtual bool	CopyFile (const TCHAR To, const TCHAR From, EPlatformFileRead ReadFlags=EPlatformFileRead::None, EPlatformFileWrite WriteFlags=EPlatformFileWrite::None) override

virtual bool	CreateDirectoryTree (const TCHAR *Directory) override

virtual bool	CopyDirectoryTree (const TCHAR DestinationDirectory, const TCHAR Source, bool bOverwriteAllExisting) override

virtual FString	ConvertToAbsolutePathForExternalAppForRead (const TCHAR *Filename) override

virtual FString	ConvertToAbsolutePathForExternalAppForWrite (const TCHAR *Filename) override

virtual bool	SendMessageToServer (const TCHAR Message, IFileServerMessageHandler Handler) override

virtual IAsyncReadFileHandle *	OpenAsyncRead (const TCHAR *Filename) override

virtual IMappedFileHandle *	OpenMapped (const TCHAR *Filename) override

virtual void	SetAsyncMinimumPriority (EAsyncIOPriorityAndFlags MinPriority) override

virtual bool	IterateDirectory (const TCHAR *Directory, FDirectoryVisitor &Visitor)=0

virtual bool	IterateDirectory (const TCHAR *Directory, FDirectoryVisitorFunc Visitor)

virtual bool	IterateDirectoryRecursively (const TCHAR *Directory, FDirectoryVisitor &Visitor)

virtual bool	IterateDirectoryRecursively (const TCHAR *Directory, FDirectoryVisitorFunc Visitor)

virtual bool	IterateDirectoryStat (const TCHAR *Directory, FDirectoryStatVisitor &Visitor)=0

virtual bool	IterateDirectoryStat (const TCHAR *Directory, FDirectoryStatVisitorFunc Visitor)

virtual bool	IterateDirectoryStatRecursively (const TCHAR *Directory, FDirectoryStatVisitor &Visitor)

virtual bool	IterateDirectoryStatRecursively (const TCHAR *Directory, FDirectoryStatVisitorFunc Visitor)

Public Member Functions inherited from IPlatformFile
virtual	~IPlatformFile ()

virtual void	SetSandboxEnabled (bool bInEnabled)

virtual bool	IsSandboxEnabled () const

virtual void	InitializeAfterSetActive ()

virtual void	InitializeAfterProjectFilePath ()

virtual void	MakeUniquePakFilesForTheseFiles (const TArray< TArray< FString > > &InFiles)

virtual void	InitializeNewAsyncIO ()

virtual void	AddLocalDirectories (TArray< FString > &LocalDirectories)

virtual void	BypassSecurity (bool bInBypass)

virtual void	Tick ()

virtual bool	IsSymlink (const TCHAR *Filename)

virtual IFileHandle *	OpenReadNoBuffering (const TCHAR *Filename, bool bAllowWrite=false)

virtual void	GetTimeStampPair (const TCHAR PathA, const TCHAR PathB, FDateTime &OutTimeStampA, FDateTime &OutTimeStampB)

virtual FDateTime	GetTimeStampLocal (const TCHAR *Filename)

virtual bool	DoesCreatePublicFiles ()

virtual void	SetCreatePublicFiles (bool bCreatePublicFiles)

Static Public Member Functions
static const TCHAR *	GetTypeName ()

Static Public Member Functions inherited from IPlatformFile
static IPlatformFile &	GetPlatformPhysical ()

static const TCHAR *	GetPhysicalTypeName ()

Private Attributes
IPlatformFile *	LowerLevel

Additional Inherited Members
Public Types inherited from IPlatformFile
typedef TFunctionRef< bool(const TCHAR *, bool)	FDirectoryVisitorFunc)

typedef TFunctionRef< bool(const TCHAR *, const FFileStatData &)	FDirectoryStatVisitorFunc)

Detailed Description

Definition at line 255 of file IPlatformFileCachedWrapper.h.

Constructor & Destructor Documentation

◆ FCachedReadPlatformFile()

FCachedReadPlatformFile::FCachedReadPlatformFile ( )

inline

Definition at line 264 of file IPlatformFileCachedWrapper.h.

Member Function Documentation

◆ ConvertToAbsolutePathForExternalAppForRead()

virtual FString FCachedReadPlatformFile::ConvertToAbsolutePathForExternalAppForRead ( const TCHAR * Filename )

inlineoverridevirtual

Converts passed in filename to use an absolute path (for reading).

Parameters

Filename filename to convert to use an absolute path, safe to pass in already using absolute path

Returns: filename using absolute path

Reimplemented from IPlatformFile.

Definition at line 434 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ ConvertToAbsolutePathForExternalAppForWrite()

virtual FString FCachedReadPlatformFile::ConvertToAbsolutePathForExternalAppForWrite ( const TCHAR * Filename )

inlineoverridevirtual

Converts passed in filename to use an absolute path (for writing)

Parameters

Filename filename to convert to use an absolute path, safe to pass in already using absolute path

Returns: filename using absolute path

Reimplemented from IPlatformFile.

Definition at line 438 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ CopyDirectoryTree()

virtual bool FCachedReadPlatformFile::CopyDirectoryTree	(	const TCHAR *	DestinationDirectory,
		const TCHAR *	Source,
		bool	bOverwriteAllExisting )

inlineoverridevirtual

Copy a file or a hierarchy of files (directory).

Parameters

DestinationDirectory	Target path (either absolute or relative) to copy to - always a directory! (e.g. "/home/dest/").
Source	Source file (or directory) to copy (e.g. "/home/source/stuff").
bOverwriteAllExisting	Whether to overwrite everything that exists at target

Returns: true if operation completed successfully.

Reimplemented from IPlatformFile.

Definition at line 430 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ CopyFile()

virtual bool FCachedReadPlatformFile::CopyFile	(	const TCHAR *	To,
		const TCHAR *	From,
		EPlatformFileRead	ReadFlags = EPlatformFileRead::None,
		EPlatformFileWrite	WriteFlags = EPlatformFileWrite::None )

inlineoverridevirtual

Copy a file. This will fail if the destination file already exists.

Parameters

To	File to copy to.
From	File to copy from.
ReadFlags	Source file read options.
WriteFlags	Destination file write options.

Returns: true if the file was copied sucessfully.

Reimplemented from IPlatformFile.

Definition at line 422 of file IPlatformFileCachedWrapper.h.

◆ CreateDirectory()

virtual bool FCachedReadPlatformFile::CreateDirectory ( const TCHAR * Directory )

inlineoverridevirtual

Create a directory and return true if the directory was created or already existed.

Implements IPlatformFile.

Definition at line 382 of file IPlatformFileCachedWrapper.h.

◆ CreateDirectoryTree()

virtual bool FCachedReadPlatformFile::CreateDirectoryTree ( const TCHAR * Directory )

inlineoverridevirtual

Create a directory, including any parent directories and return true if the directory was created or already existed.

Reimplemented from IPlatformFile.

Definition at line 426 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ DeleteDirectory()

virtual bool FCachedReadPlatformFile::DeleteDirectory ( const TCHAR * Directory )

inlineoverridevirtual

Delete a directory and return true if the directory was deleted or otherwise does not exist.

Implements IPlatformFile.

Definition at line 386 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ DeleteDirectoryRecursively()

virtual bool FCachedReadPlatformFile::DeleteDirectoryRecursively ( const TCHAR * Directory )

inlineoverridevirtual

Delete all files and subdirectories in a directory, then delete the directory itself

Parameters

Directory The directory to delete.

Returns: true if the directory was deleted or did not exist.

Reimplemented from IPlatformFile.

Definition at line 418 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ DeleteFile()

virtual bool FCachedReadPlatformFile::DeleteFile ( const TCHAR * Filename )

inlineoverridevirtual

Delete a file and return true if the file exists. Will not delete read only files.

Implements IPlatformFile.

Definition at line 328 of file IPlatformFileCachedWrapper.h.

◆ DirectoryExists()

virtual bool FCachedReadPlatformFile::DirectoryExists ( const TCHAR * Directory )

inlineoverridevirtual

Return true if the directory exists.

Implements IPlatformFile.

Definition at line 378 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ FileExists()

virtual bool FCachedReadPlatformFile::FileExists ( const TCHAR * Filename )

inlineoverridevirtual

Return true if the file exists.

Implements IPlatformFile.

Definition at line 320 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ FileSize()

virtual int64 FCachedReadPlatformFile::FileSize ( const TCHAR * Filename )

inlineoverridevirtual

Return the size of the file, or -1 if it doesn't exist.

Implements IPlatformFile.

Definition at line 324 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ FindFiles()

virtual void FCachedReadPlatformFile::FindFiles	(	TArray< FString > &	FoundFiles,
		const TCHAR *	Directory,
		const TCHAR *	FileExtension )

inlinevirtual

Finds all the files within the given directory, with optional file extension filter

Parameters

Directory	The directory to iterate the contents of
FileExtension	If FileExtension is NULL, or an empty string "" then all files are found. Otherwise FileExtension can be of the form .EXT or just EXT and only files with that extension will be returned.

Returns: FoundFiles All the files that matched the optional FileExtension filter, or all files if none was specified.

Reimplemented from IPlatformFile.

Definition at line 410 of file IPlatformFileCachedWrapper.h.

◆ FindFilesRecursively()

virtual void FCachedReadPlatformFile::FindFilesRecursively	(	TArray< FString > &	FoundFiles,
		const TCHAR *	Directory,
		const TCHAR *	FileExtension )

inlinevirtual

Finds all the files within the directory tree, with optional file extension filter

Parameters

Directory	The starting directory to iterate the contents. This function explores subdirectories
FileExtension	If FileExtension is NULL, or an empty string "" then all files are found. Otherwise FileExtension can be of the form .EXT or just EXT and only files with that extension will be returned.

Returns: FoundFiles All the files that matched the optional FileExtension filter, or all files if none was specified.

Reimplemented from IPlatformFile.

Definition at line 414 of file IPlatformFileCachedWrapper.h.

◆ GetAccessTimeStamp()

virtual FDateTime FCachedReadPlatformFile::GetAccessTimeStamp ( const TCHAR * Filename )

inlineoverridevirtual

Return the last access time of a file. Returns FDateTime::MinValue() on failure

Implements IPlatformFile.

Definition at line 352 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ GetFilenameOnDisk()

virtual FString FCachedReadPlatformFile::GetFilenameOnDisk ( const TCHAR * Filename )

inlineoverridevirtual

For case insensitive filesystems, returns the full path of the file with the same case as in the filesystem

Implements IPlatformFile.

Definition at line 356 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ GetLowerLevel()

IPlatformFile * FCachedReadPlatformFile::GetLowerLevel ( )

inlineoverridevirtual

Gets the platform file wrapped by this file.

Implements IPlatformFile.

Definition at line 308 of file IPlatformFileCachedWrapper.h.

◆ GetName()

virtual const TCHAR * FCachedReadPlatformFile::GetName ( ) const

inlineoverridevirtual

Gets this platform file type name.

Implements IPlatformFile.

Definition at line 316 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ GetStatData()

virtual FFileStatData FCachedReadPlatformFile::GetStatData ( const TCHAR * FilenameOrDirectory )

inlineoverridevirtual

Return the stat data for the given file or directory. Check the FFileStatData::bIsValid member before using the returned data

Implements IPlatformFile.

Definition at line 390 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ GetTimeStamp()

virtual FDateTime FCachedReadPlatformFile::GetTimeStamp ( const TCHAR * Filename )

inlineoverridevirtual

Return the modification time of a file. Returns FDateTime::MinValue() on failure

Implements IPlatformFile.

Definition at line 344 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ GetTypeName()

static const TCHAR * FCachedReadPlatformFile::GetTypeName ( )

inlinestatic

Definition at line 259 of file IPlatformFileCachedWrapper.h.

Here is the caller graph for this function:

◆ Initialize()

virtual bool FCachedReadPlatformFile::Initialize	(	IPlatformFile *	Inner,
		const TCHAR *	CmdLine )

inlineoverridevirtual

Initializes platform file.

Parameters

Inner	Platform file to wrap by this file.
CmdLine	Command line to parse.

Returns: true if the initialization was successful, false otherise.

Implements IPlatformFile.

Definition at line 275 of file IPlatformFileCachedWrapper.h.

◆ IsReadOnly()

virtual bool FCachedReadPlatformFile::IsReadOnly ( const TCHAR * Filename )

inlineoverridevirtual

Return true if the file is read only.

Implements IPlatformFile.

Definition at line 332 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ IterateDirectory() [1/3]

virtual bool IPlatformFile::IterateDirectory	(	const TCHAR *	Directory,
		FDirectoryVisitor &	Visitor )

virtual

Call the Visit function of the visitor once for each file or directory in a single directory. This function does not explore subdirectories.

Parameters

Directory	The directory to iterate the contents of.
Visitor	Visitor to call for each element of the directory

Returns: false if the directory did not exist or if the visitor returned false.

Implements IPlatformFile.

◆ IterateDirectory() [2/3]

virtual bool IPlatformFile::IterateDirectory	(	const TCHAR *	Directory,
		FDirectoryVisitorFunc	Visitor )

virtual

Call the visitor once for each file or directory in a single directory. This function does not explore subdirectories.

Parameters

Directory	The directory to iterate the contents of.
Visitor	Visitor to call for each element of the directory (see FDirectoryVisitor::Visit for the signature)

Returns: false if the directory did not exist or if the visitor returned false.

Reimplemented from IPlatformFile.

◆ IterateDirectory() [3/3]

virtual bool FCachedReadPlatformFile::IterateDirectory	(	const TCHAR *	Directory,
		IPlatformFile::FDirectoryVisitor &	Visitor )

inlineoverridevirtual

Call the Visit function of the visitor once for each file or directory in a single directory. This function does not explore subdirectories.

Parameters

Directory	The directory to iterate the contents of.
Visitor	Visitor to call for each element of the directory

Returns: false if the directory did not exist or if the visitor returned false.

Implements IPlatformFile.

Definition at line 394 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ IterateDirectoryRecursively() [1/3]

virtual bool IPlatformFile::IterateDirectoryRecursively	(	const TCHAR *	Directory,
		FDirectoryVisitor &	Visitor )

virtual

Call the Visit function of the visitor once for each file or directory in a directory tree. This function explores subdirectories.

Parameters

Directory	The directory to iterate the contents of, recursively.
Visitor	Visitor to call for each element of the directory and each element of all subdirectories.

Returns: false if the directory did not exist or if the visitor returned false.

Reimplemented from IPlatformFile.

◆ IterateDirectoryRecursively() [2/3]

virtual bool IPlatformFile::IterateDirectoryRecursively	(	const TCHAR *	Directory,
		FDirectoryVisitorFunc	Visitor )

virtual

Call the Visit function of the visitor once for each file or directory in a directory tree. This function explores subdirectories.

Parameters

Directory	The directory to iterate the contents of, recursively.
Visitor	Visitor to call for each element of the directory and each element of all subdirectories (see FDirectoryVisitor::Visit for the signature).

Returns: false if the directory did not exist or if the visitor returned false.

Reimplemented from IPlatformFile.

◆ IterateDirectoryRecursively() [3/3]

virtual bool FCachedReadPlatformFile::IterateDirectoryRecursively	(	const TCHAR *	Directory,
		IPlatformFile::FDirectoryVisitor &	Visitor )

inlineoverridevirtual

Call the Visit function of the visitor once for each file or directory in a directory tree. This function explores subdirectories.

Parameters

Directory	The directory to iterate the contents of, recursively.
Visitor	Visitor to call for each element of the directory and each element of all subdirectories.

Returns: false if the directory did not exist or if the visitor returned false.

Reimplemented from IPlatformFile.

Definition at line 398 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ IterateDirectoryStat() [1/3]

virtual bool IPlatformFile::IterateDirectoryStat	(	const TCHAR *	Directory,
		FDirectoryStatVisitor &	Visitor )

virtual

Call the Visit function of the visitor once for each file or directory in a single directory. This function does not explore subdirectories.

Parameters

Directory	The directory to iterate the contents of.
Visitor	Visitor to call for each element of the directory

Returns: false if the directory did not exist or if the visitor returned false.

Implements IPlatformFile.

◆ IterateDirectoryStat() [2/3]

virtual bool IPlatformFile::IterateDirectoryStat	(	const TCHAR *	Directory,
		FDirectoryStatVisitorFunc	Visitor )

virtual

Call the visitor once for each file or directory in a single directory. This function does not explore subdirectories.

Parameters

Directory	The directory to iterate the contents of.
Visitor	Visitor to call for each element of the directory (see FDirectoryStatVisitor::Visit for the signature)

Returns: false if the directory did not exist or if the visitor returned false.

Reimplemented from IPlatformFile.

◆ IterateDirectoryStat() [3/3]

virtual bool FCachedReadPlatformFile::IterateDirectoryStat	(	const TCHAR *	Directory,
		IPlatformFile::FDirectoryStatVisitor &	Visitor )

inlineoverridevirtual

Call the Visit function of the visitor once for each file or directory in a single directory. This function does not explore subdirectories.

Parameters

Directory	The directory to iterate the contents of.
Visitor	Visitor to call for each element of the directory

Returns: false if the directory did not exist or if the visitor returned false.

Implements IPlatformFile.

Definition at line 402 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ IterateDirectoryStatRecursively() [1/3]

virtual bool IPlatformFile::IterateDirectoryStatRecursively	(	const TCHAR *	Directory,
		FDirectoryStatVisitor &	Visitor )

virtual

Call the Visit function of the visitor once for each file or directory in a directory tree. This function explores subdirectories.

Parameters

Directory	The directory to iterate the contents of, recursively.
Visitor	Visitor to call for each element of the directory and each element of all subdirectories.

Returns: false if the directory did not exist or if the visitor returned false.

Reimplemented from IPlatformFile.

◆ IterateDirectoryStatRecursively() [2/3]

virtual bool IPlatformFile::IterateDirectoryStatRecursively	(	const TCHAR *	Directory,
		FDirectoryStatVisitorFunc	Visitor )

virtual

Call the Visit function of the visitor once for each file or directory in a directory tree. This function explores subdirectories.

Parameters

Directory	The directory to iterate the contents of, recursively.
Visitor	Visitor to call for each element of the directory and each element of all subdirectories (see FDirectoryStatVisitor::Visit for the signature).

Returns: false if the directory did not exist or if the visitor returned false.

Reimplemented from IPlatformFile.

◆ IterateDirectoryStatRecursively() [3/3]

virtual bool FCachedReadPlatformFile::IterateDirectoryStatRecursively	(	const TCHAR *	Directory,
		IPlatformFile::FDirectoryStatVisitor &	Visitor )

inlineoverridevirtual

Call the Visit function of the visitor once for each file or directory in a directory tree. This function explores subdirectories.

Parameters

Directory	The directory to iterate the contents of, recursively.
Visitor	Visitor to call for each element of the directory and each element of all subdirectories.

Returns: false if the directory did not exist or if the visitor returned false.

Reimplemented from IPlatformFile.

Definition at line 406 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ MoveFile()

virtual bool FCachedReadPlatformFile::MoveFile	(	const TCHAR *	To,
		const TCHAR *	From )

inlineoverridevirtual

Attempt to move a file. Return true if successful. Will not overwrite existing files.

Implements IPlatformFile.

Definition at line 336 of file IPlatformFileCachedWrapper.h.

◆ OpenAsyncRead()

virtual IAsyncReadFileHandle * FCachedReadPlatformFile::OpenAsyncRead ( const TCHAR * Filename )

inlineoverridevirtual

Open a file for async reading. This call does not hit the disk or block.

Parameters

Filename file to be opened

Returns: Close the file by delete'ing the handle. A non-null return value does not mean the file exists, since that may not be determined yet.

Reimplemented from IPlatformFile.

Definition at line 446 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ OpenMapped()

virtual IMappedFileHandle * FCachedReadPlatformFile::OpenMapped ( const TCHAR * Filename )

inlineoverridevirtual

Open a file for async reading. This call does hit the disk; it is synchronous open.

Parameters

Filename file to be mapped. This doesn't actually map anything, just opens the file.

Returns: Close the file by delete'ing the handle. A non-null return value does mean the file exists. Null can be returned for many reasons even if the file exists. Perhaps this platform does not support mapped files, or this file is compressed in a pak file. Generally you attempt to open mapped, and if that fails, then use other file operations instead.

Reimplemented from IPlatformFile.

Definition at line 450 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ OpenRead()

virtual IFileHandle * FCachedReadPlatformFile::OpenRead	(	const TCHAR *	Filename,
		bool	bAllowWrite )

inlineoverridevirtual

Attempt to open a file for reading.

Parameters

Filename	file to be opened
bAllowWrite	(applies to certain platforms only) whether this file is allowed to be written to by other processes. This flag is needed to open files that are currently being written to as well.

Returns: If successful will return a non-nullptr pointer. Close the file by delete'ing the handle.

Implements IPlatformFile.

Definition at line 360 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ OpenWrite()

virtual IFileHandle * FCachedReadPlatformFile::OpenWrite	(	const TCHAR *	Filename,
		bool	bAppend = false,
		bool	bAllowRead = false )

inlineoverridevirtual

Attempt to open a file for writing. If successful will return a non-nullptr pointer. Close the file by delete'ing the handle.

Implements IPlatformFile.

Definition at line 369 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ SendMessageToServer()

virtual bool FCachedReadPlatformFile::SendMessageToServer	(	const TCHAR *	Message,
		IFileServerMessageHandler *	Handler )

inlineoverridevirtual

Sends a message to the file server, and will block until it's complete. Will return immediately if the file manager doesn't support talking to a server.

Parameters

Message The string message to send to the server

Returns: true if the message was sent to server and it returned success, or false if there is no server, or the command failed

Reimplemented from IPlatformFile.

Definition at line 442 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ SetAsyncMinimumPriority()

virtual void FCachedReadPlatformFile::SetAsyncMinimumPriority ( EAsyncIOPriorityAndFlags MinPriority )

inlineoverridevirtual

Controls if the pak precacher should process precache requests. Requests below this threshold will not get precached. Without this throttle, quite a lot of memory can be consumed if the disk races ahead of the CPU.

Parameters

MinPriority the minimum priority at which requests will get precached

Reimplemented from IPlatformFile.

Definition at line 454 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ SetLowerLevel()

virtual void FCachedReadPlatformFile::SetLowerLevel ( IPlatformFile * NewLowerLevel )

inlineoverridevirtual

Sets the platform file wrapped by this file.

Implements IPlatformFile.

Definition at line 312 of file IPlatformFileCachedWrapper.h.

◆ SetReadOnly()

virtual bool FCachedReadPlatformFile::SetReadOnly	(	const TCHAR *	Filename,
		bool	bNewReadOnlyValue )

inlineoverridevirtual

Attempt to change the read only status of a file. Return true if successful.

Implements IPlatformFile.

Definition at line 340 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ SetTimeStamp()

virtual void FCachedReadPlatformFile::SetTimeStamp	(	const TCHAR *	Filename,
		FDateTime	DateTime )

inlineoverridevirtual

Sets the modification time of a file

Implements IPlatformFile.

Definition at line 348 of file IPlatformFileCachedWrapper.h.

Here is the call graph for this function:

◆ ShouldBeUsed()

virtual bool FCachedReadPlatformFile::ShouldBeUsed	(	IPlatformFile *	Inner,
		const TCHAR *	CmdLine ) const

inlineoverridevirtual

Checks if this platform file should be used even though it was not asked to be. i.e. pak files exist on disk so we should use a pak file

Reimplemented from IPlatformFile.

Definition at line 282 of file IPlatformFileCachedWrapper.h.

Member Data Documentation

◆ LowerLevel

IPlatformFile* FCachedReadPlatformFile::LowerLevel

private

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

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FCachedReadPlatformFile()

Member Function Documentation

◆ ConvertToAbsolutePathForExternalAppForRead()

◆ ConvertToAbsolutePathForExternalAppForWrite()

◆ CopyDirectoryTree()

◆ CopyFile()

◆ CreateDirectory()

◆ CreateDirectoryTree()

◆ DeleteDirectory()

◆ DeleteDirectoryRecursively()

◆ DeleteFile()

◆ DirectoryExists()

◆ FileExists()

◆ FileSize()

◆ FindFiles()

◆ FindFilesRecursively()

◆ GetAccessTimeStamp()

◆ GetFilenameOnDisk()

◆ GetLowerLevel()

◆ GetName()

◆ GetStatData()

◆ GetTimeStamp()

◆ GetTypeName()

◆ Initialize()

◆ IsReadOnly()

◆ IterateDirectory() [1/3]

◆ IterateDirectory() [2/3]

◆ IterateDirectory() [3/3]

◆ IterateDirectoryRecursively() [1/3]

◆ IterateDirectoryRecursively() [2/3]

◆ IterateDirectoryRecursively() [3/3]

◆ IterateDirectoryStat() [1/3]

◆ IterateDirectoryStat() [2/3]

◆ IterateDirectoryStat() [3/3]

◆ IterateDirectoryStatRecursively() [1/3]

◆ IterateDirectoryStatRecursively() [2/3]

◆ IterateDirectoryStatRecursively() [3/3]

◆ MoveFile()

◆ OpenAsyncRead()

◆ OpenMapped()

◆ OpenRead()

◆ OpenWrite()

◆ SendMessageToServer()

◆ SetAsyncMinimumPriority()

◆ SetLowerLevel()

◆ SetReadOnly()

◆ SetTimeStamp()

◆ ShouldBeUsed()

Member Data Documentation

◆ LowerLevel