UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
INetworkFileSystemModule Class Referenceabstract

#include <INetworkFileSystemModule.h>

+ Inheritance diagram for INetworkFileSystemModule:

Public Member Functions

virtual INetworkFileServer * CreateNetworkFileServer (bool bLoadTargetPlatforms, int32 Port=-1, FNetworkFileDelegateContainer InNetworkFileDelegateContainer=FNetworkFileDelegateContainer(), const ENetworkFileServerProtocol Protocol=NFSP_Tcp) const =0
 
virtual INetworkFileServer * CreateNetworkFileServer (FNetworkFileServerOptions FileServerOptions, bool bLoadTargetPlatforms) const =0
 
virtual INetworkFileServer * CreateNetworkFileServer (TSharedRef< UE::Cook::ICookOnTheFlyNetworkServer > CookOnTheFlyNetworkServer, FNetworkFileDelegateContainer Delegates) const
 
virtual ~INetworkFileSystemModule ()
 
- Public Member Functions inherited from IModuleInterface
virtual ~IModuleInterface ()
 
virtual void StartupModule ()
 
virtual void PreUnloadCallback ()
 
virtual void PostLoadCallback ()
 
virtual void ShutdownModule ()
 
virtual bool SupportsDynamicReloading ()
 
virtual bool SupportsAutomaticShutdown ()
 
virtual bool IsGameModule () const
 

Detailed Description

Interface for network file system modules.

Constructor & Destructor Documentation

◆ ~INetworkFileSystemModule()

virtual INetworkFileSystemModule::~INetworkFileSystemModule ( )
inlinevirtual

Virtual destructor.

Member Function Documentation

◆ CreateNetworkFileServer() [1/3]

virtual INetworkFileServer * INetworkFileSystemModule::CreateNetworkFileServer ( bool  bLoadTargetPlatforms,
int32  Port = -1,
FNetworkFileDelegateContainer  InNetworkFileDelegateContainer = FNetworkFileDelegateContainer(),
const ENetworkFileServerProtocol  Protocol = NFSP_Tcp 
) const
pure virtual

Creates a new network file server.

Parameters
InPortThe port number to bind to (-1 = default port, 0 = any available port).
StreamingWhether it should be a streaming server.
InFileRequestDelegateAn optional delegate to be invoked when a file is requested by a client.
InRecompileShadersDelegateAn optional delegate to be invoked when shaders need to be recompiled.
Returns
The new file server, or nullptr if creation failed.

Implemented in FNetworkFileSystemModule.

◆ CreateNetworkFileServer() [2/3]

virtual INetworkFileServer * INetworkFileSystemModule::CreateNetworkFileServer ( FNetworkFileServerOptions  FileServerOptions,
bool  bLoadTargetPlatforms 
) const
pure virtual

Creates a new network file server.

Parameters
FileServerOptionsFile server options
bLoadTargetPlatformsIf true, gets the target platform from the command line or all available target platforms
Returns
The new file server, or nullptr if creation failed.

Implemented in FNetworkFileSystemModule.

◆ CreateNetworkFileServer() [3/3]

virtual INetworkFileServer * INetworkFileSystemModule::CreateNetworkFileServer ( TSharedRef< UE::Cook::ICookOnTheFlyNetworkServer >  CookOnTheFlyNetworkServer,
FNetworkFileDelegateContainer  Delegates 
) const
inlinevirtual

Creates a new network file server for COTF.

Parameters
CookOnTheFlyNetworkServerCookOnTheFly network server
DelegatesDelegates to be invoked when a file is requested by a client.
Returns
The new file server, or nullptr if creation failed.

Reimplemented in FNetworkFileSystemModule.

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