FTransactionallySafeHttpRequest Class Reference

#include <TransactionallySafeHttpRequest.h>

Inheritance diagram for FTransactionallySafeHttpRequest:

Classes
class	FClosedHttpRequest

Public Member Functions
	FTransactionallySafeHttpRequest ()
virtual	~FTransactionallySafeHttpRequest ()=default
const FString &	GetURL () const override
FString	GetURLParameter (const FString &ParameterName) const override
FString	GetHeader (const FString &HeaderName) const override
TArray< FString >	GetAllHeaders () const override
FString	GetContentType () const override
uint64	GetContentLength () const override
const TArray< uint8 > &	GetContent () const override
FString	GetVerb () const override
void	SetVerb (const FString &InVerb) override
void	SetURL (const FString &InURL) override
FString	GetOption (const FName Option) const override
void	SetOption (const FName Option, const FString &OptionValue) override
void	SetContent (const TArray< uint8 > &ContentPayload) override
void	SetContent (TArray< uint8 > &&ContentPayload) override
void	SetContentAsString (const FString &ContentString) override
bool	SetContentAsStreamedFile (const FString &Filename) override
bool	SetContentFromStream (TSharedRef< FArchive, ESPMode::ThreadSafe > Stream) override
bool	SetResponseBodyReceiveStream (TSharedRef< FArchive > Stream) override
void	SetHeader (const FString &HeaderName, const FString &HeaderValue) override
void	AppendToHeader (const FString &HeaderName, const FString &AdditionalHeaderValue) override
bool	ProcessRequest () override
void	CancelRequest () override
EHttpRequestStatus::Type	GetStatus () const override
EHttpFailureReason	GetFailureReason () const override
const FString &	GetEffectiveURL () const override
const FHttpResponsePtr	GetResponse () const override
void	Tick (float DeltaSeconds) override
float	GetElapsedTime () const override
void	SetDelegateThreadPolicy (EHttpRequestDelegateThreadPolicy InThreadPolicy) override
EHttpRequestDelegateThreadPolicy	GetDelegateThreadPolicy () const override
virtual void	SetPriority (EHttpRequestPriority InPriority) override
virtual EHttpRequestPriority	GetPriority () const override
void	SetTimeout (float InTimeoutSecs) override
void	ClearTimeout () override
void	ResetTimeoutStatus () override
TOptional< float >	GetTimeout () const override
void	SetActivityTimeout (float InTimeoutSecs) override
void	ProcessRequestUntilComplete () override
FHttpRequestCompleteDelegate &	OnProcessRequestComplete () override
FHttpRequestProgressDelegate64 &	OnRequestProgress64 () override
FHttpRequestWillRetryDelegate &	OnRequestWillRetry () override
FHttpRequestHeaderReceivedDelegate &	OnHeaderReceived () override
FHttpRequestStatusCodeReceivedDelegate &	OnStatusCodeReceived () override
Public Member Functions inherited from IHttpRequest
HTTP_API bool	SetResponseBodyReceiveStreamDelegateV2 (FHttpRequestStreamDelegateV2 StreamDelegate)
virtual	~IHttpRequest ()=default
Public Member Functions inherited from IHttpBase
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

Friends
class	FClosedHttpRequest

Additional Inherited Members
Protected Member Functions inherited from TSharedFromThis< IHttpRequest, ESPMode::ThreadSafe >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()
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

Wraps a FPlatformHttp request when one is created inside an AutoRTFM transaction. Basic getters and setters are cached and played back when the transaction succeeds. Once the transaction is committed, a real HttpRequest is instantiated and all calls are passed through as-is.

Constructor & Destructor Documentation

FTransactionallySafeHttpRequest()

FTransactionallySafeHttpRequest::FTransactionallySafeHttpRequest

(

)

~FTransactionallySafeHttpRequest()

virtual FTransactionallySafeHttpRequest::~FTransactionallySafeHttpRequest ( )

virtualdefault

Member Function Documentation

AppendToHeader()

void FTransactionallySafeHttpRequest::AppendToHeader ( const FString &  HeaderName, const FString &  AdditionalHeaderValue  )

overridevirtual

Appends to the value already set in the header. If there is already content in that header, a comma delimiter is used. If the header is as of yet unset, the result is the same as calling SetHeader Content-Length is the only header set for you. Also see: SetHeader()

Parameters

