INetworkFileSystemModule.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Modules/ModuleInterface.h"
#include "ShaderCompiler.h"
 
class INetworkFileServer;
namespace UE::Cook
{
    class ICookOnTheFlyNetworkServer;
}
 
DECLARE_DELEGATE_ThreeParams(FFileRequestDelegate, FString&, const FString&, TArray<FString>&);
 
DECLARE_DELEGATE_OneParam(FRecompileShadersDelegate, const FShaderRecompileData&);
 
DECLARE_DELEGATE_RetVal( FString, FSandboxPathDelegate);
 
DECLARE_MULTICAST_DELEGATE_OneParam( FOnFileModifiedDelegate, const FString& );
 
 
DECLARE_DELEGATE_RetVal_TwoParams( bool, FNewConnectionDelegate, const FString&, const FString& );
 
 
// container struct for delegates which the network file system uses
struct FNetworkFileDelegateContainer
{
public:
    FNetworkFileDelegateContainer() : 
        NewConnectionDelegate(nullptr), 
        SandboxPathOverrideDelegate(nullptr),
        FileRequestDelegate(nullptr),
        RecompileShadersDelegate(nullptr),
        OnFileModifiedCallback(nullptr)
    {}
    FNewConnectionDelegate NewConnectionDelegate; 
    FSandboxPathDelegate SandboxPathOverrideDelegate;
    FFileRequestDelegate FileRequestDelegate;
    FRecompileShadersDelegate RecompileShadersDelegate;
 
    FOnFileModifiedDelegate* OnFileModifiedCallback; // this is called from other systems to notify the network file system that a file has been modified hence the terminology callback
};
 
enum ENetworkFileServerProtocol
{
    NFSP_Tcp,
    NFSP_Http,
 
    NFSP_Platform,
};
 
// Network file server options
struct FNetworkFileServerOptions
{
    /* File server protocol*/
    ENetworkFileServerProtocol Protocol = NFSP_Tcp;
 
    /* The port number to bind to (-1 = default port, 0 = any available port) */
    int32 Port = INDEX_NONE;
 
    /* Optional delegates to be invoked when a file is requested by a client */
    FNetworkFileDelegateContainer Delegates;
 
    /* Active target platform(s) */
    TArray<ITargetPlatform*> TargetPlatforms;
 
    /* When running cook on the fly this options restricts package assets being sent from the project content folder */
    bool bRestrictPackageAssetsToSandbox = false;
};
 
class INetworkFileSystemModule
    : public IModuleInterface
{
public:
 
    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
    {
        return nullptr;
    }
 
public:
 
    virtual ~INetworkFileSystemModule( ) { }
};