#include <HttpRequestCommon.h>

Inheritance diagram for FHttpRequestCommon:

Public Member Functions
	FHttpRequestCommon ()

virtual HTTP_API FString	GetURLParameter (const FString &ParameterName) const override

virtual HTTP_API EHttpRequestStatus::Type	GetStatus () const override

virtual HTTP_API const FString &	GetEffectiveURL () const override

virtual HTTP_API EHttpFailureReason	GetFailureReason () const override

virtual HTTP_API void	SetDelegateThreadPolicy (EHttpRequestDelegateThreadPolicy InDelegateThreadPolicy) override

virtual HTTP_API EHttpRequestDelegateThreadPolicy	GetDelegateThreadPolicy () const override

virtual HTTP_API FString	GetOption (const FName Option) const override

virtual HTTP_API void	SetOption (const FName Option, const FString &OptionValue) override

virtual HTTP_API void	SetTimeout (float InTimeoutSecs) override

virtual HTTP_API void	ClearTimeout () override

virtual HTTP_API void	ResetTimeoutStatus () override

virtual HTTP_API TOptional< float >	GetTimeout () const override

HTTP_API float	GetTimeoutOrDefault () const

virtual HTTP_API void	SetActivityTimeout (float InTimeoutSecs) override

virtual HTTP_API const FHttpResponsePtr	GetResponse () const override

virtual void	FinishRequest ()=0

virtual HTTP_API void	CancelRequest () override

virtual HTTP_API void	Shutdown () override

virtual HTTP_API void	ProcessRequestUntilComplete () override

virtual HTTP_API bool	SetResponseBodyReceiveStream (TSharedRef< FArchive > Stream) override

virtual HTTP_API 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

virtual HTTP_API void	SetURL (const FString &InURL) override

virtual HTTP_API const FString &	GetURL () const override

virtual HTTP_API void	SetPriority (EHttpRequestPriority InPriority) override

virtual HTTP_API EHttpRequestPriority	GetPriority () const override

Public Member Functions inherited from FHttpRequestImpl
virtual HTTP_API FHttpRequestCompleteDelegate &	OnProcessRequestComplete () override

virtual HTTP_API FHttpRequestProgressDelegate64 &	OnRequestProgress64 () override

virtual HTTP_API FHttpRequestStatusCodeReceivedDelegate &	OnStatusCodeReceived () override

virtual HTTP_API FHttpRequestHeaderReceivedDelegate &	OnHeaderReceived () override

virtual HTTP_API FHttpRequestWillRetryDelegate &	OnRequestWillRetry () override

Public Member Functions inherited from IHttpRequest
virtual FString	GetVerb () const =0

virtual void	SetVerb (const FString &Verb)=0

virtual void	SetContent (const TArray< uint8 > &ContentPayload)=0

virtual void	SetContent (TArray< uint8 > &&ContentPayload)=0

virtual void	SetContentAsString (const FString &ContentString)=0

virtual bool	SetContentAsStreamedFile (const FString &Filename)=0

virtual bool	SetContentFromStream (TSharedRef< FArchive, ESPMode::ThreadSafe > Stream)=0

HTTP_API bool	SetResponseBodyReceiveStreamDelegateV2 (FHttpRequestStreamDelegateV2 StreamDelegate)

virtual void	SetHeader (const FString &HeaderName, const FString &HeaderValue)=0

virtual void	AppendToHeader (const FString &HeaderName, const FString &AdditionalHeaderValue)=0

virtual bool	ProcessRequest ()=0

virtual void	Tick (float DeltaSeconds)=0

virtual	~IHttpRequest ()=default

Public Member Functions inherited from IHttpBase
virtual FString	GetHeader (const FString &HeaderName) const =0

virtual TArray< FString >	GetAllHeaders () const =0

virtual FString	GetContentType () const =0

virtual uint64	GetContentLength () const =0

virtual const TArray< uint8 > &	GetContent () const =0

virtual	~IHttpBase ()=default

Public Member Functions inherited from TSharedFromThis< IHttpRequest, ESPMode::ThreadSafe >
TSharedRef< IHttpRequest, Mode >	AsShared ()

TSharedRef< IHttpRequest const, Mode >	AsShared () const

TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const

TWeakPtr< IHttpRequest, Mode >	AsWeak ()

TWeakPtr< IHttpRequest 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
HTTP_API bool	PreProcess ()

HTTP_API void	PostProcess ()

HTTP_API void	PopulateUserAgentHeader ()