HeaderName	- Name of the header (ie, Content-Type)
AdditionalHeaderValue	- Value to add to the existing contents of the specified header. comma is inserted between old value and new value, per HTTP specifications

Implements IHttpRequest.

CancelRequest()

void FTransactionallySafeHttpRequest::CancelRequest ( )

overridevirtual

Called to cancel a request that is still being processed

Implements IHttpRequest.

ClearTimeout()

void FTransactionallySafeHttpRequest::ClearTimeout ( )

overridevirtual

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

Implements IHttpRequest.

GetAllHeaders()

TArray< FString > FTransactionallySafeHttpRequest::GetAllHeaders ( ) const

overridevirtual

Return all headers in an array in "Name: Value" format.

Returns

the header array of strings

Implements IHttpBase.

GetContent()

const TArray< uint8 > & FTransactionallySafeHttpRequest::GetContent ( ) const

overridevirtual

Get the content payload of the request or response.

Parameters

Content

- array that will be filled with the content.

Implements IHttpBase.

GetContentLength()

uint64 FTransactionallySafeHttpRequest::GetContentLength ( ) const

overridevirtual

Shortcut to get the Content-Length header value. Will not always return non-zero. If you want the real length of the payload, get the payload and check it's length.

Returns

the content length (if available)

Implements IHttpBase.

GetContentType()

FString FTransactionallySafeHttpRequest::GetContentType ( ) const

overridevirtual

Shortcut to get the Content-Type header value (if available)

Returns

the content type.

Implements IHttpBase.

GetDelegateThreadPolicy()

EHttpRequestDelegateThreadPolicy FTransactionallySafeHttpRequest::GetDelegateThreadPolicy ( ) const

overridevirtual

Get thread policy about which thread to complete this request

Returns

The thread policy

Implements IHttpRequest.

GetEffectiveURL()

const FString & FTransactionallySafeHttpRequest::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 FTransactionallySafeHttpRequest::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 FTransactionallySafeHttpRequest::GetFailureReason ( ) const

overridevirtual

Get the reason of th failure if GetStatus returns Failed

Returns

the reason of the failure

Implements IHttpBase.

GetHeader()

FString FTransactionallySafeHttpRequest::GetHeader ( const FString &  HeaderName ) const

overridevirtual

Gets the value of a header, or empty string if not found.

Parameters

HeaderName

- name of the header to set.

Implements IHttpBase.

GetOption()

FString FTransactionallySafeHttpRequest::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 FTransactionallySafeHttpRequest::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 FTransactionallySafeHttpRequest::GetResponse ( ) const

overridevirtual

Get the associated Response

Returns

the response

Implements IHttpRequest.

GetStatus()

EHttpRequestStatus::Type FTransactionallySafeHttpRequest::GetStatus ( ) const

overridevirtual

Get the current status of the request being processed

Returns

the current status

Implements IHttpBase.

GetTimeout()

TOptional< float > FTransactionallySafeHttpRequest::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.

GetURL()

const FString & FTransactionallySafeHttpRequest::GetURL ( ) const

overridevirtual

Get the URL used to send the request.

Returns

the URL string.

Implements IHttpBase.

GetURLParameter()

FString FTransactionallySafeHttpRequest::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.

GetVerb()

FString FTransactionallySafeHttpRequest::GetVerb ( ) const

overridevirtual

Gets the verb (GET, PUT, POST) used by the request.

Returns

the verb string

Implements IHttpRequest.

OnHeaderReceived()

FHttpRequestHeaderReceivedDelegate & FTransactionallySafeHttpRequest::OnHeaderReceived ( )

overridevirtual

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

Implements IHttpRequest.

OnProcessRequestComplete()

FHttpRequestCompleteDelegate & FTransactionallySafeHttpRequest::OnProcessRequestComplete ( )

overridevirtual

Delegate called when the request is complete. See FHttpRequestCompleteDelegate

Implements IHttpRequest.

OnRequestProgress64()

FHttpRequestProgressDelegate64 & FTransactionallySafeHttpRequest::OnRequestProgress64 ( )

overridevirtual

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

Implements IHttpRequest.

OnRequestWillRetry()

FHttpRequestWillRetryDelegate & FTransactionallySafeHttpRequest::OnRequestWillRetry ( )

overridevirtual

Delegate called when the request will be retried

Implements IHttpRequest.

OnStatusCodeReceived()

