#include <NetworkFileServerConnection.h>

Inheritance diagram for FNetworkFileServerClientConnection:

Public Member Functions
	FNetworkFileServerClientConnection (const FNetworkFileServerOptions &InFileServerOptions)

virtual	~FNetworkFileServerClientConnection ()

bool	ProcessPayload (FArchive &Ar)

FString	GetDescription () const

Public Member Functions inherited from FSelfRegisteringExec
CORE_API	FSelfRegisteringExec ()

virtual CORE_API	~FSelfRegisteringExec ()

Public Member Functions inherited from FExec
virtual CORE_API	~FExec ()

virtual CORE_API bool	Exec (UWorld InWorld, const TCHAR Cmd, FOutputDevice &Ar)

Protected Member Functions
void	ConvertClientFilenameToServerFilename (FString &FilenameToConvert)

void	ConvertLocalFilenameToServerFilename (FString &FilenameToConvert)

void	ProcessOpenFile (FArchive &In, FArchive &Out, bool bIsWriting)

void	ProcessReadFile (FArchive &In, FArchive &Out)

void	ProcessWriteFile (FArchive &In, FArchive &Out)

void	ProcessSeekFile (FArchive &In, FArchive &Out)

void	ProcessCloseFile (FArchive &In, FArchive &Out)

void	ProcessGetFileInfo (FArchive &In, FArchive &Out)

void	ProcessMoveFile (FArchive &In, FArchive &Out)

void	ProcessDeleteFile (FArchive &In, FArchive &Out)

void	ProcessCopyFile (FArchive &In, FArchive &Out)

void	ProcessSetTimeStamp (FArchive &In, FArchive &Out)

void	ProcessSetReadOnly (FArchive &In, FArchive &Out)

void	ProcessCreateDirectory (FArchive &In, FArchive &Out)

void	ProcessDeleteDirectory (FArchive &In, FArchive &Out)

void	ProcessDeleteDirectoryRecursively (FArchive &In, FArchive &Out)

void	ProcessToAbsolutePathForRead (FArchive &In, FArchive &Out)

void	ProcessToAbsolutePathForWrite (FArchive &In, FArchive &Out)

void	ProcessReportLocalFiles (FArchive &In, FArchive &Out)

bool	ProcessGetFileList (FArchive &In, FArchive &Out)

void	ProcessHeartbeat (FArchive &In, FArchive &Out)

FORCEINLINE IFileHandle *	FindOpenFile (uint64 HandleId)

bool	PackageFile (FString &Filename, FString &TargetFilename, FArchive &Out)

bool	ProcessSyncFile (FArchive &In, FArchive &Out)

virtual bool	SendPayload (TArray< uint8 > &Out)=0

void	FileModifiedCallback (const FString &Filename)

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

FString	FixupSandboxPathForClient (const FString &Filename)

TMap< FString, FDateTime >	FixupSandboxPathsForClient (const TMap< FString, FDateTime > &SandboxPaths)

Protected Member Functions inherited from FExec
virtual bool	Exec_Dev (UWorld InWorld, const TCHAR Cmd, FOutputDevice &Ar)

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

Additional Inherited Members
Static Public Member Functions inherited from FSelfRegisteringExec
static CORE_API bool	StaticExec (UWorld Inworld, const TCHAR Cmd, FOutputDevice &Ar)

Detailed Description

This class processes all incoming messages from the client.

Constructor & Destructor Documentation

◆ FNetworkFileServerClientConnection()

FNetworkFileServerClientConnection::FNetworkFileServerClientConnection ( const FNetworkFileServerOptions & InFileServerOptions )

Creates and initializes a new instance.

Parameters

InSocket	- The client socket to use.
NetworkFileDelegates-	delegates the client calls when events from the client happen

◆ ~FNetworkFileServerClientConnection()

FNetworkFileServerClientConnection::~FNetworkFileServerClientConnection ( )

virtual

Destructor.

Member Function Documentation

◆ ConvertClientFilenameToServerFilename()

void FNetworkFileServerClientConnection::ConvertClientFilenameToServerFilename ( FString & FilenameToConvert )

protected

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

Parameters

FilenameToConvert Upon input, the client version of the filename. After the call, the server version

◆ ConvertLocalFilenameToServerFilename()

void FNetworkFileServerClientConnection::ConvertLocalFilenameToServerFilename ( FString & FilenameToConvert )

protected

Convert the given filename from the an arbitrary local representation to the normalized server version of it NOTE: Potentially modifies the input FString!!!!

Parameters

FilenameToConvert Upon input, the filename. After the call, the server version

◆ Exec_Runtime()

