IHttpRequest.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Interfaces/IHttpBase.h"
 
class IHttpRequest;
class IHttpResponse;
 
enum class EHttpRequestDelegateThreadPolicy : uint8
{
    CompleteOnGameThread = 0,
    CompleteOnHttpThread,
};
 
enum class EHttpRequestPriority : uint8
{
    Lowest = 0,
    Low,
    Normal,
    High,
    Highest
};
 
class IHttpRequest;
class IHttpResponse;
 
typedef TSharedPtr<IHttpRequest, ESPMode::ThreadSafe> FHttpRequestPtr;
typedef TSharedPtr<IHttpResponse, ESPMode::ThreadSafe> FHttpResponsePtr;
 
typedef TSharedRef<IHttpRequest, ESPMode::ThreadSafe> FHttpRequestRef;
typedef TSharedRef<IHttpResponse, ESPMode::ThreadSafe> FHttpResponseRef;
 
using FHttpRequestCompleteDelegate = TTSDelegate<void(FHttpRequestPtr /*Request*/, FHttpResponsePtr /*Response*/, bool /*bProcessedSuccessfully*/)>;
 
using FHttpRequestStatusCodeReceivedDelegate = TTSDelegate<void(FHttpRequestPtr /*Request*/, int32 /*StatusCode*/)>;
 
using FHttpRequestHeaderReceivedDelegate = TTSDelegate<void(FHttpRequestPtr /*Request*/, const FString& /*HeaderName*/, const FString& /*NewHeaderValue*/)>;
 
using FHttpRequestProgressDelegate = TTSDelegate<void(FHttpRequestPtr /*Request*/, int32 /*BytesSent*/, int32 /*BytesReceived*/)>;
 
using FHttpRequestProgressDelegate64 = TTSDelegate<void(FHttpRequestPtr /*Request*/, uint64 /*BytesSent*/, uint64 /*BytesReceived*/)>;
 
using FHttpRequestWillRetryDelegate = TTSDelegate<void(FHttpRequestPtr /*Request*/, FHttpResponsePtr /*Response*/, float /*SecondsToRetry*/)>;
 
using FHttpRequestStreamDelegate = TTSDelegate<bool(void*/*Ptr*/, int64/*Length*/)>;
 
using FHttpRequestStreamDelegateV2 = TTSDelegate<void(void*/*Ptr*/, int64&/*InOutLength*/)>;
 
class UE_DEPRECATED(5.5, "FArchiveWithDelegate is deprecated and will be moved to internal") FArchiveWithDelegate final : public FArchive
{
public:
    FArchiveWithDelegate(FHttpRequestStreamDelegate InStreamDelegate)
        : StreamDelegate(InStreamDelegate)
    {
    }
 
    virtual void Serialize(void* V, int64 Length) override
    {
        if (!StreamDelegate.IsBound() || !StreamDelegate.Execute(V, Length))
        {
            SetError();
        }
    }
 
private:
    FHttpRequestStreamDelegate StreamDelegate;
};
 
namespace HttpRequestOptions
{
    static const FName HttpVersion("HttpVersion");
    static const FName RequestMode("RequestMode");
#if UE_HTTP_SUPPORT_UNIX_SOCKET
    static const FName UnixSocketPath("UnixSocketPath");
#endif //UE_HTTP_SUPPORT_UNIX_SOCKET
}
 
enum class EHttpRequestMode : uint8
{
    ThreadedRequest,
    ImmediateRequest
};
 
HTTP_API const TCHAR* LexToString(EHttpRequestMode Mode);
 
class IHttpRequest :
    public IHttpBase, public TSharedFromThis<IHttpRequest, ESPMode::ThreadSafe>
{
public:
 
    virtual FString GetVerb() const = 0;
 
    virtual void SetVerb(const FString& Verb) = 0;
 
    virtual void SetURL(const FString& URL) = 0;
 
    virtual FString GetOption(const FName Option) const = 0;
 
    virtual void SetOption(const FName Option, const FString& OptionValue) = 0;
 
    virtual void SetContent(const TArray<uint8>& ContentPayload) = 0;
 
    virtual void SetContent(TArray<uint8>&& ContentPayload) = 0;
 
    virtual void SetContentAsString(const FString& ContentString) = 0;
 
    virtual bool SetContentAsStreamedFile(const FString& Filename) = 0;
 
    virtual bool SetContentFromStream(TSharedRef<FArchive, ESPMode::ThreadSafe> Stream) = 0;
 
    virtual bool SetResponseBodyReceiveStream(TSharedRef<FArchive> Stream) = 0;
 
    HTTP_API bool SetResponseBodyReceiveStreamDelegateV2(FHttpRequestStreamDelegateV2 StreamDelegate);
 
    virtual void SetHeader(const FString& HeaderName, const FString& HeaderValue) = 0;
 
    virtual void AppendToHeader(const FString& HeaderName, const FString& AdditionalHeaderValue) = 0;
 
    virtual void SetTimeout(float InTimeoutSecs) = 0;
 
    virtual void SetActivityTimeout(float InTimeoutSecs) = 0;
 
    virtual void ClearTimeout() = 0;
 
    virtual void ResetTimeoutStatus() = 0;
 
    virtual TOptional<float> GetTimeout() const = 0;
 
    virtual bool ProcessRequest() = 0;
 
    virtual FHttpRequestCompleteDelegate& OnProcessRequestComplete() = 0;
 
    virtual FHttpRequestProgressDelegate64& OnRequestProgress64() = 0;
 
    virtual FHttpRequestWillRetryDelegate& OnRequestWillRetry() = 0;
 
    virtual FHttpRequestHeaderReceivedDelegate& OnHeaderReceived() = 0;
 
    virtual FHttpRequestStatusCodeReceivedDelegate& OnStatusCodeReceived() = 0;
 
    virtual void CancelRequest() = 0;
 
    virtual const FHttpResponsePtr GetResponse() const = 0;
 
    virtual void Tick(float DeltaSeconds) = 0;
 
    virtual float GetElapsedTime() const = 0;
 
    virtual void SetDelegateThreadPolicy(EHttpRequestDelegateThreadPolicy InThreadPolicy) = 0;
 
    virtual EHttpRequestDelegateThreadPolicy GetDelegateThreadPolicy() const = 0;
 
    virtual void ProcessRequestUntilComplete() = 0;
 
    virtual void SetPriority(EHttpRequestPriority InPriority) = 0;
 
    virtual EHttpRequestPriority GetPriority() const = 0;
 
    virtual ~IHttpRequest() = default;
};