IBuildStatistics.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "CoreMinimal.h"
#include "Misc/Guid.h"
 
namespace BuildPatchServices
{
    struct FBuildInstallerConfiguration;
    enum class EVerifyError : uint32;
 
    enum class EFileOperationState : int32
    {
        // Not yet evaluated.
        Unknown = 0,
 
        // The data for this operation has not yet been requested (from a local chunkdb source).
        PendingLocalChunkDbData,
 
        // The data is being acquired (from a local chunkdb source).
        RetrievingLocalChunkDbData,
 
        // The data for this operation has not yet been requested (from a local install source).
        PendingLocalInstallData,
 
        // The data is being acquired (from a local install source).
        RetrievingLocalInstallData,
 
        // The data for this operation has not yet been requested (from a remote cloud source).
        PendingRemoteCloudData,
 
        // The data is being acquired (from a remote cloud source).
        RetrievingRemoteCloudData,
 
        // The data is in a local store to be loaded later.
        PendingLocalDataStore,
 
        // The data is being acquired (from a local store).
        RetrievingLocalDataStore,
 
        // The data is in a memory chunk store ready for use.
        DataInMemoryStore,
 
        // The file operation has been written to the staging location.
        Staged,
 
        // The file operation has been written to the destination install location.
        Installed,
 
        // The file operation is being verified.
        Verifying,
 
        // The file operation has been verified and is corrupt.
        VerifiedFail,
 
        // The file operation has been verified and successful.
        VerifiedSuccess,
 
        // Helpers.
        NUM_States,
        Complete = NUM_States - 1
    };
 
    struct FFileOperation
    {
    public:
        FFileOperation(FString Filename, const FGuid& DataId, uint64 Offest, uint64 Size, EFileOperationState CurrentState);
        ~FFileOperation();
 
    public:
        // The build filename where this data section goes.
        FString Filename;
        // The idea of the chunk where the data is taken from.
        FGuid DataId;
        // The offset into the file.
        uint64 Offest;
        // The size of the data to write.
        uint64 Size;
        // The current state of this operation.
        EFileOperationState CurrentState;
    };
 
    struct FDownload
    {
        // The uri for the download.
        FString Data;
        // The size of the download.
        int64 Size;
        // The amount of data received so far.
        int64 Received;
    };
 
    class IBuildStatistics
    {
    public:
        virtual ~IBuildStatistics() { }
 
        virtual const FBuildInstallerConfiguration& GetConfiguration() const = 0;
 
        virtual int64 GetDownloadSize() const = 0;
 
        virtual int64 GetBuildSize() const = 0;
 
        UE_DEPRECATED(5.6, "Appears to be unused, not replaced")
        virtual int32 GetMemoryChunkStoreSize() const { return 0; }
 
        UE_DEPRECATED(5.6, "Appears to be unused, not replaced")
        virtual int32 GetMemoryChunksInStore() const { return 0; }
 
        UE_DEPRECATED(5.6, "Appears to be unused, not replaced")
        virtual int32 GetMemoryChunksBooted() const { return 0; }
 
        UE_DEPRECATED(5.6, "Appears to be unused, not replaced")
        virtual int32 GetMemoryChunksRetained() const { return 0; }
 
        virtual FString GetCurrentWorkingFileName() const = 0;
 
        virtual float GetCurrentWorkingFileProgress() const = 0;
 
        virtual FGuid GetCurrentWorkingData() const = 0;
 
        virtual TArray<FDownload> GetCurrentDownloads() const = 0;
 
        virtual bool IsDownloadActive() const = 0;
 
        virtual bool IsHardDiskActiveAdministering() const = 0;
 
        virtual bool IsHardDiskActiveWrite() const = 0;
 
        virtual bool IsHardDiskActiveRead() const = 0;
 
        virtual const TArray<FFileOperation>& GetFileOperationStates() const = 0;
 
        virtual double GetDownloadByteSpeed() const = 0;
 
        virtual double GetDiskReadByteSpeed() const = 0;
 
        UE_DEPRECATED(5.6, "Chunk db read speeds now included in DiskReadByteSpeed")
        double GetChunkDbReadByteSpeed() const { return 0; }
 
        virtual double GetDiskWriteByteSpeed() const = 0;
 
        virtual int32 GetNumVerifyErrors() const = 0;
        
        virtual TMap<EVerifyError, int32> GetVerifyErrorCounts() const = 0;
    };
 
    typedef TSharedPtr<IBuildStatistics> IBuildStatisticsPtr;
    typedef TSharedRef<IBuildStatistics> IBuildStatisticsRef;
}