bool FNetworkFileServerClientConnection::Exec_Runtime	(	class UWorld *	InWorld,
		const TCHAR *	Cmd,
		FOutputDevice &	Ar
	)

overrideprotectedvirtual

Implementation of Exec that is called on all targets where UE_ALLOW_EXEC_COMMANDS is true

Reimplemented from FExec.

◆ FileModifiedCallback()

void FNetworkFileServerClientConnection::FileModifiedCallback ( const FString & Filename )

protected

When a file is modified this callback is triggered cleans up any cached information about the file and notifies client

Parameters

Filename of the file which has been modified

◆ FindOpenFile()

FORCEINLINE IFileHandle * FNetworkFileServerClientConnection::FindOpenFile ( uint64 HandleId )

inlineprotected

Finds open file handle by its ID.

Parameters

HandleId

Returns: Pointer to the file handle, NULL if the specified handle id doesn't exist.

◆ FixupSandboxPathForClient()

FString FNetworkFileServerClientConnection::FixupSandboxPathForClient ( const FString & Filename )

protected

Convert a path to a sandbox path and translate so the client can understand it

Parameters

Filename	to convert
bLowerCaseFiles	conver the file name to all lower case

Returns: Resulting fixed up path

Fixup sandbox paths to match what package loading will request on the client side. e.g. Sandbox path: "../../../Elemental/Content/Elemental/Effects/FX_Snow_Cracks/Crack_02/Materials/M_SnowBlast.uasset -> client path: "../../../Samples/Showcases/Elemental/Content/Elemental/Effects/FX_Snow_Cracks/Crack_02/Materials/M_SnowBlast.uasset" This ensures that devicelocal-cached files will be properly timestamp checked before deletion.

◆ FixupSandboxPathsForClient()

TMap< FString, FDateTime > FNetworkFileServerClientConnection::FixupSandboxPathsForClient ( const TMap< FString, FDateTime > & SandboxPaths )

protected

Convert a path to a sandbox path and translate so the client can understand it

Parameters

Filename	to convert
bLowerCaseFiles	conver the file name to all lower case

Returns: Resulting fixed up path

Fixup sandbox paths to match what package loading will request on the client side. e.g. Sandbox path: "../../../Elemental/Content/Elemental/Effects/FX_Snow_Cracks/Crack_02/Materials/M_SnowBlast.uasset -> client path: "../../../Samples/Showcases/Elemental/Content/Elemental/Effects/FX_Snow_Cracks/Crack_02/Materials/M_SnowBlast.uasset" This ensures that devicelocal-cached files will be properly timestamp checked before deletion.

◆ GetDescription()

FString FNetworkFileServerClientConnection::GetDescription ( ) const

Gets the client connection's description.

Returns: Description string.

◆ PackageFile()

bool FNetworkFileServerClientConnection::PackageFile	(	FString &	Filename,
		FString &	TargetFilename,
		FArchive &	Out
	)

protected

◆ ProcessCloseFile()

void FNetworkFileServerClientConnection::ProcessCloseFile	(	FArchive &	In,
		FArchive &	Out
	)

protected

Closes file handle and removes it from the open handles list.

◆ ProcessCopyFile()

void FNetworkFileServerClientConnection::ProcessCopyFile	(	FArchive &	In,
		FArchive &	Out
	)

protected

Copies file.

◆ ProcessCreateDirectory()

void FNetworkFileServerClientConnection::ProcessCreateDirectory	(	FArchive &	In,
		FArchive &	Out
	)

protected

Creates directory.

◆ ProcessDeleteDirectory()

void FNetworkFileServerClientConnection::ProcessDeleteDirectory	(	FArchive &	In,
		FArchive &	Out
	)

protected

Deletes directory.

◆ ProcessDeleteDirectoryRecursively()

void FNetworkFileServerClientConnection::ProcessDeleteDirectoryRecursively	(	FArchive &	In,
		FArchive &	Out
	)

protected

Deletes directory recursively.

◆ ProcessDeleteFile()

void FNetworkFileServerClientConnection::ProcessDeleteFile	(	FArchive &	In,
		FArchive &	Out
	)

protected

Deletes file.

◆ ProcessGetFileInfo()

void FNetworkFileServerClientConnection::ProcessGetFileInfo	(	FArchive &	In,
		FArchive &	Out
	)

protected

Gets info on the specified file.

◆ ProcessGetFileList()

bool FNetworkFileServerClientConnection::ProcessGetFileList	(	FArchive &	In,
		FArchive &	Out
	)

protected

Walk over a set of directories, and get all files (recursively) in them, along with their timestamps.

