InstallChunkSource.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "Installer/ChunkSource.h"
#include "Installer/Controllable.h"
#include "Common/SpeedRecorder.h"
#include "BuildPatchManifest.h"
 
class IBuildInstallerSharedContext;
 
namespace BuildPatchServices
{
    class IChunkStore;
    class IChunkReferenceTracker;
    class IInstallerError;
    class IInstallChunkSourceStat;
    class IFileSystem;
    class IBuildManifestSet;
 
 
    class IConstructorInstallChunkSource : public IConstructorChunkSource
    {
    public:
        virtual ~IConstructorInstallChunkSource() {}
 
        // Return the chunks this source can provide.
        virtual const TSet<FGuid>& GetAvailableChunks() const = 0;
 
        // Notification that a file is about to be deleted so we need to clear out any references.
        virtual void OnBeforeDeleteFile(const FString& FilePath) = 0;
 
        // Return the list of chunks for a file so that the constructor can harvest them before the file
        // is deleted
        virtual void GetChunksForFile(const FString& FilePath, TSet<FGuid>& OutChunks) const = 0;
 
        // Call the lambda on each file the chunk needs to load bits from.
        virtual void EnumerateFilesForChunk(const FGuid& DataId, TUniqueFunction<void(const FString& NormalizedInstallDirectory, const FString& NormalizedFileName)>&& Callback) const = 0;
 
        // Tell the install source when files will be going away so we can report when chunks are unavailable.
        // This should be the ChunkReferenceTracker->GetCurrentUsageIndex at which the files will get deleted.
        virtual void SetFileRetirementPositions(TMap<FString, int32>&& FileRetirementPositions) = 0;
 
        // InstallationSources is the install manifest for each installed app that we can pull from. This
        // is expected to be a single entry.
        // LONGTERM question -- how does this work during delta generation? It is expected that all apps
        // are installed and chunks are pulled from everything?
        static IConstructorInstallChunkSource* CreateInstallSource(
            IFileSystem* FileSystem, 
            IInstallChunkSourceStat* InstallChunkSourceStat, 
            const TMultiMap<FString, FBuildPatchAppManifestRef>& InstallationSources,
            const TSet<FGuid>& ChunksThatWillBeNeeded);
    };
 
    class IInstallChunkSourceStat
    {
    public:
        enum class ELoadResult : uint8
        {
            Success = 0,
 
            // The hash information was missing.
            MissingHashInfo,
 
            // Chunk part information was missing.
            MissingPartInfo,
 
            // Failed to open a source file.
            OpenFileFail,
 
            // The expected source file size was not matched.
            IncorrectFileSize_DEPRECATED,
 
            // The expected data hash for the chunk did not match.
            HashCheckFailed,
 
            // The process has been aborted.
            Aborted,
 
            // Invalid assemble structure (i.e. overlapping chunk parts)
            InvalidChunkParts
        };
 
    public:
        virtual ~IInstallChunkSourceStat() {}
 
        UE_DEPRECATED(5.6, "No longer batch loaded")
        virtual void OnBatchStarted(const TArray<FGuid>& ChunkIds) {};
 
        virtual void OnLoadStarted(const FGuid& ChunkId) = 0;
 
        virtual void OnLoadComplete(const FGuid& ChunkId, const ELoadResult& Result, const ISpeedRecorder::FRecord& Record) = 0;
 
        UE_DEPRECATED(5.6, "No longer batch loaded")
        virtual void OnAcceptedNewRequirements(const TSet<FGuid>& ChunkIds) {};
    };
    
    const TCHAR* ToString(const IInstallChunkSourceStat::ELoadResult& LoadResult);
}