FGenericPlatformBackgroundHttpRequest Class Reference

#include <GenericPlatformBackgroundHttpRequest.h>

Inheritance diagram for FGenericPlatformBackgroundHttpRequest:

Classes
class	FGenericPlatformBackgroundHttpWrapper

Public Member Functions
BACKGROUNDHTTP_API	FGenericPlatformBackgroundHttpRequest ()
virtual BACKGROUNDHTTP_API	~FGenericPlatformBackgroundHttpRequest ()
virtual BACKGROUNDHTTP_API bool	HandleDelayedProcess () override
virtual BACKGROUNDHTTP_API void	CompleteWithExistingResponseData (FBackgroundHttpResponsePtr BackgroundResponse) override
virtual BACKGROUNDHTTP_API void	CancelRequest () 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	PauseRequest () override
virtual BACKGROUNDHTTP_API void	ResumeRequest () 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 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 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
virtual void	GetDebugText (TArray< FString > &Output)
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 Attributes
TUniquePtr< FGenericPlatformBackgroundHttpWrapper >	RequestWrapper
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

Additional Inherited Members
Protected Types inherited from FBackgroundHttpRequestImpl
using	FDownloadMetricsInfo = FBackgroundHttpRequestMetricsExtended
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 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)

Detailed Description

Contains implementation of some common functions that don't vary between implementation

Constructor & Destructor Documentation

FGenericPlatformBackgroundHttpRequest()

FGenericPlatformBackgroundHttpRequest::FGenericPlatformBackgroundHttpRequest

(

)

~FGenericPlatformBackgroundHttpRequest()

FGenericPlatformBackgroundHttpRequest::~FGenericPlatformBackgroundHttpRequest ( )

virtual

Member Function Documentation

CancelRequest()

void FGenericPlatformBackgroundHttpRequest::CancelRequest ( )

overridevirtual

Called to cancel a request that is still being processed

Reimplemented from FBackgroundHttpRequestImpl.

CompleteWithExistingResponseData()

virtual BACKGROUNDHTTP_API void FGenericPlatformBackgroundHttpRequest::CompleteWithExistingResponseData ( FBackgroundHttpResponsePtr  BackgroundResponse )

overridevirtual

Function used to complete an IHttpBackgroundRequest from an external source, passing it in a pre-existing response data.

Parameters

BackgroundReponse,A

SharedRef to the already existing IHttpBackgroundResponse we want to base this tasks' Response off of.

Reimplemented from FBackgroundHttpRequestImpl.

HandleDelayedProcess()

bool FGenericPlatformBackgroundHttpRequest::HandleDelayedProcess ( )

overridevirtual

Called by certain platform's implementation when we have to wait for the BackgroundHttpManager / PlatformBackgroundHttp to do some work before we can finish our ProcessRequest call. Should only be called by different platform layers.

NOTE: Should really only be called by the BackgroundHttpManager! You are probably looking for ProcessRequest.

Returns

if the request was successfully handled.

Reimplemented from FBackgroundHttpRequestImpl.

Member Data Documentation

RequestWrapper

TUniquePtr<FGenericPlatformBackgroundHttpWrapper> FGenericPlatformBackgroundHttpRequest::RequestWrapper

protected

---

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

• Engine/Source/Runtime/Online/BackgroundHTTP/Public/GenericPlatform/GenericPlatformBackgroundHttpRequest.h
• Engine/Source/Runtime/Online/BackgroundHTTP/Private/GenericPlatform/GenericPlatformBackgroundHttpRequest.cpp