UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Friends | List of all members
FApplePlatformBackgroundHttpRequest Class Reference

#include <ApplePlatformBackgroundHttpRequest.h>

+ Inheritance diagram for FApplePlatformBackgroundHttpRequest:

Public Member Functions

 FApplePlatformBackgroundHttpRequest ()
 
virtual ~FApplePlatformBackgroundHttpRequest ()=default
 
virtual void PauseRequest () override
 
virtual void ResumeRequest () override
 
virtual void GetDebugText (TArray< FString > &Output) override
 
- Public Member Functions inherited from FBackgroundHttpRequestImpl
BACKGROUNDHTTP_API FBackgroundHttpRequestImpl ()
 
virtual ~FBackgroundHttpRequestImpl ()
 
virtual BACKGROUNDHTTP_API void OnBackgroundDownloadComplete ()
 
virtual BACKGROUNDHTTP_API bool ProcessRequest () override
 
virtual BACKGROUNDHTTP_API void CancelRequest () override
 
virtual BACKGROUNDHTTP_API void SetURLAsList (const TArray< FString > &URLs, int NumRetriesToAttempt) override
 
virtual BACKGROUNDHTTP_API const TArray< FString > & GetURLList () const override
 
virtual BACKGROUNDHTTP_API void SetExpectedResultSize (const uint64 ExpectedSize) override
 
virtual BACKGROUNDHTTP_API uint64 GetExpectedResultSize () const override
 
virtual BACKGROUNDHTTP_API void SetCompleteNotification (FBackgroundHttpNotificationObjectPtr DownloadCompleteNotificationObjectIn) override
 
virtual BACKGROUNDHTTP_API void CompleteWithExistingResponseData (FBackgroundHttpResponsePtr BackgroundResponse) override
 
virtual BACKGROUNDHTTP_API FBackgroundHttpRequestCompleteDelegate & OnProcessRequestComplete () override
 
virtual BACKGROUNDHTTP_API FBackgroundHttpProgressUpdateDelegate & OnProgressUpdated () override
 
virtual BACKGROUNDHTTP_API FBackgroundHttpRequestMetricsDelegate & OnRequestMetrics () override
 
virtual BACKGROUNDHTTP_API FBackgroundHttpRequestMetricsExtendedDelegate & OnRequestMetricsExtended () override
 
virtual BACKGROUNDHTTP_API const FBackgroundHttpResponsePtr GetResponse () const override
 
virtual BACKGROUNDHTTP_API const FString & GetRequestID () const override
 
virtual BACKGROUNDHTTP_API void SetRequestID (const FString &NewRequestID) override
 
virtual BACKGROUNDHTTP_API bool HandleDelayedProcess () override
 
virtual BACKGROUNDHTTP_API EBackgroundHTTPPriority GetRequestPriority () const override
 
virtual BACKGROUNDHTTP_API void SetRequestPriority (EBackgroundHTTPPriority NewPriority) override
 
virtual BACKGROUNDHTTP_API void NotifyNotificationObjectOfComplete (const bool bWasSuccess)
 
virtual BACKGROUNDHTTP_API void NotifyRequestMetricsAvailable (const int32 TotalBytesDownloaded, const float DownloadDuration)
 
virtual BACKGROUNDHTTP_API void NotifyRequestMetricsExtendedAvailable (const FBackgroundHttpRequestMetricsExtended ExtendedMetrics)
 
virtual BACKGROUNDHTTP_API void SetMetrics (const int32 TotalBytesDownloaded, const float DownloadDuration) override
 
virtual BACKGROUNDHTTP_API void SetMetricsExtended (const FBackgroundHttpRequestMetricsExtended ExtendedMetrics) override
 
- Public Member Functions inherited from IBackgroundHttpRequest
virtual ~IBackgroundHttpRequest ()=default
 
- Public Member Functions inherited from TSharedFromThis< IBackgroundHttpRequest, ESPMode::ThreadSafe >
TSharedRef< IBackgroundHttpRequest, Mode > AsShared ()
 
TSharedRef< IBackgroundHttpRequest const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< IBackgroundHttpRequest, Mode > AsWeak ()
 
