IBackgroundHttpRequest.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "BackgroundHttpNotificationObject.h"
 
//Included as we use EHttpResponseCode
#include "Interfaces/IHttpResponse.h"
 
//Included for FBackgroundHttpRequestMetricsExtended
#include "BackgroundHttpMetrics.h"
 
typedef TSharedPtr<class IBackgroundHttpRequest, ESPMode::ThreadSafe> FBackgroundHttpRequestPtr;
typedef TSharedPtr<class IBackgroundHttpResponse, ESPMode::ThreadSafe> FBackgroundHttpResponsePtr;
typedef TSharedPtr<class IBackgroundHttpManager, ESPMode::ThreadSafe> FBackgroundHttpManagerPtr;
 
 
 
DECLARE_DELEGATE_TwoParams(FBackgroundHttpRequestCompleteDelegate, FBackgroundHttpRequestPtr /*Request*/, bool /*bWasSuccessful*/);
 
DECLARE_DELEGATE_ThreeParams(FBackgroundHttpProgressUpdateDelegate, FBackgroundHttpRequestPtr /*Request*/, int32 /*TotalBytesWritten*/, int32 /*BytesWrittenSinceLastUpdate*/);
 
DECLARE_DELEGATE_ThreeParams(FBackgroundHttpRequestMetricsDelegate, FBackgroundHttpRequestPtr /* Request */, int32 /* TotalBytesDownloaded */, float /* DownloadDuration */);
 
DECLARE_DELEGATE_TwoParams(FBackgroundHttpRequestMetricsExtendedDelegate, FBackgroundHttpRequestPtr /* Request */, FBackgroundHttpRequestMetricsExtended /* All the metrics on the request */);
 
enum class EBackgroundHTTPPriority : uint8
{
      High
    , Normal
    , Low
    , Num
};
 
inline const TCHAR* LexToString(EBackgroundHTTPPriority InType)
{
    switch (InType)
    {
    case EBackgroundHTTPPriority::High:
        return TEXT("High");
    case EBackgroundHTTPPriority::Normal:
        return TEXT("Normal");
    case EBackgroundHTTPPriority::Low:
        return TEXT("Low");
    case EBackgroundHTTPPriority::Num:
        return TEXT("INVALID(Num)");
 
    default:
        break;
    }
    return TEXT("<Unknown EBackgroundHTTPPriority>");
}
 
inline bool LexTryParseString(EBackgroundHTTPPriority& OutMode, const TCHAR* InBuffer)
{
    if (FCString::Stricmp(InBuffer, TEXT("High")) == 0)
    {
        OutMode = EBackgroundHTTPPriority::High;
        return true;
    }
    if (FCString::Stricmp(InBuffer, TEXT("Normal")) == 0)
    {
        OutMode = EBackgroundHTTPPriority::Normal;
        return true;
    }
    if (FCString::Stricmp(InBuffer, TEXT("Low")) == 0)
    {
        OutMode = EBackgroundHTTPPriority::Low;
        return true;
    }
    return false;
}
 
class IBackgroundHttpRequest 
    : public TSharedFromThis<IBackgroundHttpRequest, ESPMode::ThreadSafe>
{
public:
    virtual void SetURLAsList(const TArray<FString>& URLs, int NumRetriesToAttempt) = 0;
 
    virtual const TArray<FString>& GetURLList() const = 0;
 
    virtual void SetExpectedResultSize(const uint64 ExpectedSize) {}
 
    virtual uint64 GetExpectedResultSize() const {return 0;}
 
    virtual void SetCompleteNotification(FBackgroundHttpNotificationObjectPtr DownloadCompleteNotificationObject) = 0;
 
    virtual void CompleteWithExistingResponseData(FBackgroundHttpResponsePtr BackgroundResponse) = 0;
 
    virtual FBackgroundHttpRequestCompleteDelegate& OnProcessRequestComplete() = 0;
 
    virtual FBackgroundHttpProgressUpdateDelegate& OnProgressUpdated() = 0;
    
    UE_DEPRECATED(5.7, "IBackgroundHttpRequest::OnRequestMetrics is deprecated, please use IBackgroundHttpRequest::OnRequestMetricsExtended instead.")
    virtual FBackgroundHttpRequestMetricsDelegate& OnRequestMetrics() = 0;
 
    virtual FBackgroundHttpRequestMetricsExtendedDelegate& OnRequestMetricsExtended() = 0;
 
    
    UE_DEPRECATED(5.7, "IBackgroundHttpRequest::SetMetrics is deprecated, please use IBackgroundHttpRequest::SetMetricsExtended instead.")
    virtual void SetMetrics(const int32 TotalBytesDownloaded, const float DownloadDuration) {}
 
    virtual void SetMetricsExtended(const FBackgroundHttpRequestMetricsExtended ExtendedMetrics) {}
 
 
    virtual bool ProcessRequest() = 0;
 
    virtual bool HandleDelayedProcess() = 0;
 
    virtual void CancelRequest() = 0;
 
    virtual void PauseRequest() = 0;
    
    virtual void ResumeRequest() = 0;
    
    virtual const FBackgroundHttpResponsePtr GetResponse() const = 0;
 
    virtual const FString& GetRequestID() const = 0;
 
    virtual void SetRequestID(const FString& NewRequestID) = 0;
 
    virtual EBackgroundHTTPPriority GetRequestPriority() const = 0;
    
    virtual void SetRequestPriority(EBackgroundHTTPPriority NewPriority) = 0;
    
    virtual ~IBackgroundHttpRequest() = default;
 
#if !UE_BUILD_SHIPPING
    virtual void GetDebugText(TArray<FString>& Output) {}
#endif
};