virtual bool	SetupRequest ()=0

HTTP_API bool	PreCheck () const

virtual HTTP_API 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

virtual void	MockResponseData ()=0

void	OnFinishRequest (bool bSucceeded)

Protected Member Functions inherited from FHttpRequestImpl
HTTP_API void	BroadcastResponseHeadersReceived ()

Protected Member Functions inherited from TSharedFromThis< IHttpRequest, ESPMode::ThreadSafe >
	TSharedFromThis ()

	TSharedFromThis (TSharedFromThis const &)

UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)

	~TSharedFromThis ()

Protected Attributes
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

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

Protected Attributes inherited from FHttpRequestImpl
FHttpRequestCompleteDelegate	RequestCompleteDelegate

FHttpRequestProgressDelegate64	RequestProgressDelegate64

FHttpRequestStatusCodeReceivedDelegate	StatusCodeReceivedDelegate

FHttpRequestHeaderReceivedDelegate	HeaderReceivedDelegate

FHttpRequestWillRetryDelegate	OnRequestWillRetryDelegate

Additional Inherited Members
Static Protected Member Functions inherited from TSharedFromThis< IHttpRequest, 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 implementations of different platforms

Constructor & Destructor Documentation

◆ FHttpRequestCommon()

FHttpRequestCommon::FHttpRequestCommon ( )

Member Function Documentation

◆ AbortRequest()

virtual void FHttpRequestCommon::AbortRequest ( )

protectedpure virtual

◆ CancelRequest()

void FHttpRequestCommon::CancelRequest ( )

overridevirtual

Called to cancel a request that is still being processed

Implements IHttpRequest.

◆ CleanupRequest()

virtual void FHttpRequestCommon::CleanupRequest ( )

protectedpure virtual

◆ ClearInCaseOfRetry()

void FHttpRequestCommon::ClearInCaseOfRetry ( )

protectedvirtual

◆ ClearTimeout()

void FHttpRequestCommon::ClearTimeout ( )

overridevirtual

Clears the optional timeout in seconds for this HTTP request, causing the default value from FHttpModule::GetTimeout() to be used.

Implements IHttpRequest.

◆ CloseRequestPayloadDefaultImpl()

void FHttpRequestCommon::CloseRequestPayloadDefaultImpl ( )

protected

◆ CreateResponse()

virtual FHttpResponsePtr FHttpRequestCommon::CreateResponse ( )

protectedpure virtual

◆ FinishRequest()

virtual void FHttpRequestCommon::FinishRequest ( )

pure virtual

Implemented in FAppleHttpRequest.

◆ FinishRequestNotInHttpManager()

void FHttpRequestCommon::FinishRequestNotInHttpManager ( )

protected

Finish the request when it's not in http manager

◆ GetActivityTimeoutOrDefault()

float FHttpRequestCommon::GetActivityTimeoutOrDefault ( ) const

protected

◆ GetDelegateThreadPolicy()

EHttpRequestDelegateThreadPolicy FHttpRequestCommon::GetDelegateThreadPolicy ( ) const

overridevirtual

Get thread policy about which thread to complete this request

Returns: The thread policy

Implements IHttpRequest.

◆ GetEffectiveURL()

const FString & FHttpRequestCommon::GetEffectiveURL ( ) const

overridevirtual

Get the effective URL in case of redirected. If not redirected, it's the same as GetURL

Returns: the effective URL string.

Implements IHttpBase.

◆ GetElapsedTime()

float FHttpRequestCommon::GetElapsedTime ( ) const

overridevirtual

Gets the time that it took for the server to fully respond to the request.

Returns: elapsed time in seconds.

Implements IHttpRequest.

◆ GetFailureReason()

EHttpFailureReason FHttpRequestCommon::GetFailureReason ( ) const

overridevirtual

Get the reason of th failure if GetStatus returns Failed

Returns: the reason of the failure

Implements IHttpBase.

◆ GetOption()

FString FHttpRequestCommon::GetOption ( const FName Option ) const

overridevirtual

Get the current value for the given option

Returns: the current value set for this option or an empty string if no value has been specified

Implements IHttpRequest.

◆ GetPriority()

EHttpRequestPriority FHttpRequestCommon::GetPriority ( ) const

overridevirtual

Get request priority, which is used to decide the position in the queue when max concurrent limit reached

Returns: The request priority

Implements IHttpRequest.

◆ GetResponse()

const FHttpResponsePtr FHttpRequestCommon::GetResponse ( ) const

