IHttpBase.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
 
namespace EHttpRequestStatus
{
    enum Type
    {
        NotStarted,
        Processing,
        Failed,
        Succeeded
    };
 
    inline const TCHAR* ToString(EHttpRequestStatus::Type EnumVal)
    {
        switch (EnumVal)
        {
            case NotStarted:
            {
                return TEXT("NotStarted");
            }
            case Processing:
            {
                return TEXT("Processing");
            }
            case Failed:
            {
                return TEXT("Failed");
            }
            case Succeeded:
            {
                return TEXT("Succeeded");
            }
        }
        return TEXT("");
    }
 
    inline bool IsFinished(const EHttpRequestStatus::Type Value)
    {
        return Value != NotStarted && Value != Processing;
    }
}
 
enum class EHttpFailureReason : uint8
{
    None = 0,
    ConnectionError,
    Cancelled,
    // This acts differently than the platform timeout. It's the time out of the entire request including 
    // retries, which configured by the user. The platform timeout has different meanings/APIs on different 
    // platforms, such as resolve host timeout, connect timeout, send timeout, receive timeout, entire 
    // request timeout etc. It's not practical to unify to same behavior between them through their APIs. 
    // When user's configured time is up, it's TimedOut no matter which step this Http request is in.
    TimedOut,
    Other
};
 
inline const TCHAR* LexToString(EHttpFailureReason HttpFailureReason)
{
    switch (HttpFailureReason)
    {
    case EHttpFailureReason::None: return TEXT("None");
    case EHttpFailureReason::ConnectionError: return TEXT("ConnectionError");
    case EHttpFailureReason::Cancelled: return TEXT("Cancelled");
    case EHttpFailureReason::TimedOut: return TEXT("TimedOut");
    case EHttpFailureReason::Other: return TEXT("Other");
    default: checkNoEntry(); return TEXT("Invalid");
    }
}
 
class IHttpBase
{
public:
    virtual const FString& GetURL() const = 0;
 
    virtual const FString& GetEffectiveURL() const = 0;
 
    virtual EHttpRequestStatus::Type GetStatus() const = 0;
 
    virtual EHttpFailureReason GetFailureReason() const = 0;
 
    virtual FString GetURLParameter(const FString& ParameterName) const = 0;
 
    virtual FString GetHeader(const FString& HeaderName) const = 0;
 
    virtual TArray<FString> GetAllHeaders() const = 0;
 
    virtual FString GetContentType() const = 0;
 
    virtual uint64 GetContentLength() const = 0;
 
    virtual const TArray<uint8>& GetContent() const = 0;
 
    virtual ~IHttpBase() = default;
};
 
#if !defined(UE_HTTP_CONNECTION_TIMEOUT_SUPPORT_RETRY)
#define UE_HTTP_CONNECTION_TIMEOUT_SUPPORT_RETRY UE_DEPRECATED_MACRO(5.6, "UE_HTTP_CONNECTION_TIMEOUT_SUPPORT_RETRY has been deprecated because it is no longer necessary.") 1
#endif