FHttpResponseCommon Class Reference

#include <HttpResponseCommon.h>

Inheritance diagram for FHttpResponseCommon:

Public Member Functions
	FHttpResponseCommon (const FHttpRequestCommon &HttpRequest)
virtual FString	GetURLParameter (const FString &ParameterName) const override
virtual const FString &	GetURL () const override
virtual const FString &	GetEffectiveURL () const override
virtual EHttpRequestStatus::Type	GetStatus () const override
virtual EHttpFailureReason	GetFailureReason () const override
virtual int32	GetResponseCode () const override
virtual FUtf8StringView	GetContentAsUtf8StringView () const override
virtual FString	GetHeader (const FString &HeaderName) const override
virtual const TArray< uint8 > &	GetContent () const override
virtual FString	GetContentAsString () const override
Public Member Functions inherited from IHttpResponse
virtual	~IHttpResponse ()=default
Public Member Functions inherited from IHttpBase
virtual TArray< FString >	GetAllHeaders () const =0
virtual FString	GetContentType () const =0
virtual uint64	GetContentLength () const =0
virtual	~IHttpBase ()=default

Protected Member Functions
void	SetRequestStatus (EHttpRequestStatus::Type InCompletionStatus)
void	SetRequestFailureReason (EHttpFailureReason InFailureReason)
void	SetEffectiveURL (const FString &InEffectiveURL)
void	SetResponseCode (int32 InResponseCode)
void	AppendToPayload (const uint8 *Ptr, int64 Size)

Protected Attributes
FString	URL
FString	EffectiveURL
EHttpRequestStatus::Type	CompletionStatus
EHttpFailureReason	FailureReason
int32	ResponseCode = EHttpResponseCodes::Unknown
TArray< uint8 >	Payload
TMap< FString, FString >	Headers
bool	bIsReady = false

Detailed Description

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

Constructor & Destructor Documentation

FHttpResponseCommon()

FHttpResponseCommon::FHttpResponseCommon

(

const FHttpRequestCommon &

HttpRequest

)

Member Function Documentation

AppendToPayload()

void FHttpResponseCommon::AppendToPayload ( const uint8 *  Ptr, int64  Size  )

protected

GetContent()

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

overridevirtual

Get the content payload of the request or response.

Parameters

Content

- array that will be filled with the content.

Implements IHttpBase.

GetContentAsString()

FString FHttpResponseCommon::GetContentAsString ( ) const

overridevirtual

Returns the payload as a string, assuming the payload is UTF8.

Returns

the payload as a string.

Implements IHttpResponse.

GetContentAsUtf8StringView()

FUtf8StringView FHttpResponseCommon::GetContentAsUtf8StringView ( ) const

overridevirtual

Returns the payload as a utf8 string view. This does not validate that the response is valid utf8. It is the caller's responsibility, for example, by checking the Content-Type header

Returns

the payload as a utf8 string view.

Implements IHttpResponse.

GetEffectiveURL()

const FString & FHttpResponseCommon::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.

GetFailureReason()

EHttpFailureReason FHttpResponseCommon::GetFailureReason ( ) const

overridevirtual

Get the reason of th failure if GetStatus returns Failed

Returns

the reason of the failure

Implements IHttpBase.

GetHeader()

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

GetResponseCode()

int32 FHttpResponseCommon::GetResponseCode ( ) const

overridevirtual

Gets the response code returned by the requested server. See EHttpResponseCodes for known response codes

Returns

the response code.

Implements IHttpResponse.

GetStatus()

EHttpRequestStatus::Type FHttpResponseCommon::GetStatus ( ) const

overridevirtual

Get the current status of the request being processed

Returns

the current status

Implements IHttpBase.

GetURL()

const FString & FHttpResponseCommon::GetURL ( ) const

overridevirtual

Get the URL used to send the request.

Returns

the URL string.

Implements IHttpBase.

GetURLParameter()

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

SetEffectiveURL()

void FHttpResponseCommon::SetEffectiveURL ( const FString &  InEffectiveURL )

protected

SetRequestFailureReason()

void FHttpResponseCommon::SetRequestFailureReason ( EHttpFailureReason  InFailureReason )

protected

SetRequestStatus()

void FHttpResponseCommon::SetRequestStatus ( EHttpRequestStatus::Type  InCompletionStatus )

protected

SetResponseCode()

void FHttpResponseCommon::SetResponseCode ( int32  InResponseCode )

protected

Member Data Documentation

bIsReady

bool FHttpResponseCommon::bIsReady = false

protected

CompletionStatus

EHttpRequestStatus::Type FHttpResponseCommon::CompletionStatus

protected

EffectiveURL

FString FHttpResponseCommon::EffectiveURL

protected

FailureReason

EHttpFailureReason FHttpResponseCommon::FailureReason

protected

Headers

TMap<FString, FString> FHttpResponseCommon::Headers

protected

Payload

TArray<uint8> FHttpResponseCommon::Payload

protected

ResponseCode

int32 FHttpResponseCommon::ResponseCode = EHttpResponseCodes::Unknown

protected

URL

FString FHttpResponseCommon::URL

protected

---

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

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