1. Epic GamesDeveloper
  3. FStreamingNetworkPlatformFile

FStreamingNetworkPlatformFile

Wrapper to redirect the low level file system to a server

API > API/Runtime > API/Runtime/StreamingFile

Inheritance Hierarchy

References

   
Module StreamingFile
Header /Engine/Source/Runtime/StreamingFile/Public/StreamingNetworkPlatformFile.h
Include #include "StreamingNetworkPlatformFile.h"

Syntax

class FStreamingNetworkPlatformFile : public FNetworkPlatformFile

Remarks

Wrapper to redirect the low level file system to a server

Constructors

  Type Name Description
Public function   Default Constructor

Destructors

  Type Name Description
Public function Virtual   Virtual destructor

Functions

  Type Name Description
Public function Static const TCHAR *  
Public function bool

SendCloseMessage ( uint64 HandleId
)

 Sends Close message to the server.
Public function FStreamingNetworkFileHandle *

SendOpenMessage ( const FString& Filename,
bool bIsWriting,
bool bAppend,
bool bAllowRead
)

 Sends Open message to the server and creates a new file handle if successful.
Public function bool

SendReadMessage ( uint64 HandleId,
uint8* Destination,
int64 BytesToRead
)

 Sends Read message to the server.
Public function bool

SendReadMessage ( uint64 HandleId,
uint8* Destination,
int64 BytesToRead,
int64 Offset
)

  
Public function bool

SendSeekMessage ( uint64 HandleId,
int64 NewPosition
)

 Sends Seek message to the server.
Public function bool

SendWriteMessage ( uint64 HandleId,
const uint8* Source,
int64 BytesToWrite
)

 Sends Write message to the server.

Overridden from FNetworkPlatformFile

  Type Name Description
Public function Virtual bool  
Public function Virtual bool  

Overridden from IPlatformFile

  Type Name Description
Public function Virtual FString Converts passed in filename to use an absolute path (for reading).
Public function Virtual FString Converts passed in filename to use an absolute path (for writing)
Public function Virtual bool

CopyFile ( const TCHAR* To,
const TCHAR* From,
EPlatformFileRead ReadFlags,
EPlatformFileWrite WriteFlags
)

 Copy a file. This will fail if the destination file already exists.
Public function Virtual bool

CreateDirectory ( const TCHAR* Directory
)

 Create a directory and return true if the directory was created or already existed.
Public function Virtual bool

CreateDirectoryTree ( const TCHAR* Directory
)

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

DeleteDirectory ( const TCHAR* Directory
)

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

DeleteDirectoryRecursively ( const TCHAR* Directory
)

 Delete all files and subdirectories in a directory, then delete the directory itself
Public function Virtual bool

DeleteFile ( const TCHAR* Filename
)

 Delete a file and return true if the file exists. Will not delete read only files.
Public function Virtual bool
DirectoryExists

( const TCHAR* Directory
)

 Return true if the directory exists.
Public function Virtual FDateTime

GetAccessTimeStamp ( const TCHAR* Filename
)

 Return the last access time of a file.
Public function Virtual IPlatformFile * Gets the platform file wrapped by this file.
Public function Virtual Const const TCHAR *

GetName ()

 Gets this platform file type name.
Public function Virtual FDateTime

GetTimeStamp ( const TCHAR* Filename
)

 Return the modification time of a file.
Public function Virtual void Need to override what FNetworkPlatformFile does here
Public function Virtual bool

IsReadOnly ( const TCHAR* Filename
)

 Return true if the file is read only.
Public function Virtual bool

MoveFile ( const TCHAR* To,
const TCHAR* From
)

 Attempt to move a file. Return true if successful. Will not overwrite existing files.
Public function Virtual IFileHandle *

OpenRead ( const TCHAR* Filename,
bool bAllowWrite
)

 Attempt to open a file for reading.
Public function Virtual IFileHandle *

OpenWrite ( const TCHAR* Filename,
bool bAppend,
bool bAllowRead
)

 Attempt to open a file for writing.
Public function Virtual void

SetLowerLevel ( IPlatformFile* NewLowerLevel
)

 Sets the platform file wrapped by this file.
Public function Virtual bool

SetReadOnly ( const TCHAR* Filename,
bool bNewReadOnlyValue
)

 Attempt to change the read only status of a file. Return true if successful.
Public function Virtual void

SetTimeStamp ( const TCHAR* Filename,
FDateTime DateTime
)

 Sets the modification time of a file
Public function Virtual Const bool

ShouldBeUsed ( IPlatformFile* Inner,
const TCHAR* CmdLine
)

 Checks if this platform file should be used even though it was not asked to be.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page