WinHttpConnectionHttp.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#if WITH_WINHTTP
 
#include "CoreMinimal.h"
#include "Containers/StringView.h"
#include "HAL/CriticalSection.h"
 
#include "WinHttp/Support/WinHttpConnection.h"
#include "WinHttp/Support/WinHttpHandle.h"
#include "Interfaces/IHttpRequest.h"
#include "Interfaces/IHttpResponse.h"
 
#include <atomic>
 
class FWinHttpSession;
class FWinHttpRequestContextHttp;
class FRequestPayload;
 
using FStringKeyValueMap = TMap<FString, FString>;
 
DECLARE_DELEGATE_TwoParams(FWinHttpConnectionHttpOnDataTransferred, int32 /*BytesSent*/, int32 /*BytesReceived*/);
DECLARE_DELEGATE_TwoParams(FWinHttpConnectionHttpOnHeaderReceived, const FString& /*HeaderKey*/, const FString& /*HeaderValue*/);
DECLARE_DELEGATE_OneParam(FWinHttpConnectionHttpOnRequestComplete, EHttpRequestStatus::Type /*CompletionStatus*/);
 
class FWinHttpConnectionHttp
    : public IWinHttpConnection
{
public:
    static HTTP_API TSharedPtr<FWinHttpConnectionHttp, ESPMode::ThreadSafe> CreateHttpConnection(
        FWinHttpSession& Session,
        const FString& Verb,
        const FString& Url,
        const TMap<FString, FString>& Headers,
        const TSharedPtr<FRequestPayload, ESPMode::ThreadSafe>& Payload);
 
    HTTP_API virtual ~FWinHttpConnectionHttp();
    FWinHttpConnectionHttp(const FWinHttpConnectionHttp& Other) = delete;
    FWinHttpConnectionHttp(FWinHttpConnectionHttp&& Other) = delete;
    FWinHttpConnectionHttp& operator=(const FWinHttpConnectionHttp& Other) = delete;
    FWinHttpConnectionHttp& operator=(FWinHttpConnectionHttp&& Other) = delete;
 
    //~ Begin IWinHttpConnection Interface
    HTTP_API virtual bool IsValid() const override;
    HTTP_API virtual const FString& GetRequestUrl() const override;
    HTTP_API virtual void* GetHandle() override;
    HTTP_API virtual bool StartRequest() override;
    HTTP_API virtual bool CancelRequest() override;
    HTTP_API virtual bool IsComplete() const override;
    HTTP_API virtual void PumpMessages() override;
    HTTP_API virtual void PumpStates() override;
    //~ End IWinHttpConnection Interface
 
    EHttpResponseCodes::Type GetResponseCode() const { return ResponseCode; }
    TArray<uint8>& GetLastChunk() { return GameThreadChunk; }
    uint64 GetResponseContentLength() const { return ResponseContentLength; }
    const TMap<FString, FString>& GetHeadersReceived() const { return HeadersReceived; }
 
 
    HTTP_API void SetDataTransferredHandler(FWinHttpConnectionHttpOnDataTransferred&& Handler);
    HTTP_API void SetHeaderReceivedHandler(FWinHttpConnectionHttpOnHeaderReceived&& Handler);
    HTTP_API void SetRequestCompletedHandler(FWinHttpConnectionHttpOnRequestComplete&& Handler);
 
protected:
    HTTP_API FWinHttpConnectionHttp(
        FWinHttpSession& Session,
        const FString& Url,
        const FString& Verb,
        const bool bIsSecure,
        const FString& Domain,
        const TOptional<uint16> Port,
        const FString& PathAndQuery,
        const TMap<FString, FString>& Headers,
        const TSharedPtr<FRequestPayload, ESPMode::ThreadSafe>& Payload);
 
 
    HTTP_API bool SetHeaders(const TMap<FString, FString>& Headers);
 
    HTTP_API bool SetHeader(const FString& Key, const FString& Value);
    HTTP_API bool SetPayload(const TSharedRef<FRequestPayload, ESPMode::ThreadSafe>& NewPayload);
 
 
    HTTP_API bool SendRequest();
    HTTP_API void IncrementSentByteCounts(const uint64 AmountSent);
    HTTP_API void IncrementReceivedByteCounts(const uint64 AmountReceived);
    HTTP_API bool HasRequestBodyToSend() const;
    HTTP_API bool SendAdditionalRequestBody();
 
 
    HTTP_API bool RequestResponse();
    HTTP_API bool ProcessResponseHeaders();
    HTTP_API bool RequestNextResponseBodyChunkSize();
    HTTP_API bool RequestNextResponseBodyChunkData();
 
 
    HTTP_API virtual bool FinishRequest(const EHttpRequestStatus::Type FinalState);
 
 
    HTTP_API virtual void HandleConnectedToServer(const wchar_t* ServerIP);
    HTTP_API void HandleSendingRequest();
    HTTP_API void HandleWriteComplete(const uint64 NumBytesSent);
    HTTP_API void HandleSendRequestComplete();
    HTTP_API virtual void HandleHeadersAvailable();
    HTTP_API void HandleDataAvailable(const uint64 NumBytesAvailable);
    HTTP_API void HandleReadComplete(const uint64 NumBytesRead);
    HTTP_API void HandleRequestError(const uint32 ErrorApiId, const uint32 ErrorCode);
    HTTP_API virtual void HandleHandleClosing();
 
private:
    HTTP_API void HandleHttpStatusCallback(HINTERNET ResourceHandle, EWinHttpCallbackStatus Status, void* StatusInformation, uint32 StatusInformationLength);
    
    friend void CALLBACK UE_WinHttpStatusHttpCallback(HINTERNET, DWORD_PTR, DWORD, LPVOID, DWORD);
 
    HTTP_API void ReleasePayloadData();
 
protected:
    mutable FCriticalSection SyncObject;
 
 
    FWinHttpHandle ConnectionHandle;
    FWinHttpHandle RequestHandle;
    TSharedPtr<FWinHttpConnectionHttp, ESPMode::ThreadSafe> KeepAlive;
 
    TOptional<EHttpRequestStatus::Type> FinalState;
    bool bConnectedToServer = false;
    bool bRequestCancelled = false;
    std::atomic<bool> bHasPendingDelegate{false};
 
private:
    FString RequestUrl;
 
    enum class EState : uint8
    {
 
        WaitToStart,
 
 
        SendRequest,
        WaitForSendComplete,
        SendAdditionalRequestBody,
 
 
        RequestResponse,
        WaitForResponseHeaders,
        ProcessResponseHeaders,
 
 
        RequestNextResponseBodyChunkSize,
        WaitForNextResponseBodyChunkSize,
        RequestNextResponseBodyChunkData,
        WaitForNextResponseBodyChunkData,
 
 
        Finished
    };
 
    EState CurrentAction = EState::WaitToStart;
 
 
    TSharedPtr<FRequestPayload, ESPMode::ThreadSafe> Payload;
    uint64 NumBytesSuccessfullySent = 0;
    TArray<uint8> PayloadBuffer;
 
 
    EHttpResponseCodes::Type ResponseCode = EHttpResponseCodes::Unknown;
    TMap<FString, FString> HeadersReceived;
    TArray<uint8> CurrentChunk;
    TArray<uint8> GameThreadChunk;
    uint64 ResponseContentLength = 0;
    uint64 BytesWrittenToGameThreadChunk = 0;
    TOptional<uint64> ResponseBytesAvailable;
    
 
    FWinHttpConnectionHttpOnDataTransferred OnDataTransferredHandler;
    TOptional<uint64> BytesToReportSent;
    TOptional<uint64> BytesToReportReceived;
 
    FWinHttpConnectionHttpOnHeaderReceived OnHeaderReceivedHandler;
    TArray<FString> HeaderKeysToReportReceived;
 
    FWinHttpConnectionHttpOnRequestComplete OnRequestCompleteHandler;
};
 
#endif // WITH_WINHTTP