AppleHttp.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "GenericPlatform/HttpResponseCommon.h"
#include "GenericPlatform/HttpRequestCommon.h"
#include "PlatformHttp.h"
#include "HttpPackage.h"
#include "Misc/TVariant.h"
 
DECLARE_DELEGATE(FNewAppleHttpEventDelegate);
 
class FAppleHttpRequest : public FHttpRequestCommon
{
public:
    // implementation friends
    friend class FAppleHttpResponse;
 
    //~ Begin IHttpBase Interface
    virtual FString GetHeader(const FString& HeaderName) const override;
    virtual TArray<FString> GetAllHeaders() const override; 
    virtual FString GetContentType() const override;
    virtual uint64 GetContentLength() const override;
    virtual const TArray<uint8>& GetContent() const override;
    //~ End IHttpBase Interface
 
    //~ Begin IHttpRequest Interface
    virtual FString GetVerb() const override;
    virtual void SetVerb(const FString& Verb) override;
    virtual void SetContent(const TArray<uint8>& ContentPayload) override;
    virtual void SetContent(TArray<uint8>&& ContentPayload) override;
    virtual void SetContentAsString(const FString& ContentString) override;
    virtual bool SetContentAsStreamedFile(const FString& Filename) override;
    virtual bool SetContentFromStream(TSharedRef<FArchive> Stream) override;
    virtual void SetHeader(const FString& HeaderName, const FString& HeaderValue) override;
    virtual void AppendToHeader(const FString& HeaderName, const FString& AdditionalHeaderValue) override;
    virtual bool ProcessRequest() override;
    virtual void Tick(float DeltaSeconds) override;
    //~ End IHttpRequest Interface
 
    //~ Begin IHttpRequestThreaded Interface
    virtual bool StartThreadedRequest() override;
    virtual void FinishRequest() override;
    virtual bool IsThreadedRequestComplete() override;
    virtual void TickThreadedRequest(float DeltaSeconds) override;
    //~ End IHttpRequestThreaded Interface
 
    FAppleHttpRequest(NSURLSession* InSession, NSURLSession* InBackgroundSession);
 
    virtual ~FAppleHttpRequest();
 
PACKAGE_SCOPE:
    using FHttpRequestCommon::StartProcessTime;
    using FHttpRequestCommon::ConnectTime;
    using FHttpRequestCommon::BroadcastResponseHeadersReceived;
    using FHttpRequestCommon::StartActivityTimeoutTimer;
    using FHttpRequestCommon::ResetActivityTimeoutTimer;
    using FHttpRequestCommon::StopActivityTimeoutTimer;
    using FHttpRequestCommon::HandleStatusCodeReceived;
    using FHttpRequestCommon::SetEffectiveURL;
    using FHttpRequestCommon::PassReceivedDataToStream;
 
    bool IsInitializedWithValidStream() const;
 
    void HandleResponseHeadersReceived(TMap<FString, FString>&& ResponseHeaders);
    bool HandleResponseBodyDataReceived(uint8* Ptr, uint64 Size);
 
private:
    void CheckProgressDelegate();
 
    virtual bool SetupRequest() override;
 
    virtual FHttpResponsePtr CreateResponse() override;
    virtual void MockResponseData() override;
 
    virtual void AbortRequest() override;
 
    virtual void CleanupRequest() override;
 
private:
    NSMutableURLRequest* Request;
 
    NSURLSession* Session;
    NSURLSession* BackgroundSession;
 
    NSURLSessionTask* Task;
    
    struct FAppleHttpStreamFactory;
    struct FNoStreamSource{};
    struct FInvalidStreamSource{};
    TVariant<FNoStreamSource, FInvalidStreamSource, FString, TSharedRef<FArchive>> StreamedContentSource;
 
    uint64 ContentBytesLength;
 
    mutable TArray<uint8> StorageForGetContent;
 
    int32 LastReportedBytesWritten;
 
    int32 LastReportedBytesRead;
};
 
@class FAppleHttpResponseDelegate;
 
class FAppleHttpResponse : public FHttpResponseCommon
{
public:
    //~ Begin IHttpBase Interface
    virtual TArray<FString> GetAllHeaders() const override; 
    virtual FString GetContentType() const override;
    virtual uint64 GetContentLength() const override;
    //~ End IHttpBase Interface
 
    bool IsReady() const;
 
    const uint64 GetNumBytesReceived() const;
 
    const uint64 GetNumBytesWritten() const;
 
    void CleanSharedObjects();
 
    void SetNewAppleHttpEventDelegate(FNewAppleHttpEventDelegate&& Delegate);
 
    void SetHeaders(TMap<FString, FString>&& InHeaders);
 
    FAppleHttpResponseDelegate* GetResponseDelegate() const;
 
    using FHttpResponseCommon::AppendToPayload;
 
    FAppleHttpResponse(FAppleHttpRequest& InRequest);
 
    virtual ~FAppleHttpResponse();
 
private:
    // implementation friends
    friend class FAppleHttpRequest;
 
    EHttpRequestStatus::Type GetStatusFromDelegate() const;
 
    EHttpFailureReason GetFailureReasonFromDelegate() const;
 
    // Delegate implementation. Keeps the response state and data
    FAppleHttpResponseDelegate* ResponseDelegate;
};