UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
IHttpBase Class Referenceabstract

#include <IHttpBase.h>

+ Inheritance diagram for IHttpBase:

Public Member Functions

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
 

Detailed Description

Base interface for Http Requests and Responses.

Constructor & Destructor Documentation

◆ ~IHttpBase()

virtual IHttpBase::~IHttpBase ( )
virtualdefault

Destructor for overrides

Member Function Documentation

◆ GetAllHeaders()

virtual TArray< FString > IHttpBase::GetAllHeaders ( ) const
pure virtual

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

Returns
the header array of strings

Implemented in FAppleHttpRequest, FAppleHttpResponse, FGenericPlatformHttpRequest, FNullHttpRequest, FTransactionallySafeHttpRequest::FClosedHttpRequest, FTransactionallySafeHttpRequest, and FHttpRequestAdapterBase.

◆ GetContent()

virtual const TArray< uint8 > & IHttpBase::GetContent ( ) const
pure virtual

Get the content payload of the request or response.

Parameters
Content- array that will be filled with the content.

Implemented in FAppleHttpRequest, FGenericPlatformHttpRequest, FHttpResponseCommon, FNullHttpRequest, FTransactionallySafeHttpRequest::FClosedHttpRequest, FTransactionallySafeHttpRequest, and FHttpRequestAdapterBase.

◆ GetContentLength()

virtual uint64 IHttpBase::GetContentLength ( ) const
pure virtual

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)

Implemented in FAppleHttpRequest, FAppleHttpResponse, FGenericPlatformHttpRequest, FNullHttpRequest, FTransactionallySafeHttpRequest::FClosedHttpRequest, FTransactionallySafeHttpRequest, and FHttpRequestAdapterBase.

◆ GetContentType()

virtual FString IHttpBase::GetContentType ( ) const
pure virtual

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

Returns
the content type.

Implemented in FAppleHttpRequest, FAppleHttpResponse, FGenericPlatformHttpRequest, FNullHttpRequest, FTransactionallySafeHttpRequest::FClosedHttpRequest, FTransactionallySafeHttpRequest, and FHttpRequestAdapterBase.

◆ GetEffectiveURL()

virtual const FString & IHttpBase::GetEffectiveURL ( ) const
pure virtual

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

Returns
the effective URL string.

Implemented in FGenericPlatformHttpRequest, FHttpRequestCommon, FHttpResponseCommon, FNullHttpRequest, FTransactionallySafeHttpRequest::FClosedHttpRequest, FTransactionallySafeHttpRequest, and FHttpRequestAdapterBase.

◆ GetFailureReason()

virtual EHttpFailureReason IHttpBase::GetFailureReason ( ) const
pure virtual

Get the reason of th failure if GetStatus returns Failed

Returns
the reason of the failure

Implemented in FGenericPlatformHttpRequest, FHttpRequestCommon, FHttpResponseCommon, FNullHttpRequest, FTransactionallySafeHttpRequest::FClosedHttpRequest, FTransactionallySafeHttpRequest, and FHttpRequestAdapterBase.

◆ GetHeader()

virtual FString IHttpBase::GetHeader ( const FString &  HeaderName) const
pure virtual

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

Parameters
HeaderName- name of the header to set.

Implemented in FAppleHttpRequest, FGenericPlatformHttpRequest, FHttpResponseCommon, FNullHttpRequest, FTransactionallySafeHttpRequest::FClosedHttpRequest, FTransactionallySafeHttpRequest, and FHttpRequestAdapterBase.

◆ GetStatus()

virtual EHttpRequestStatus::Type IHttpBase::GetStatus ( ) const
pure virtual

Get the current status of the request being processed

Returns
the current status

Implemented in FGenericPlatformHttpRequest, FHttpRequestCommon, FHttpResponseCommon, FNullHttpRequest, FTransactionallySafeHttpRequest::FClosedHttpRequest, FTransactionallySafeHttpRequest, and FHttpRequestAdapterBase.

◆ GetURL()

virtual const FString & IHttpBase::GetURL ( ) const
pure virtual

Get the URL used to send the request.

Returns
the URL string.

Implemented in FGenericPlatformHttpRequest, FHttpRequestCommon, FHttpResponseCommon, FNullHttpRequest, FTransactionallySafeHttpRequest::FClosedHttpRequest, FTransactionallySafeHttpRequest, and FHttpRequestAdapterBase.

◆ GetURLParameter()

virtual FString IHttpBase::GetURLParameter ( const FString &  ParameterName) const
pure virtual

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.

Implemented in FGenericPlatformHttpRequest, FHttpRequestCommon, FHttpResponseCommon, FNullHttpRequest, FTransactionallySafeHttpRequest::FClosedHttpRequest, FTransactionallySafeHttpRequest, and FHttpRequestAdapterBase.

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