DownloadService.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "CoreMinimal.h"
#include "Containers/Ticker.h"
#include "Common/SpeedRecorder.h"
 
namespace BuildPatchServices
{
    class IDownloadServiceStat;
    class IInstallerAnalytics;
    class IHttpManager;
    class IFileSystem;
 
    class IDownload
    {
    public:
        virtual ~IDownload() {}
 
        virtual bool RequestSuccessful() const = 0;
 
        virtual bool ResponseSuccessful() const = 0;
 
        virtual int32 GetResponseCode() const = 0;
 
        virtual const TArray<uint8>& GetData() const = 0;
    };
    typedef TSharedRef<IDownload, ESPMode::ThreadSafe> FDownloadRef;
 
    DECLARE_DELEGATE_TwoParams(FDownloadProgressDelegate, int32 /* RequestId */, uint64 /* BytesSoFar */);
 
    DECLARE_DELEGATE_TwoParams(FDownloadCompleteDelegate, int32 /* RequestId */, const FDownloadRef& /* Download */);
 
    class IDownloadService
    {
    public:
        virtual ~IDownloadService() {}
 
        virtual int32 RequestFile(const FString& FileUri, const FDownloadCompleteDelegate& OnCompleteDelegate, const FDownloadProgressDelegate& OnProgressDelegate) = 0;
 
        virtual int32 RequestFileWithHeaders(const FString& FileUri, const TMap<FString, FString>& RequestHeaders, const FDownloadCompleteDelegate& OnCompleteDelegate, const FDownloadProgressDelegate& OnProgressDelegate) = 0;
 
        virtual void RequestCancel(int32 RequestId) = 0;
 
        virtual void RequestAbandon(int32 RequestId) = 0;
    };
 
    class FDownloadServiceFactory
    {
    public:
        static IDownloadService* Create(IHttpManager* HttpManager, IFileSystem* FileSystem, IDownloadServiceStat* DownloadServiceStat, IInstallerAnalytics* InstallerAnalytics);
    };
 
    class IDownloadServiceStat
    {
    public:
        virtual ~IDownloadServiceStat() {}
 
        struct FDownloadRecord
        {
            // The id for the request that was made.
            int32 RequestId;
            // The uri used when making the request.
            FString Uri;
            // Whether the request completed successfully.
            bool bSuccess;
            // The response code for the request.
            int32 ResponseCode;
            // The timing record.
            ISpeedRecorder::FRecord SpeedRecord;
        };
 
        virtual void OnDownloadStarted(int32 RequestId, const FString& Uri) = 0;
 
        virtual void OnDownloadProgress(int32 RequestId, uint64 BytesReceived) = 0;
 
        virtual void OnDownloadComplete(const FDownloadRecord& DownloadRecord) = 0;
    };
}