BuildStreamer.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "CoreMinimal.h"
#include "Misc/SecureHash.h"
#include "HAL/FileManager.h"
 
#include "Core/BlockStructure.h"
#include "Core/Factory.h"
#include "Core/FileSpan.h"
#include "Common/StatsCollector.h"
#include "Installer/ChunkReferenceTracker.h"
#include "Installer/CloudChunkSource.h"
#include "BuildPatchManifest.h"
 
namespace BuildPatchServices
{
    class IBuildStreamer
    {
    public:
        virtual ~IBuildStreamer() {}
 
        virtual uint32 DequeueData(uint8* Buffer, uint32 ReqSize, bool WaitForData = true) = 0;
 
        virtual bool IsEndOfData() const = 0;
    };
 
    class IDirectoryBuildStreamer
        : public IBuildStreamer
    {
    public:
        virtual bool GetFileSpan(uint64 StartingIdx, FFileSpan& FileSpan) const = 0;
 
        virtual TArray<FString> GetEmptyFiles() const = 0;
 
        virtual TArray<FString> GetAllFilenames() const = 0;
 
        virtual uint64 GetBuildSize() const = 0; 
 
        virtual TArray<FFileSpan> GetAllFiles() const = 0;
 
        virtual bool HasAborted() const = 0;
    };
 
    class IManifestBuildStreamer
        : public IBuildStreamer
    {
    public:
        // Declares types for expected factory dependencies.
        typedef TArray<FGuid> FCustomChunkReferences;
        typedef TFactory<IChunkReferenceTracker, FCustomChunkReferences> IChunkReferenceTrackerFactory;
        typedef TFactory<ICloudChunkSource, IChunkReferenceTracker*> ICloudChunkSourceFactory;
    public:
        virtual const FBlockStructure& GetBlockStructure() const = 0;
    };
 
    // Configuration for constructing a directory build streamer.
    struct FDirectoryBuildStreamerConfig
    {
    public:
        const FString BuildRoot;
        const FString InputListFile;
        const FString IgnoreListFile;
    };
 
    // Holds all dependencies for constructing a directory build streamer.
    struct FDirectoryBuildStreamerDependencies
    {
    public:
        FStatsCollector* const StatsCollector;
        IFileSystem* const FileSystem;
    };
 
    // Configuration for constructing a manifest build streamer.
    struct FManifestBuildStreamerConfig
    {
    public:
        FString CloudDirectory;
        FBlockStructure DesiredBytes;
    };
 
    // Holds all dependencies for constructing a manifest build streamer.
    struct FManifestBuildStreamerDependencies
    {
    public:
        IManifestBuildStreamer::IChunkReferenceTrackerFactory* const ChunkReferenceTrackerFactory;
        IManifestBuildStreamer::ICloudChunkSourceFactory* const CloudChunkSourceFactory;
        FStatsCollector* const StatsCollector;
        FBuildPatchAppManifest* const Manifest;
    };
 
    class FBuildStreamerFactory
    {
    public:
        static IDirectoryBuildStreamer* Create(FDirectoryBuildStreamerConfig Config, FDirectoryBuildStreamerDependencies Dependencies);
 
        static IManifestBuildStreamer* Create(FManifestBuildStreamerConfig Config, FManifestBuildStreamerDependencies Dependencies);
    };
}