overridevirtual

Get the associated Response

Returns: the response

Implements IHttpRequest.

◆ GetStatus()

EHttpRequestStatus::Type FHttpRequestCommon::GetStatus ( ) const

overridevirtual

Get the current status of the request being processed

Returns: the current status

Implements IHttpBase.

◆ GetTimeout()

TOptional< float > FHttpRequestCommon::GetTimeout ( ) const

overridevirtual

Gets the optional timeout in seconds for this entire HTTP request to complete. If valid, this value overrides the default HTTP timeout set via FHttpModule::SetTimeout().

Returns: the timeout for this HTTP request instance, in seconds

Implements IHttpRequest.

◆ GetTimeoutOrDefault()

float FHttpRequestCommon::GetTimeoutOrDefault ( ) const

◆ GetTimeStartedWaitingInQueue()

float FHttpRequestCommon::GetTimeStartedWaitingInQueue ( ) const

◆ GetURL()

const FString & FHttpRequestCommon::GetURL ( ) const

overridevirtual

Get the URL used to send the request.

Returns: the URL string.

Implements IHttpBase.

◆ GetURLParameter()

FString FHttpRequestCommon::GetURLParameter ( const FString & ParameterName ) const

overridevirtual

Gets an URL parameter. expected format is ?Key=Value&Key=Value... If that format is not used, this function will not work.

Parameters

ParameterName - the parameter to request.

Returns: the parameter value string.

Implements IHttpBase.

◆ HandleRequestFailed()

void FHttpRequestCommon::HandleRequestFailed ( )

protected

◆ HandleRequestSucceed()

void FHttpRequestCommon::HandleRequestSucceed ( )

protected

◆ HandleStatusCodeReceived()

void FHttpRequestCommon::HandleStatusCodeReceived ( int32 StatusCode )

protected

◆ InitResponse()

void FHttpRequestCommon::InitResponse ( )

protected

◆ IsThreadedRequestComplete()

virtual bool FHttpRequestCommon::IsThreadedRequestComplete ( )

pure virtual

Implemented in FAppleHttpRequest.

◆ LogFailure()

void FHttpRequestCommon::LogFailure ( ) const

protected

◆ LogResponse()

void FHttpRequestCommon::LogResponse ( const TSharedPtr< IHttpResponse > & InResponse )

protected

◆ MockResponseData()

virtual void FHttpRequestCommon::MockResponseData ( )

protectedpure virtual

◆ OnActivityTimeoutTimerTaskTrigger()

void FHttpRequestCommon::OnActivityTimeoutTimerTaskTrigger ( )

protected

◆ OnFinishRequest()

void FHttpRequestCommon::OnFinishRequest ( bool bSucceeded )

protected

◆ OnTotalTimeoutTimerTaskTrigger()

void FHttpRequestCommon::OnTotalTimeoutTimerTaskTrigger ( )

protected

◆ OpenRequestPayloadDefaultImpl()

bool FHttpRequestCommon::OpenRequestPayloadDefaultImpl ( )

protected

◆ PassReceivedDataToStream()

bool FHttpRequestCommon::PassReceivedDataToStream	(	void *	Ptr,
		int64	Length
	)

protected

◆ PopulateUserAgentHeader()

void FHttpRequestCommon::PopulateUserAgentHeader ( )

protected

◆ PostProcess()

void FHttpRequestCommon::PostProcess ( )

protected

◆ PreCheck()

bool FHttpRequestCommon::PreCheck ( ) const

protected

◆ PreProcess()

bool FHttpRequestCommon::PreProcess ( )

protected

Check if this request is valid or allowed, before actually process the request

◆ ProcessRequestUntilComplete()

void FHttpRequestCommon::ProcessRequestUntilComplete ( )

overridevirtual

Blocking call to wait the request until it's completed

WARNINGS:

This is a blocking call, DON'T use this in a time-sensitive context
Complete delegate will be used in this function so customized complete delegate is not supported
This will force the usage of EHttpRequestDelegateThreadPolicy::CompleteOnHttpThread to make sure the request can complete, when this function get called from main thread. So if any other delegate is bound, make sure the bound delegate can handle the custom logic in a thread-safe way

Implements IHttpRequest.

◆ ResetActivityTimeoutTimer()

void FHttpRequestCommon::ResetActivityTimeoutTimer ( FStringView Reason )

protected

◆ ResetTimeoutStatus()

void FHttpRequestCommon::ResetTimeoutStatus ( )

overridevirtual