◆ ProcessHeartbeat()

void FNetworkFileServerClientConnection::ProcessHeartbeat	(	FArchive &	In,
		FArchive &	Out
	)

protected

Heartbeat.

◆ ProcessMoveFile()

void FNetworkFileServerClientConnection::ProcessMoveFile	(	FArchive &	In,
		FArchive &	Out
	)

protected

Moves file.

◆ ProcessOpenFile()

void FNetworkFileServerClientConnection::ProcessOpenFile	(	FArchive &	In,
		FArchive &	Out,
		bool	bIsWriting
	)

protected

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

Parameters

FilenameToConvert Upon input, the server version of the filename. After the call, the client version Opens a file for reading or writing.

◆ ProcessPayload()

bool FNetworkFileServerClientConnection::ProcessPayload ( FArchive & Ar )

Processes the given payload.

Parameters

Ar	An archive containing the payload data.
Out	An archive that will contain the processed data.

◆ ProcessReadFile()

void FNetworkFileServerClientConnection::ProcessReadFile	(	FArchive &	In,
		FArchive &	Out
	)

protected

Reads from file.

◆ ProcessReportLocalFiles()

void FNetworkFileServerClientConnection::ProcessReportLocalFiles	(	FArchive &	In,
		FArchive &	Out
	)

protected

Reposts local files.

◆ ProcessSeekFile()

void FNetworkFileServerClientConnection::ProcessSeekFile	(	FArchive &	In,
		FArchive &	Out
	)

protected

Seeks in file.

◆ ProcessSetReadOnly()

void FNetworkFileServerClientConnection::ProcessSetReadOnly	(	FArchive &	In,
		FArchive &	Out
	)

protected

Sets read only flag.

◆ ProcessSetTimeStamp()

void FNetworkFileServerClientConnection::ProcessSetTimeStamp	(	FArchive &	In,
		FArchive &	Out
	)

protected

Sets file timestamp.

◆ ProcessSyncFile()

bool FNetworkFileServerClientConnection::ProcessSyncFile	(	FArchive &	In,
		FArchive &	Out
	)

protected

Processes a heartbeat message.

Parameters

In	-
Out	-

◆ ProcessToAbsolutePathForRead()

void FNetworkFileServerClientConnection::ProcessToAbsolutePathForRead	(	FArchive &	In,
		FArchive &	Out
	)

protected

ConvertToAbsolutePathForExternalAppForRead.

◆ ProcessToAbsolutePathForWrite()

void FNetworkFileServerClientConnection::ProcessToAbsolutePathForWrite	(	FArchive &	In,
		FArchive &	Out
	)

protected

ConvertToAbsolutePathForExternalAppForWrite.

◆ ProcessWriteFile()

void FNetworkFileServerClientConnection::ProcessWriteFile	(	FArchive &	In,
		FArchive &	Out
	)

protected

Writes to file.

◆ SendPayload()

virtual bool FNetworkFileServerClientConnection::SendPayload ( TArray< uint8 > & Out )

protectedpure virtual

Implemented in FCookOnTheFlyNetworkFileServerConnection.

The documentation for this class was generated from the following files:

Engine/Source/Runtime/NetworkFileSystem/Private/NetworkFileServerConnection.h
Engine/Source/Runtime/NetworkFileSystem/Private/NetworkFileServerConnection.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FNetworkFileServerClientConnection()

◆ ~FNetworkFileServerClientConnection()

Member Function Documentation

◆ ConvertClientFilenameToServerFilename()

◆ ConvertLocalFilenameToServerFilename()

◆ Exec_Runtime()

◆ FileModifiedCallback()

◆ FindOpenFile()

◆ FixupSandboxPathForClient()

◆ FixupSandboxPathsForClient()

◆ GetDescription()

◆ PackageFile()

◆ ProcessCloseFile()

◆ ProcessCopyFile()

◆ ProcessCreateDirectory()

◆ ProcessDeleteDirectory()

◆ ProcessDeleteDirectoryRecursively()

◆ ProcessDeleteFile()

◆ ProcessGetFileInfo()

◆ ProcessGetFileList()

◆ ProcessHeartbeat()

◆ ProcessMoveFile()

◆ ProcessOpenFile()

◆ ProcessPayload()

◆ ProcessReadFile()

◆ ProcessReportLocalFiles()

◆ ProcessSeekFile()

◆ ProcessSetReadOnly()

◆ ProcessSetTimeStamp()

◆ ProcessSyncFile()

◆ ProcessToAbsolutePathForRead()

◆ ProcessToAbsolutePathForWrite()

◆ ProcessWriteFile()

◆ SendPayload()