FHttpRequestImpl Class Reference

#include <HttpRequestImpl.h>

Inheritance diagram for FHttpRequestImpl:

Public Member Functions
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
virtual HTTP_API void	Shutdown ()
Public Member Functions inherited from IHttpRequest
virtual FString	GetVerb () const =0
virtual void	SetVerb (const FString &Verb)=0
virtual void	SetURL (const FString &URL)=0
virtual FString	GetOption (const FName Option) const =0
virtual void	SetOption (const FName Option, const FString &OptionValue)=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
virtual bool	SetResponseBodyReceiveStream (TSharedRef< FArchive > 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 void	SetTimeout (float InTimeoutSecs)=0
virtual void	SetActivityTimeout (float InTimeoutSecs)=0
virtual void	ClearTimeout ()=0
virtual void	ResetTimeoutStatus ()=0
virtual TOptional< float >	GetTimeout () const =0
virtual bool	ProcessRequest ()=0
virtual void	CancelRequest ()=0
virtual const FHttpResponsePtr	GetResponse () const =0
virtual void	Tick (float DeltaSeconds)=0
virtual float	GetElapsedTime () const =0
virtual void	SetDelegateThreadPolicy (EHttpRequestDelegateThreadPolicy InThreadPolicy)=0
virtual EHttpRequestDelegateThreadPolicy	GetDelegateThreadPolicy () const =0
virtual void	ProcessRequestUntilComplete ()=0
virtual void	SetPriority (EHttpRequestPriority InPriority)=0
virtual EHttpRequestPriority	GetPriority () const =0
virtual	~IHttpRequest ()=default
Public Member Functions inherited from IHttpBase
virtual const FString &	GetURL () const =0
virtual const FString &	GetEffectiveURL () const =0
virtual EHttpRequestStatus::Type	GetStatus () const =0
virtual EHttpFailureReason	GetFailureReason () const =0
virtual FString	GetURLParameter (const FString &ParameterName) const =0
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 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
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 implementation

Member Function Documentation

BroadcastResponseHeadersReceived()

void FHttpRequestImpl::BroadcastResponseHeadersReceived ( )

protected

Broadcast all of our response's headers as having been received Used when we don't know when we receive headers in our HTTP implementation

OnHeaderReceived()

FHttpRequestHeaderReceivedDelegate & FHttpRequestImpl::OnHeaderReceived ( )

overridevirtual

Delegate called to signal the receipt of a header. See FHttpRequestHeaderReceivedDelegate

Implements IHttpRequest.

OnProcessRequestComplete()

FHttpRequestCompleteDelegate & FHttpRequestImpl::OnProcessRequestComplete ( )

overridevirtual

Delegate called when the request is complete. See FHttpRequestCompleteDelegate

Implements IHttpRequest.

OnRequestProgress64()

FHttpRequestProgressDelegate64 & FHttpRequestImpl::OnRequestProgress64 ( )

overridevirtual

Delegate called to update the request/response progress. See FHttpRequestProgressDelegate64

Implements IHttpRequest.

OnRequestWillRetry()

FHttpRequestWillRetryDelegate & FHttpRequestImpl::OnRequestWillRetry ( )

overridevirtual

Delegate called when the request will be retried

Implements IHttpRequest.

OnStatusCodeReceived()

FHttpRequestStatusCodeReceivedDelegate & FHttpRequestImpl::OnStatusCodeReceived ( )

overridevirtual

Delegate called to signal the receipt of a header. See FHttpRequestStatusCodeReceivedDelegate

Implements IHttpRequest.

Shutdown()

void FHttpRequestImpl::Shutdown ( )

virtual

Clear callbacks before http module get deleted

Reimplemented in FHttpRequestCommon.

Member Data Documentation

HeaderReceivedDelegate

FHttpRequestHeaderReceivedDelegate FHttpRequestImpl::HeaderReceivedDelegate

protected

Delegate that will get called for each new header received

OnRequestWillRetryDelegate

FHttpRequestWillRetryDelegate FHttpRequestImpl::OnRequestWillRetryDelegate

protected

Delegate that will get called when request will be retried

RequestCompleteDelegate

FHttpRequestCompleteDelegate FHttpRequestImpl::RequestCompleteDelegate

protected

Delegate that will get called once request completes or on any error

RequestProgressDelegate64

FHttpRequestProgressDelegate64 FHttpRequestImpl::RequestProgressDelegate64

protected

Delegate that will get called once per tick with bytes downloaded so far

StatusCodeReceivedDelegate

FHttpRequestStatusCodeReceivedDelegate FHttpRequestImpl::StatusCodeReceivedDelegate

protected

Delegate that will get called when status code received

---

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

• Engine/Source/Runtime/Online/HTTP/Public/GenericPlatform/HttpRequestImpl.h
• Engine/Source/Runtime/Online/HTTP/Private/GenericPlatform/HttpRequestImpl.cpp