| IPlatformFile | ||||||
| FSelfRegisteringExec
|
Module |
|
Header |
/Engine/Source/Runtime/NetworkFile/Public/NetworkPlatformFile.h |
Include |
#include "NetworkPlatformFile.h" |
class FNetworkPlatformFile :
public IPlatformFile,
public FSelfRegisteringExec
Wrapper to redirect the low level file system to a server
Name | Description | ||
---|---|---|---|
|
bHasLoadedDDCDirectories |
This is true after the DDC directories have been loaded from the DDC system |
|
|
bIsUsable |
||
|
CachedLocalFiles |
This keeps track of what files have been "EnsureFileIsLocal'd" |
|
|
ConnectionFlags |
The connection flags are passed to the server during GetFileList the server may cache them |
|
|
FileServerPort |
||
|
float |
HeartbeatFrequency |
Frequency to send heartbeats to server in seconds set to negative number to disable. |
|
IPlatformFile &... |
InnerPlatformFile |
The file interface to read/write local files with |
|
LocalDirectories |
Set of directories that should use the local filesystem |
|
|
LocalDirectoriesCriticalSection |
||
|
ServerEngineDir |
The server engine dir |
|
|
ServerEnginePlatformExtensionsDir |
The server engine platform extensions dir |
|
|
ServerFiles |
This is the "TOC" of the server |
|
|
ServerProjectDir |
The server game dir |
|
|
ServerProjectPlatformExtensionsDir |
The server project platform extensions dir |
|
|
SynchronizationObject |
||
|
TotalFilesFoundLocally |
||
|
TotalFilesSynced |
||
|
double |
TotalNetworkSyncTime |
|
|
double |
TotalTimeSpentInUnsolicitedPackages |
|
|
TotalUnsolicitedPackages |
||
|
double |
TotalWaitForAsyncUnsolicitedPackages |
|
|
double |
TotalWriteTime |
Some stats for messuring network platform file performance |
|
UnsolicitedPackagesHits |
||
|
UnsolicitedPackageWaits |
Name | Description | |
---|---|---|
|
FNetworkPlatformFile() |
Constructor |
Name | Description | |
---|---|---|
|
~FNetworkPlatformFile() |
Destructor |
Name | Description | ||
---|---|---|---|
|
ConvertServerFilenameToClientFilename ( |
Convert the given filename from the server to the client version of it NOTE: Potentially modifies the input FString!!!! |
|
|
ConvertServerFilenameToClientFilename |
||
|
FillGetFileList ( |
||
|
GetFileInfo |
||
|
const TCHAR ... |
GetTypeName() |
|
|
GetVersionInfo() |
||
|
InitializeInternal ( |
Initialize network platform file give the specified host IP |
|
|
IsUsable() |
||
|
MakeStandardNetworkFilename ( |
Does normal path standardization, and also any extra modifications to make string comparisons against the internal directory list work properly. |
|
|
OnFileUpdated ( |
||
|
PerformHeartbeat() |
Send a heartbeat message to the file server. |
|
|
ProcessServerCachedFilesResponse ( |
||
|
ProcessServerInitialResponse ( |
||
|
ReceiveResponse |
||
|
SendPayloadAndReceiveResponse |
||
|
SendReadMessage |
||
|
SendWriteMessage |
Name | Description | ||
---|---|---|---|
|
ConvertToAbsolutePathForExternalAppForRead ( |
Converts passed in filename to use an absolute path (for reading). |
|
|
ConvertToAbsolutePathForExternalAppForWrite ( |
Converts passed in filename to use an absolute path (for writing) |
|
|
CopyFile ( |
Copy a file. This will fail if the destination file already exists. |
|
|
CreateDirectory ( |
Create a directory and return true if the directory was created or already existed. |
|
|
CreateDirectoryTree ( |
Create a directory, including any parent directories and return true if the directory was created or already existed. |
|
|
DeleteDirectory ( |
Delete a directory and return true if the directory was deleted or otherwise does not exist. |
|
|
DeleteDirectoryRecursively ( |
Delete all files and subdirectories in a directory, then delete the directory itself |
|
|
DeleteFile ( |
Delete a file and return true if the file exists. Will not delete read only files. |
|
|
DirectoryExists ( |
Return true if the directory exists. |
|
|
FileExists ( |
Return true if the file exists. |
|
|
FileSize ( |
Return the size of the file, or -1 if it doesn't exist. |
|
|
GetAccessTimeStamp ( |
Return the last access time of a file. |
|
|
GetFilenameOnDisk ( |
For case insensitive filesystems, returns the full path of the file with the same case as in the filesystem |
|
|
IPlatformFil... |
GetLowerLevel() |
Gets the platform file wrapped by this file. |
|
const TCHAR ... |
GetName() |
Gets this platform file type name. |
|
FFileStatDat... |
GetStatData ( |
Return the stat data for the given file or directory. |
|
GetTimeStamp ( |
Return the modification time of a file. |
|
|
GetTimeStampPair |
||
|
Initialize ( |
Initializes platform file. |
|
|
InitializeAfterSetActive() |
Performs initialization of the platform file after it has become the active (FPlatformFileManager.GetPlatformFile() will return this |
|
|
IsReadOnly ( |
Return true if the file is read only. |
|
|
IterateDirectory ( |
Call the Visit function of the visitor once for each file or directory in a single directory. |
|
|
IterateDirectoryRecursively ( |
Call the Visit function of the visitor once for each file or directory in a directory tree. |
|
|
IterateDirectoryStat ( |
Call the Visit function of the visitor once for each file or directory in a single directory. |
|
|
IterateDirectoryStatRecursively ( |
Call the Visit function of the visitor once for each file or directory in a directory tree. |
|
|
MoveFile |
Attempt to move a file. Return true if successful. Will not overwrite existing files. |
|
|
IFileHandle ... |
OpenRead |
Attempt to open a file for reading. |
|
IFileHandle ... |
OpenWrite |
Attempt to open a file for writing. |
|
SendMessageToServer ( |
Sends a message to the file server, and will block until it's complete. |
|
|
SetLowerLevel ( |
Sets the platform file wrapped by this file. |
|
|
SetReadOnly |
Attempt to change the read only status of a file. Return true if successful. |
|
|
SetTimeStamp |
Sets the modification time of a file |
|
|
ShouldBeUsed ( |
Checks if this platform file should be used even though it was not asked to be. |
|
|
Tick() |
Platform file can override this to get a regular tick from the engine |
Name | Description | ||
---|---|---|---|
|
Exec ( |
Exec handler |
Name |
Description |
---|---|
BulkFileExtension |
|
ExpFileExtension |
|
FontFileExtension |
|
MP4Extension |