TWeakPtr< IBackgroundHttpRequest const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 

Protected Member Functions

void SetInternalDownloadId (uint64 Id)
 
uint64 GetInternalDownloadId () const
 
void UpdateProgress ()
 
float GetNSURLSessionPriority () const
 
- Protected Member Functions inherited from TSharedFromThis< IBackgroundHttpRequest, ESPMode::ThreadSafe >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThis & operator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 

Static Protected Member Functions

static float BackgroundRequestPriorityToNSURLSessionPriority (const EBackgroundHTTPPriority Priority)
 
- Static Protected Member Functions inherited from TSharedFromThis< IBackgroundHttpRequest, ESPMode::ThreadSafe >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 

Friends

class FApplePlatformBackgroundHttpManager
 

Additional Inherited Members

- Protected Types inherited from FBackgroundHttpRequestImpl
using FDownloadMetricsInfo = FBackgroundHttpRequestMetricsExtended
 
- Protected Attributes inherited from FBackgroundHttpRequestImpl
UE::FMutex DownloadCompleteMutex
 
TSharedPtr< FBackgroundHttpNotificationObject, ESPMode::ThreadSafe > DownloadCompleteNotificationObject
 
FBackgroundHttpResponsePtr Response
 
TArray< FString > URLList
 
FString RequestID
 
int NumberOfTotalRetries
 
EBackgroundHTTPPriority RequestPriority
 
uint64 ExpectedResultSize
 
TOptional< FDownloadMetricsInfo > OptionalMetricsInfo
 
FBackgroundHttpRequestCompleteDelegate HttpRequestCompleteDelegate
 
FBackgroundHttpProgressUpdateDelegate HttpProgressUpdateDelegate
 
FBackgroundHttpRequestMetricsDelegate HttpRequestMetricsDelegate
 
FBackgroundHttpRequestMetricsExtendedDelegate HttpRequestMetricsExtendedDelegate
 

Detailed Description

Contains implementation of Apple specific background http requests

Constructor & Destructor Documentation

◆ FApplePlatformBackgroundHttpRequest()

FApplePlatformBackgroundHttpRequest::FApplePlatformBackgroundHttpRequest ( )

◆ ~FApplePlatformBackgroundHttpRequest()

virtual FApplePlatformBackgroundHttpRequest::~FApplePlatformBackgroundHttpRequest ( )
virtualdefault

Member Function Documentation

◆ BackgroundRequestPriorityToNSURLSessionPriority()

float FApplePlatformBackgroundHttpRequest::BackgroundRequestPriorityToNSURLSessionPriority ( const EBackgroundHTTPPriority  Priority)
staticprotected

◆ GetDebugText()

void FApplePlatformBackgroundHttpRequest::GetDebugText ( TArray< FString > &  Output)
overridevirtual

Returns debug text for download screen to help troubleshoot download issues

Reimplemented from IBackgroundHttpRequest.

◆ GetInternalDownloadId()

uint64 FApplePlatformBackgroundHttpRequest::GetInternalDownloadId ( ) const
inlineprotected

◆ GetNSURLSessionPriority()

float FApplePlatformBackgroundHttpRequest::GetNSURLSessionPriority ( ) const
inlineprotected

◆ PauseRequest()

void FApplePlatformBackgroundHttpRequest::PauseRequest ( )
overridevirtual

Called to pause a request that is still being processed

Reimplemented from FBackgroundHttpRequestImpl.

◆ ResumeRequest()

void FApplePlatformBackgroundHttpRequest::ResumeRequest ( )
overridevirtual

Called to resume a request that was previously paused

Reimplemented from FBackgroundHttpRequestImpl.

◆ SetInternalDownloadId()

void FApplePlatformBackgroundHttpRequest::SetInternalDownloadId ( uint64  Id)
inlineprotected

◆ UpdateProgress()

void FApplePlatformBackgroundHttpRequest::UpdateProgress ( )
protected

Friends And Related Symbol Documentation

◆ FApplePlatformBackgroundHttpManager

friend class FApplePlatformBackgroundHttpManager
friend
The documentation for this class was generated from the following files: