![]() |
UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
|
#include <StreamingNetworkPlatformFile.h>
Inheritance diagram for FStreamingNetworkPlatformFile:Static Public Member Functions | |
| static const TCHAR * | GetTypeName () |
Static Public Member Functions inherited from FNetworkPlatformFile | |
| static const TCHAR * | GetTypeName () |
| static NETWORKFILE_API void | ConvertServerFilenameToClientFilename (FString &FilenameToConvert, const FString &InServerEngineDir, const FString &InServerProjectDir, const FString &InServerEnginePlatformExtensionsDir, const FString &InServerProjectPlatformExtensionsDir) |
Static Public Member Functions inherited from IPlatformFile | |
| static CORE_API IPlatformFile & | GetPlatformPhysical () |
| static CORE_API const TCHAR * | GetPhysicalTypeName () |
Static Public Member Functions inherited from FSelfRegisteringExec | |
| static CORE_API bool | StaticExec (UWorld *Inworld, const TCHAR *Cmd, FOutputDevice &Ar) |
Friends | |
| class | FAsyncFileSync |
Wrapper to redirect the low level file system to a server
|
inline |
Default Constructor
|
virtual |
Virtual destructor
|
overridevirtual |
Converts passed in filename to use an absolute path (for reading).
| Filename | filename to convert to use an absolute path, safe to pass in already using absolute path |
Reimplemented from FNetworkPlatformFile.
|
overridevirtual |
Converts passed in filename to use an absolute path (for writing)
| Filename | filename to convert to use an absolute path, safe to pass in already using absolute path |
Reimplemented from FNetworkPlatformFile.
|
overridevirtual |
Copy a file. This will fail if the destination file already exists.
| To | File to copy to. |
| From | File to copy from. |
| ReadFlags | Source file read options. |
| WriteFlags | Destination file write options. |
Reimplemented from FNetworkPlatformFile.
Create a directory and return true if the directory was created or already existed.
Reimplemented from FNetworkPlatformFile.
Create a directory, including any parent directories and return true if the directory was created or already existed.
Reimplemented from FNetworkPlatformFile.
Delete a directory and return true if the directory was deleted or otherwise does not exist.
Reimplemented from FNetworkPlatformFile.
|
overridevirtual |
Delete all files and subdirectories in a directory, then delete the directory itself
| Directory | The directory to delete. |
Reimplemented from FNetworkPlatformFile.
Delete a file and return true if the file exists. Will not delete read only files.
Reimplemented from FNetworkPlatformFile.
Return true if the directory exists.
Reimplemented from FNetworkPlatformFile.
|
overridevirtual |
Return the last access time of a file. Returns FDateTime::MinValue() on failure
Reimplemented from FNetworkPlatformFile.
|
inlineoverridevirtual |
Gets the platform file wrapped by this file.
Reimplemented from FNetworkPlatformFile.
Gets this platform file type name.
Reimplemented from FNetworkPlatformFile.
Return the modification time of a file. Returns FDateTime::MinValue() on failure
Reimplemented from FNetworkPlatformFile.
|
inlineoverridevirtual |
Performs initialization of the platform file after it has become the active (FPlatformFileManager.GetPlatformFile() will return this
Reimplemented from FNetworkPlatformFile.
Return true if the file is read only.
Reimplemented from FNetworkPlatformFile.
|
overridevirtual |
Call the Visit function of the visitor once for each file or directory in a single directory. This function does not explore subdirectories.
| Directory | The directory to iterate the contents of. |
| Visitor | Visitor to call for each element of the directory |
Reimplemented from FNetworkPlatformFile.
|
overridevirtual |
Call the Visit function of the visitor once for each file or directory in a directory tree. This function explores subdirectories.
| 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. |
Reimplemented from FNetworkPlatformFile.
|
overridevirtual |
Attempt to move a file. Return true if successful. Will not overwrite existing files.
Reimplemented from FNetworkPlatformFile.
|
overridevirtual |
Attempt to open a file for reading. Please consider using the new overload that takes EReadFlags instead of bools as 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. |
Reimplemented from FNetworkPlatformFile.
|
overridevirtual |
Attempt to open a file for writing. If successful will return a non-nullptr pointer. Close the file by deleting the handle.
Reimplemented from FNetworkPlatformFile.
Sends Close message to the server.
| FStreamingNetworkFileHandle * FStreamingNetworkPlatformFile::SendOpenMessage | ( | const FString & | Filename, |
| bool | bIsWriting, | ||
| bool | bAppend, | ||
| bool | bAllowRead | ||
| ) |
Sends Open message to the server and creates a new file handle if successful.
| bool FStreamingNetworkPlatformFile::SendReadMessage | ( | uint64 | HandleId, |
| uint8 * | Destination, | ||
| int64 | BytesToRead | ||
| ) |
Sends Read message to the server.
| STREAMINGFILE_API bool FStreamingNetworkPlatformFile::SendReadMessage | ( | uint64 | HandleId, |
| uint8 * | Destination, | ||
| int64 | BytesToRead, | ||
| int64 | Offset | ||
| ) |
Sends Seek message to the server.
| bool FStreamingNetworkPlatformFile::SendWriteMessage | ( | uint64 | HandleId, |
| const uint8 * | Source, | ||
| int64 | BytesToWrite | ||
| ) |
Sends Write message to the server.
|
inlineoverridevirtual |
Sets the platform file wrapped by this file.
Reimplemented from FNetworkPlatformFile.
|
overridevirtual |
Attempt to change the read only status of a file. Return true if successful.
Reimplemented from FNetworkPlatformFile.
|
overridevirtual |
Sets the modification time of a file
Reimplemented from FNetworkPlatformFile.
|
overridevirtual |
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 FNetworkPlatformFile.
|
friend |