FHttpRequestStatusCodeReceivedDelegate & FTransactionallySafeHttpRequest::OnStatusCodeReceived ( )

overridevirtual

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

Implements IHttpRequest.

ProcessRequest()

bool FTransactionallySafeHttpRequest::ProcessRequest ( )

overridevirtual

Called to begin processing the request. OnProcessRequestComplete delegate is always called when the request completes or on error if it is bound. A request can be re-used but not while still being processed.

Returns

if the request was successfully started.

Implements IHttpRequest.

ProcessRequestUntilComplete()

void FTransactionallySafeHttpRequest::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.

ResetTimeoutStatus()

void FTransactionallySafeHttpRequest::ResetTimeoutStatus ( )

overridevirtual

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

Implements IHttpRequest.

SetActivityTimeout()

void FTransactionallySafeHttpRequest::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.

SetContent() [1/2]

void FTransactionallySafeHttpRequest::SetContent ( const TArray< uint8 > &  ContentPayload )

overridevirtual

Sets the content of the request (optional data). Usually only set for POST requests.

Parameters

ContentPayload

- payload to set.

Implements IHttpRequest.

SetContent() [2/2]

void FTransactionallySafeHttpRequest::SetContent ( TArray< uint8 > &&  ContentPayload )

overridevirtual

Sets the content of the request (optional data). Usually only set for POST requests.

This version lets the API take ownership of the payload directly, helpful for larger payloads.

Parameters

ContentPayload

- payload to set.

Implements IHttpRequest.

SetContentAsStreamedFile()

bool FTransactionallySafeHttpRequest::SetContentAsStreamedFile ( const FString &  Filename )

overridevirtual

Sets the content of the request to stream from a file.

Parameters

FileName

- filename from which to stream the body.

Returns

True if the file is valid and will be used to stream the request. False otherwise.

Implements IHttpRequest.

SetContentAsString()

void FTransactionallySafeHttpRequest::SetContentAsString ( const FString &  ContentString )

overridevirtual

Sets the content of the request as a string encoded as UTF8.

Parameters

ContentString

- payload to set.

Implements IHttpRequest.

SetContentFromStream()

bool FTransactionallySafeHttpRequest::SetContentFromStream ( TSharedRef< FArchive, ESPMode::ThreadSafe >  Stream )

overridevirtual

Sets the content of the request to stream directly from an archive. NOTE: The Stream->Serialize will be called from another thread other than the game thread

Parameters

Stream

- archive from which the payload should be streamed.

Returns

True if the archive can be used to stream the request. False otherwise.

Implements IHttpRequest.

SetDelegateThreadPolicy()

void FTransactionallySafeHttpRequest::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.

SetHeader()

void FTransactionallySafeHttpRequest::SetHeader ( const FString &  HeaderName, const FString &  HeaderValue  )

overridevirtual

Sets optional header info. SetHeader for a given HeaderName will overwrite any previous values Use AppendToHeader to append more values for the same header Content-Length is the only header set for you. Required headers depends on the request itself. Eg. "multipart/form-data" needed for a form post

Parameters

HeaderName	- Name of the header (ie, Content-Type)
HeaderValue	- Value of the header

Implements IHttpRequest.

SetOption()

void FTransactionallySafeHttpRequest::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 FTransactionallySafeHttpRequest::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 FTransactionallySafeHttpRequest::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.

SetTimeout()

void FTransactionallySafeHttpRequest::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.

SetURL()

void FTransactionallySafeHttpRequest::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.

SetVerb()

void FTransactionallySafeHttpRequest::SetVerb ( const FString &  Verb )

overridevirtual

Sets the verb used by the request. Eg. (GET, PUT, POST) Should be set before calling ProcessRequest. If not specified then a GET is assumed.

Parameters

Verb	- verb to use.

Implements IHttpRequest.

Tick()

void FTransactionallySafeHttpRequest::Tick ( float  DeltaSeconds )

overridevirtual

Used to tick the request

Parameters

DeltaSeconds

- seconds since last ticked

Implements IHttpRequest.

Friends And Related Symbol Documentation

FClosedHttpRequest

friend class FClosedHttpRequest

friend

---

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

• Engine/Source/Runtime/Online/HTTP/Private/TransactionallySafeHttpRequest.h
• Engine/Source/Runtime/Online/HTTP/Private/TransactionallySafeHttpRequest.cpp