Verifier.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "Installer/Controllable.h"
#include "Common/SpeedRecorder.h"
#include "BuildPatchManifest.h"
#include "Interfaces/IBuildInstallerSharedContext.h"
 
namespace BuildPatchServices
{
    class IFileSystem;
    class IVerifierStat;
    class IBuildManifestSet;
    enum class EVerifyMode : uint32;
    enum class EVerifyError : uint32;
    enum class EVerifyResult : uint32
    {
        Success = 0,
 
        // If the process was ended due to an external cancel.
        Aborted,
 
        // The verify failed due to a missing file.
        FileMissing,
 
        // The verify failed due to a file failing to open.
        OpenFileFailed,
 
        // The expected data hash for a file did not match.
        HashCheckFailed,
 
        // A file did not match the expected size.
        FileSizeFailed,
    };
 
    bool TryConvertToVerifyResult(EVerifyError InVerifyError, EVerifyResult& OutVerifyResult);
 
    bool TryConvertToVerifyError(EVerifyResult InVerifyResult, EVerifyError& OutVerifyError);
 
    class IVerifier
        : public IControllable
    {
    public:
        virtual EVerifyResult Verify(TArray<FString>& CorruptFiles) = 0;
 
        virtual void AddTouchedFiles(const TSet<FString>& TouchedFiles) = 0;
    };
 
    class FVerifierFactory
    {
    public:
        static IVerifier* Create(IFileSystem* FileSystem, IVerifierStat* VerifierStat, EVerifyMode VerifyMode, IBuildInstallerSharedContextPtr SharedContext, IBuildManifestSet* ManifestSet, FString VerifyDirectory, FString StagedFileDirectory);
    };
 
    class IVerifierStat
    {
    public:
        virtual ~IVerifierStat() {}
 
        virtual void OnFileStarted(const FString& Filename, int64 FileSize) = 0;
 
        virtual void OnFileProgress(const FString& Filename, int64 TotalBytes) = 0;
 
        virtual void OnFileCompleted(const FString& Filename, EVerifyResult VerifyResult) = 0;
 
        virtual void OnFileRead(const ISpeedRecorder::FRecord& Record) = 0;
 
        virtual void OnProcessedDataUpdated(int64 TotalBytes) = 0;
 
        virtual void OnTotalRequiredUpdated(int64 TotalBytes) = 0;
    };
}