FStreamingNetworkPlatformFile

Wrapper to redirect the low level file system to a server

Windows
MacOS
Linux

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

Name Description

Public function

FStreamingNetworkPlatformFile()

Default Constructor

Destructors

Name Description

Public function Virtual

~FStreamingNetworkPlatformFile()

Virtual destructor

Functions

Name Description

Public function Static

const TCHAR ...

 

GetTypeName()

Public function

bool

 

SendCloseMessage

(
    uint64 HandleId
)

Sends Close message to the server.

Public function

FStreamingNe...

 

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

 

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 IPlatformFile

Name Description

Public function Virtual

FString

 

ConvertToAbsolutePathForExternalAppForRead

(
    const TCHAR* Filename
)

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

Public function Virtual

FString

 

ConvertToAbsolutePathForExternalAppForWrite

(
    const TCHAR* Filename
)

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

IPlatformFil...

 

GetLowerLevel()

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

 

InitializeAfterSetActive()

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

 

IterateDirectory

(
    const TCHAR* Directory,
    IPlatformFile::FDirectoryVisitor& ...
)

Call the Visit function of the visitor once for each file or directory in a single directory.

Public function Virtual

bool

 

IterateDirectoryRecursively

(
    const TCHAR* Directory,
    IPlatformFile::FDirectoryVisitor& ...
)

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

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.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss