UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FNetworkFileServer Class Reference

#include <NetworkFileServer.h>

+ Inheritance diagram for FNetworkFileServer:

Public Member Functions

 FNetworkFileServer (FNetworkFileServerOptions InFileServerOptions, TSharedRef< UE::Cook::ICookOnTheFlyNetworkServer > InCookOnTheFlyNetworkServer)
 
 ~FNetworkFileServer ()
 
virtual bool IsItReadyToAcceptConnections (void) const override
 
virtual bool GetAddressList (TArray< TSharedPtr< FInternetAddr > > &OutAddresses) const override
 
virtual FString GetSupportedProtocol () const override
 
virtual int32 NumConnections () const override
 
virtual void Shutdown () override
 
- Public Member Functions inherited from INetworkFileServer
virtual ~INetworkFileServer (void)
 

Detailed Description

This class wraps the server thread and network connection

Constructor & Destructor Documentation

◆ FNetworkFileServer()

FNetworkFileServer::FNetworkFileServer ( FNetworkFileServerOptions  InFileServerOptions,
TSharedRef< UE::Cook::ICookOnTheFlyNetworkServer >  InCookOnTheFlyNetworkServer 
)

Creates and initializes a new instance.

Parameters
InFileServerOptionsNetwork file server options

◆ ~FNetworkFileServer()

FNetworkFileServer::~FNetworkFileServer ( )

Destructor.

Member Function Documentation

◆ GetAddressList()

bool FNetworkFileServer::GetAddressList ( TArray< TSharedPtr< FInternetAddr > > &  OutAddresses) const
overridevirtual

Gets the list of local network addresses that the file server listens on.

Parameters
OutAddresses- Will hold the address list.
Returns
true on success, false otherwise.

Implements INetworkFileServer.

◆ GetSupportedProtocol()

FString FNetworkFileServer::GetSupportedProtocol ( ) const
overridevirtual

Gets the list of local network addresses that the file server listens on.

Parameters
OutAddresses- Will hold the address list.
Returns
true on success, false otherwise.

Implements INetworkFileServer.

◆ IsItReadyToAcceptConnections()

bool FNetworkFileServer::IsItReadyToAcceptConnections ( void  ) const
overridevirtual

Returns Whether the network server was able to successfully start or not.

Returns
true on success, false otherwise.

Implements INetworkFileServer.

◆ NumConnections()

int32 FNetworkFileServer::NumConnections ( ) const
overridevirtual

Gets the number of active connections.

Returns
The number of connections.

Implements INetworkFileServer.

◆ Shutdown()

void FNetworkFileServer::Shutdown ( )
overridevirtual

Shuts down the file server.

Implements INetworkFileServer.


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