HttpRequestCommon.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "GenericPlatform/HttpRequestImpl.h"
#include "GenericPlatform/HttpRequestPayload.h"
 
class FHttpResponseCommon;
class IHttpTaskTimerHandle;
 
class FHttpRequestCommon : public FHttpRequestImpl
{
public:
    FHttpRequestCommon();
 
    // IHttpBase
    HTTP_API virtual FString GetURLParameter(const FString& ParameterName) const override;
 
    // IHttpRequest
    HTTP_API virtual EHttpRequestStatus::Type GetStatus() const override;
    HTTP_API virtual const FString& GetEffectiveURL() const override;
    HTTP_API virtual EHttpFailureReason GetFailureReason() const override;
    HTTP_API virtual void SetDelegateThreadPolicy(EHttpRequestDelegateThreadPolicy InDelegateThreadPolicy) override;
    HTTP_API virtual EHttpRequestDelegateThreadPolicy GetDelegateThreadPolicy() const override;
    HTTP_API virtual FString GetOption(const FName Option) const override;
    HTTP_API virtual void SetOption(const FName Option, const FString & OptionValue) override;
 
    HTTP_API virtual void SetTimeout(float InTimeoutSecs) override;
    HTTP_API virtual void ClearTimeout() override;
    HTTP_API virtual void ResetTimeoutStatus() override;
    HTTP_API virtual TOptional<float> GetTimeout() const override;
    HTTP_API float GetTimeoutOrDefault() const;
 
    HTTP_API virtual void SetActivityTimeout(float InTimeoutSecs) override;
 
    HTTP_API virtual const FHttpResponsePtr GetResponse() const override;
 
    // Can be called on game thread or http thread depend on the delegate thread policy
    virtual void FinishRequest() = 0;
 
    HTTP_API virtual void CancelRequest() override;
 
    HTTP_API virtual void Shutdown() override;
 
    HTTP_API virtual void ProcessRequestUntilComplete() override;
 
    HTTP_API virtual bool SetResponseBodyReceiveStream(TSharedRef<FArchive> Stream) override;
 
    HTTP_API virtual float GetElapsedTime() const override;
 
    virtual bool IsThreadedRequestComplete() = 0;
    virtual bool StartThreadedRequest() = 0;
    virtual void TickThreadedRequest(float DeltaSeconds) = 0;
 
    HTTP_API void StartWaitingInQueue();
    HTTP_API float GetTimeStartedWaitingInQueue() const;
 
    HTTP_API virtual void SetURL(const FString& InURL) override;
    HTTP_API virtual const FString& GetURL() const override;
 
    HTTP_API virtual void SetPriority(EHttpRequestPriority InPriority) override;
    HTTP_API virtual EHttpRequestPriority GetPriority() const override;
 
protected:
    HTTP_API bool PreProcess();
    HTTP_API void PostProcess();
    HTTP_API void PopulateUserAgentHeader();
    virtual bool SetupRequest() = 0;
    HTTP_API bool PreCheck() const;
    HTTP_API virtual void ClearInCaseOfRetry();
 
    HTTP_API void SetStatus(EHttpRequestStatus::Type InCompletionStatus);
    HTTP_API void SetFailureReason(EHttpFailureReason InFailureReason);
 
    HTTP_API void FinishRequestNotInHttpManager();
 
    HTTP_API void HandleRequestSucceed();
    HTTP_API void HandleRequestFailed();
 
    HTTP_API void StartActivityTimeoutTimer();
    HTTP_API void StartActivityTimeoutTimerBy(double DelayToTrigger);
    HTTP_API void ResetActivityTimeoutTimer(FStringView Reason);
    HTTP_API void OnActivityTimeoutTimerTaskTrigger();
    HTTP_API void StopActivityTimeoutTimer();
    HTTP_API void StartTotalTimeoutTimer();
    HTTP_API void StopTotalTimeoutTimer();
    HTTP_API void OnTotalTimeoutTimerTaskTrigger();
 
    virtual void AbortRequest() = 0;
 
    virtual void CleanupRequest() = 0;
 
    HTTP_API void HandleStatusCodeReceived(int32 StatusCode);
    HTTP_API void TriggerStatusCodeReceivedDelegate(int32 StatusCode);
 
    HTTP_API void SetEffectiveURL(const FString& InEffectiveURL);
 
    HTTP_API bool PassReceivedDataToStream(void* Ptr, int64 Length);
    HTTP_API void StopPassingReceivedData();
 
    HTTP_API float GetActivityTimeoutOrDefault() const;
 
    HTTP_API bool SetContentAsStreamedFileDefaultImpl(const FString& Filename);
    HTTP_API bool OpenRequestPayloadDefaultImpl();
    HTTP_API void CloseRequestPayloadDefaultImpl();
 
    HTTP_API void LogFailure() const;
    HTTP_API void LogResponse(const TSharedPtr<IHttpResponse>& InResponse);
    HTTP_API bool TriggerMockResponse();
 
    HTTP_API void InitResponse();
 
    virtual FHttpResponsePtr CreateResponse() = 0;
    // The function for each impl to make sure when mocking response code, the internal state is valid for finishing request successfully
    virtual void MockResponseData() = 0;
 
    void OnFinishRequest(bool bSucceeded);
 
protected:
    EHttpRequestStatus::Type CompletionStatus = EHttpRequestStatus::NotStarted;
 
    EHttpFailureReason FailureReason = EHttpFailureReason::None;
 
    EHttpRequestDelegateThreadPolicy DelegateThreadPolicy = EHttpRequestDelegateThreadPolicy::CompleteOnGameThread;
 
    TOptional<float> TimeoutSecs;
 
    TOptional<float> ActivityTimeoutSecs;
 
    std::atomic<bool> bTimedOut = false;
    std::atomic<bool> bActivityTimedOut = false;
    std::atomic<bool> bCanceled = false;
 
    bool bUsePlatformActivityTimeout = true;
 
    double RequestStartTimeAbsoluteSeconds;
 
    double ActivityTimeoutAt;
 
    TSharedPtr<IHttpTaskTimerHandle> TotalTimeoutHttpTaskTimerHandle;
    TSharedPtr<IHttpTaskTimerHandle> ActivityTimeoutHttpTaskTimerHandle;
    FCriticalSection HttpTaskTimerHandleCriticalSection;
 
    double StartProcessTime = 0.0;
 
    double ConnectTime = -1.0;
 
    FString URL;
 
    FString EffectiveURL;
 
    TSharedPtr<FHttpResponseCommon> ResponseCommon;
 
    TSharedPtr<FArchive> ResponseBodyReceiveStream;
 
    FCriticalSection ResponseBodyReceiveStreamCriticalSection;
 
    // Flag to indicate the request was initialized with stream. In that case even if stream was set to 
    // null later on internally, the request itself won't cache received data anymore
    std::atomic<bool> bInitializedWithValidStream = false;
 
    TUniquePtr<FRequestPayload> RequestPayload;
 
    TMap<const FName, FString> Options;
 
    float ElapsedTime = 0.0f;
 
    float TimeStartedWaitingInQueue = 0.0f;
 
    EHttpRequestPriority Priority = EHttpRequestPriority::Normal;
};