Reset the elapsed timeout duration and flag, after the request completed and need to be reused

Implements IHttpRequest.

◆ SetActivityTimeout()

void FHttpRequestCommon::SetActivityTimeout ( float InTimeoutSecs )

overridevirtual

Sets an optional activity timeout in seconds for this HTTP request. After connecting to web server, if there is no activity(send or receive) happen for this time period, it will trigger activity timeout If set, this value overrides the default HTTP activity timeout

Parameters

InTimeoutSecs - Timeout for this HTTP request instance, in seconds

Implements IHttpRequest.

◆ SetContentAsStreamedFileDefaultImpl()

bool FHttpRequestCommon::SetContentAsStreamedFileDefaultImpl ( const FString & Filename )

protected

◆ SetDelegateThreadPolicy()

void FHttpRequestCommon::SetDelegateThreadPolicy ( EHttpRequestDelegateThreadPolicy InThreadPolicy )

overridevirtual

Set thread policy about which thread to trigger the delegates, set by FHttpManager::SetRequestCompletedDelegate, IHttpRequest::OnStatusCodeReceived, IHttpRequest::OnHeaderReceived, IHttpRequest::OnRequestProgress64 and IHttpRequest::OnProcessRequestComplete.

Note that when set it as CompleteOnHttpThread, the thread to trigger delegates could be any thread depends on the implementation. User code should make the delegate thread-safe and shouldn't assume it's triggered by the thread where this request get created.

Parameters

InThreadPolicy - The thread policy to indicate which thread to trigger the delegates

Implements IHttpRequest.

◆ SetEffectiveURL()

void FHttpRequestCommon::SetEffectiveURL ( const FString & InEffectiveURL )

protected

◆ SetFailureReason()

void FHttpRequestCommon::SetFailureReason ( EHttpFailureReason InFailureReason )

protected

◆ SetOption()

void FHttpRequestCommon::SetOption	(	const FName	Option,
		const FString &	OptionValue
	)

overridevirtual

Sets the given option for this Request Must be set before calling ProcessRequest.

Parameters

Option	- The option to set, see 'HttpRequestOptions' for supported options
OptionValue	- The value of the option to set

Implements IHttpRequest.

◆ SetPriority()

void FHttpRequestCommon::SetPriority ( EHttpRequestPriority InPriority )

overridevirtual

Set priority of the request, which will be used to decide the position in the queue when max concurrent limit reached

Parameters

InHttpRequestPriority - The priority to set

Implements IHttpRequest.

◆ SetResponseBodyReceiveStream()

bool FHttpRequestCommon::SetResponseBodyReceiveStream ( TSharedRef< FArchive > Stream )

overridevirtual

Sets the stream to receive the response body. Make sure to handle the cleanup of stream when Serialize generated error(Stream->GetError returns true after Stream->Serialize call), this http request will fail and quit.

NOTE: Once set, the data will no longer be cached in response, IHttpResponse::GetContent() and IHttpResponse::GetContentAsString() will return empty result. The Stream->Serialize will be called from another thread other than the game thread

Parameters

Stream - will be used to receive the response body

Returns: True if the stream can be used. False otherwise.

Implements IHttpRequest.

◆ SetStatus()

void FHttpRequestCommon::SetStatus ( EHttpRequestStatus::Type InCompletionStatus )

protected

◆ SetTimeout()

void FHttpRequestCommon::SetTimeout ( float InTimeoutSecs )

overridevirtual

Sets an optional timeout in seconds for this entire HTTP request to complete. If set, this value overrides the default HTTP timeout set via FHttpModule::SetTimeout().

Parameters

InTimeoutSecs - Timeout for this HTTP request instance, in seconds

Implements IHttpRequest.

◆ SetupRequest()

virtual bool FHttpRequestCommon::SetupRequest ( )

protectedpure virtual

◆ SetURL()

void FHttpRequestCommon::SetURL ( const FString & URL )

overridevirtual

