OptimisedDelta.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "Templates/ValueOrError.h"
#include "BuildPatchManifest.h"
#include "BuildPatchSettings.h"
 
namespace BuildPatchServices
{
    class IDownloadService;
 
    class IOptimisedDelta
    {
    public:
        virtual ~IOptimisedDelta() {}
        typedef TValueOrError<FBuildPatchAppManifestPtr, FString> FResultValueOrError;
 
        virtual const IOptimisedDelta::FResultValueOrError& GetResult() const = 0;
 
        virtual int32 GetMetaDownloadSize() const = 0;
    };
 
    struct FOptimisedDeltaConfiguration
    {
    public:
        FOptimisedDeltaConfiguration(FBuildPatchAppManifestRef DestinationManifest);
 
    public:
        // The installation provided source manifest.
        FBuildPatchAppManifestPtr SourceManifest;
        // The installation provided destination manifest.
        FBuildPatchAppManifestRef DestinationManifest;
        // The list of cloud directory roots that will be used to pull patch data from.
        TArray<FString> CloudDirectories;
        // The policy to follow for requesting an optimised delta.
        EDeltaPolicy DeltaPolicy;
        // The mode for installation.
        EInstallMode InstallMode;
    };
 
    struct FOptimisedDeltaDependencies
    {
    public:
        // A download service instance.
        IDownloadService* DownloadService = nullptr;
        // Function to call once the destination manifest has been selected. Receives manifest or error.
        TUniqueFunction<void(const IOptimisedDelta::FResultValueOrError&)> OnComplete;
    };
 
    class FOptimisedDeltaFactory
    {
    public:
        static IOptimisedDelta* Create(const FOptimisedDeltaConfiguration& Configuration, FOptimisedDeltaDependencies&& Dependencies);
    };
}