1. Epic GamesDeveloper
  3. FNetworkPlatformFile

FNetworkPlatformFile

Wrapper to redirect the low level file system to a server

API > API/Runtime > API/Runtime/NetworkFile

Wrapper to redirect the low level file system to a server

   
Name FNetworkPlatformFile
Type class
Header File /Engine/Source/Runtime/NetworkFile/Public/NetworkPlatformFile.h
Include Path #include "NetworkPlatformFile.h"

Syntax

class FNetworkPlatformFile :  
    public IPlatformFile,  
    public FSelfRegisteringExec

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FNetworkPlatformFile()

 Constructor NetworkPlatformFile.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FNetworkPlatformFile()

 Destructor NetworkPlatformFile.h  

Constants

Name Type Remarks Include Path
BulkFileExtension FString   NetworkPlatformFile.h
ExpFileExtension FString   NetworkPlatformFile.h
FontFileExtension FString   NetworkPlatformFile.h
MP4Extension FString   NetworkPlatformFile.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Connection TSharedPtr< UE::Cook::ICookOnTheFlyServerConnection >   NetworkPlatformFile.h  
FinishedAsyncNetworkReadUnsolicitedFiles FScopedEvent * Unsolicitied files events NetworkPlatformFile.h  
FinishedAsyncWriteUnsolicitedFiles FScopedEvent *   NetworkPlatformFile.h  
NewPayloadEvent FEventRef   NetworkPlatformFile.h  
PendingPayloads TSpscQueue< TArray< uint8 > >   NetworkPlatformFile.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual FString ConvertToAbsolutePathForExternalAppForRead ( const TCHAR* Filename
)

   NetworkPlatformFile.h  

virtual FString ConvertToAbsolutePathForExternalAppForWrite ( const TCHAR* Filename
)

   NetworkPlatformFile.h  

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

   NetworkPlatformFile.h  

virtual bool CreateDirectory ( const TCHAR* Directory
)

   NetworkPlatformFile.h  

virtual bool CreateDirectoryTree ( const TCHAR* Directory
)

   NetworkPlatformFile.h  

virtual bool DeleteDirectory ( const TCHAR* Directory
)

   NetworkPlatformFile.h  

virtual bool DeleteDirectoryRecursively ( const TCHAR* Directory
)

   NetworkPlatformFile.h  

virtual bool DeleteFile ( const TCHAR* Filename
)

   NetworkPlatformFile.h  

virtual bool DirectoryExists ( const TCHAR* Directory
)

   NetworkPlatformFile.h  

virtual bool FileExists ( const TCHAR* Filename
)

   NetworkPlatformFile.h  

virtual int64 FileSize ( const TCHAR* Filename
)

   NetworkPlatformFile.h  

virtual FDateTime GetAccessTimeStamp ( const TCHAR* Filename
)

   NetworkPlatformFile.h  

virtual FString GetFilenameOnDisk ( const TCHAR* Filename
)

   NetworkPlatformFile.h  

virtual IPlatformFile * GetLowerLevel()

   NetworkPlatformFile.h  

virtual const TCHAR * GetName()

   NetworkPlatformFile.h  

virtual FFileStatData GetStatData ( const TCHAR* FilenameOrDirectory
)

   NetworkPlatformFile.h  

virtual FDateTime GetTimeStamp ( const TCHAR* Filename
)

   NetworkPlatformFile.h  

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

   NetworkPlatformFile.h  

virtual FString GetVersionInfo()

   NetworkPlatformFile.h  

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

   NetworkPlatformFile.h  

virtual void InitializeAfterSetActive()

   NetworkPlatformFile.h  

virtual bool IsReadOnly ( const TCHAR* Filename
)

   NetworkPlatformFile.h  

virtual bool IsUsable()

   NetworkPlatformFile.h  

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

   NetworkPlatformFile.h  

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

   NetworkPlatformFile.h  

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

   NetworkPlatformFile.h  

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

   NetworkPlatformFile.h  

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

   NetworkPlatformFile.h  

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

   NetworkPlatformFile.h  

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

   NetworkPlatformFile.h  

virtual bool ReceiveResponse ( TArray< uint8 >& Out
)

   NetworkPlatformFile.h  

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

   NetworkPlatformFile.h  

virtual bool SendPayloadAndReceiveResponse ( TArray< uint8 >& In,
TArray< uint8 >& Out
)

   NetworkPlatformFile.h  

bool SendReadMessage ( uint8* Destination,
int64 BytesToRead
)

   NetworkPlatformFile.h  

bool SendWriteMessage ( const uint8* Source,
int64 BytesToWrite
)

   NetworkPlatformFile.h  

virtual void SetLowerLevel ( IPlatformFile* NewLowerLevel
)

   NetworkPlatformFile.h  

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

   NetworkPlatformFile.h  

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

   NetworkPlatformFile.h  

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

   NetworkPlatformFile.h  

virtual void Tick()

   NetworkPlatformFile.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void ConvertServerFilenameToClientFilename ( FString& FilenameToConvert
)

 Convert the given filename from the server to the client version of it NOTE: Potentially modifies the input FString!!!! NetworkPlatformFile.h  

virtual bool Exec_Runtime ( UWorld* InWorld,
const TCHAR* Cmd,
FOutputDevice& Ar
)

   NetworkPlatformFile.h  

virtual void FillGetFileList ( FNetworkFileArchive& Payload
)

   NetworkPlatformFile.h  

virtual void GetFileInfo ( const TCHAR* Filename,
FFileInfo& Info
)

   NetworkPlatformFile.h  

virtual bool InitializeInternal ( IPlatformFile* Inner,
const TCHAR* HostIP
)

 Initialize network platform file give the specified host IP NetworkPlatformFile.h  

void MakeStandardNetworkFilename ( FString& Filename
)

 Does normal path standardization, and also any extra modifications to make string comparisons against the internal directory list work properly. NetworkPlatformFile.h  

virtual void OnFileUpdated ( const FString& LocalFilename
)

   NetworkPlatformFile.h  

virtual void PerformHeartbeat ()

 Send a heartbeat message to the file server. NetworkPlatformFile.h  

virtual void ProcessServerCachedFilesResponse ( FArrayReader& InReponse,
const FPackageFileVersion& ServerPackageVersion,
const int32 ServerPackageLicenseeVersion
)

   NetworkPlatformFile.h  

virtual void ProcessServerInitialResponse ( FArrayReader& InResponse,
FPackageFileVersion& OutServerPackageVersion,
int32& OutServerPackageLicenseeVersion
)

   NetworkPlatformFile.h  

Static

Name Remarks Include Path Unreal Specifiers

static void ConvertServerFilenameToClientFilename ( FString& FilenameToConvert,
const FString& InServerEngineDir,
const FString& InServerProjectDir,
const FString& InServerEnginePlatformExtensionsDir,
const FString& InServerProjectPlatformExtensionsDir
)

   NetworkPlatformFile.h  

static const TCHAR * GetTypeName()

   NetworkPlatformFile.h  

static bool IsAdditionalCookedFileExtension ( const TCHAR* Ext
)

 Returns whether the passed in extension is a an additional (but non asset) cooked file. NetworkPlatformFile.h  

static bool IsMediaExtension ( const TCHAR* Ext
)

 Returns whether the passed in extension is a video extension. NetworkPlatformFile.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page