Sets the URL for the request Eg. (http://my.domain.com/something.ext?key=value&key2=value). Must be set before calling ProcessRequest.

Parameters

URL	- URL to use.

Implements IHttpRequest.

◆ Shutdown()

void FHttpRequestCommon::Shutdown ( )

overridevirtual

Clear callbacks before http module get deleted

Reimplemented from FHttpRequestImpl.

◆ StartActivityTimeoutTimer()

void FHttpRequestCommon::StartActivityTimeoutTimer ( )

protected

◆ StartActivityTimeoutTimerBy()

void FHttpRequestCommon::StartActivityTimeoutTimerBy ( double DelayToTrigger )

protected

◆ StartThreadedRequest()

virtual bool FHttpRequestCommon::StartThreadedRequest ( )

pure virtual

Implemented in FAppleHttpRequest.

◆ StartTotalTimeoutTimer()

void FHttpRequestCommon::StartTotalTimeoutTimer ( )

protected

◆ StartWaitingInQueue()

void FHttpRequestCommon::StartWaitingInQueue ( )

◆ StopActivityTimeoutTimer()

void FHttpRequestCommon::StopActivityTimeoutTimer ( )

protected

◆ StopPassingReceivedData()

void FHttpRequestCommon::StopPassingReceivedData ( )

protected

◆ StopTotalTimeoutTimer()

void FHttpRequestCommon::StopTotalTimeoutTimer ( )

protected

◆ TickThreadedRequest()

virtual void FHttpRequestCommon::TickThreadedRequest ( float DeltaSeconds )

pure virtual

Implemented in FAppleHttpRequest.

◆ TriggerMockResponse()

bool FHttpRequestCommon::TriggerMockResponse ( )

protected

◆ TriggerStatusCodeReceivedDelegate()

void FHttpRequestCommon::TriggerStatusCodeReceivedDelegate ( int32 StatusCode )

protected

Member Data Documentation

◆ ActivityTimeoutAt

double FHttpRequestCommon::ActivityTimeoutAt

protected

Record when this request will activity timeout

◆ ActivityTimeoutHttpTaskTimerHandle

TSharedPtr<IHttpTaskTimerHandle> FHttpRequestCommon::ActivityTimeoutHttpTaskTimerHandle

protected

Holder the timer handle, if the request get destroyed before triggering the timeout, use this to remove the timer

◆ ActivityTimeoutSecs

TOptional<float> FHttpRequestCommon::ActivityTimeoutSecs

protected

Timeout in seconds for the HTTP request activity timeout

◆ bActivityTimedOut

std::atomic<bool> FHttpRequestCommon::bActivityTimedOut = false

protected

Indicate the request is activity timed out, it should quit and fail with EHttpFailureReason::ConnectionError

◆ bCanceled

std::atomic<bool> FHttpRequestCommon::bCanceled = false

protected

Indicate the request is cancelled, it should quit and fail with EHttpFailureReason::Cancelled

◆ bInitializedWithValidStream

std::atomic<bool> FHttpRequestCommon::bInitializedWithValidStream = false

protected

◆ bTimedOut

std::atomic<bool> FHttpRequestCommon::bTimedOut = false

protected

Indicate the request is timed out, it should quit and fail with EHttpFailureReason::TimedOut

◆ bUsePlatformActivityTimeout

bool FHttpRequestCommon::bUsePlatformActivityTimeout = true

protected

TODO: Move this feature into CurlHttp

◆ CompletionStatus

EHttpRequestStatus::Type FHttpRequestCommon::CompletionStatus = EHttpRequestStatus::NotStarted

protected

Current status of request being processed

◆ ConnectTime

double FHttpRequestCommon::ConnectTime = -1.0

protected

Record how long it take to connect to the endpoint

◆ DelegateThreadPolicy

EHttpRequestDelegateThreadPolicy FHttpRequestCommon::DelegateThreadPolicy = EHttpRequestDelegateThreadPolicy::CompleteOnGameThread

protected

Thread policy about which thread to complete this request

◆ EffectiveURL

FString FHttpRequestCommon::EffectiveURL

protected

Cache the effective URL. When redirected, it will be different with original URL

◆ ElapsedTime

float FHttpRequestCommon::ElapsedTime = 0.0f

protected

Total elapsed time in seconds since the start of the request

◆ FailureReason

EHttpFailureReason FHttpRequestCommon::FailureReason = EHttpFailureReason::None

protected

Reason of failure of the HTTP request

◆ HttpTaskTimerHandleCriticalSection

FCriticalSection FHttpRequestCommon::HttpTaskTimerHandleCriticalSection

protected

Critical section for accessing HttpTaskTimerHandle

◆ Options

TMap<const FName, FString> FHttpRequestCommon::Options

protected

Options for this request.

◆ Priority

EHttpRequestPriority FHttpRequestCommon::Priority = EHttpRequestPriority::Normal

protected

◆ RequestPayload

TUniquePtr<FRequestPayload> FHttpRequestCommon::RequestPayload

protected

Payload to use with the request. Typically for POST, PUT, or PATCH

◆ RequestStartTimeAbsoluteSeconds

double FHttpRequestCommon::RequestStartTimeAbsoluteSeconds

protected

Record when this request started

◆ ResponseBodyReceiveStream

TSharedPtr<FArchive> FHttpRequestCommon::ResponseBodyReceiveStream

protected

The stream to receive response body

◆ ResponseBodyReceiveStreamCriticalSection

FCriticalSection FHttpRequestCommon::ResponseBodyReceiveStreamCriticalSection

protected

Critical section for accessing ResponseBodyReceiveStream

◆ ResponseCommon

TSharedPtr<FHttpResponseCommon> FHttpRequestCommon::ResponseCommon

protected

The response object which we will use to pair with this request

◆ StartProcessTime

double FHttpRequestCommon::StartProcessTime = 0.0

protected

Record when the request start to process

◆ TimeoutSecs

TOptional<float> FHttpRequestCommon::TimeoutSecs

protected

Timeout in seconds for the entire HTTP request to complete

◆ TimeStartedWaitingInQueue

float FHttpRequestCommon::TimeStartedWaitingInQueue = 0.0f

protected

Record the time started to wait in the queue

◆ TotalTimeoutHttpTaskTimerHandle

TSharedPtr<IHttpTaskTimerHandle> FHttpRequestCommon::TotalTimeoutHttpTaskTimerHandle

protected

Holder the timer handle, if the request get destroyed before triggering the timeout, use this to remove the timer

◆ URL

FString FHttpRequestCommon::URL

protected

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

Engine/Source/Runtime/Online/HTTP/Private/GenericPlatform/HttpRequestCommon.h
Engine/Source/Runtime/Online/HTTP/Private/GenericPlatform/HttpRequestCommon.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FHttpRequestCommon()

Member Function Documentation

◆ AbortRequest()

◆ CancelRequest()

◆ CleanupRequest()

◆ ClearInCaseOfRetry()

◆ ClearTimeout()

◆ CloseRequestPayloadDefaultImpl()

◆ CreateResponse()

◆ FinishRequest()

◆ FinishRequestNotInHttpManager()

◆ GetActivityTimeoutOrDefault()

◆ GetDelegateThreadPolicy()

◆ GetEffectiveURL()

◆ GetElapsedTime()

◆ GetFailureReason()

◆ GetOption()

◆ GetPriority()

◆ GetResponse()

◆ GetStatus()

◆ GetTimeout()

◆ GetTimeoutOrDefault()

◆ GetTimeStartedWaitingInQueue()

◆ GetURL()

◆ GetURLParameter()

◆ HandleRequestFailed()

◆ HandleRequestSucceed()

◆ HandleStatusCodeReceived()

◆ InitResponse()

◆ IsThreadedRequestComplete()

◆ LogFailure()

◆ LogResponse()

◆ MockResponseData()

◆ OnActivityTimeoutTimerTaskTrigger()

◆ OnFinishRequest()

◆ OnTotalTimeoutTimerTaskTrigger()

◆ OpenRequestPayloadDefaultImpl()

◆ PassReceivedDataToStream()

◆ PopulateUserAgentHeader()

◆ PostProcess()

◆ PreCheck()

◆ PreProcess()

◆ ProcessRequestUntilComplete()

◆ ResetActivityTimeoutTimer()

◆ ResetTimeoutStatus()

◆ SetActivityTimeout()

◆ SetContentAsStreamedFileDefaultImpl()

◆ SetDelegateThreadPolicy()

◆ SetEffectiveURL()

◆ SetFailureReason()

◆ SetOption()

◆ SetPriority()

◆ SetResponseBodyReceiveStream()

◆ SetStatus()

◆ SetTimeout()

◆ SetupRequest()

◆ SetURL()

◆ Shutdown()

◆ StartActivityTimeoutTimer()

◆ StartActivityTimeoutTimerBy()

◆ StartThreadedRequest()

◆ StartTotalTimeoutTimer()

◆ StartWaitingInQueue()

◆ StopActivityTimeoutTimer()

◆ StopPassingReceivedData()

◆ StopTotalTimeoutTimer()

◆ TickThreadedRequest()

◆ TriggerMockResponse()

◆ TriggerStatusCodeReceivedDelegate()

Member Data Documentation

◆ ActivityTimeoutAt

◆ ActivityTimeoutHttpTaskTimerHandle

◆ ActivityTimeoutSecs

◆ bActivityTimedOut