FHttpRequestAdapterBase | Unreal Engine 5.0 Documentation

Inheritance Hierarchy

References


Module	HTTP
Header	/Engine/Source/Runtime/Online/HTTP/Public/HttpRequestAdapter.h
Include	#include "HttpRequestAdapter.h"

Syntax

class FHttpRequestAdapterBase : public FHttpRequestImpl

Remarks

Adapter class for IHttpRequest abstract interface does not fully expose the wrapped interface in the base. This allows client defined marshalling of the requests when end point permissions are at issue.

Variables

	Type	Name	Description
	TSharedRef< IHttpRequest, ESPMode::ThreadSafe >	HttpRequest

Constructors

	Type	Name	Description
		FHttpRequestAdapterBase ( const TSharedRef< IHttpRequest, ESPMode::ThreadSafe >& InHttpRequest )

Overridden from IHttpRequest

Type	Name	Description
void	AppendToHeader ( const FString& HeaderName, const FString& AdditionalHeaderValue )	Appends to the value already set in the header.
void	ClearTimeout ()	Clears the optional timeout in seconds for this HTTP request, causing the default value from FHttpModule::GetTimeout() to be used.
EHttpRequestDelegateThreadPolicy	GetDelegateThreadPolicy ()	Get thread policy about which thread to complete this request
float	GetElapsedTime ()	Gets the time that it took for the server to fully respond to the request.
const FHttpResponsePtr	GetResponse ()	Get the associated Response
EHttpRequestStatus::Type	GetStatus ()	Get the current status of the request being processed
TOptional< float >	GetTimeout ()	Gets the optional timeout in seconds for this entire HTTP request to complete.
FString	GetVerb ()	Gets the verb (GET, PUT, POST) used by the request.
void	SetContent ( const TArray< uint8 >& ContentPayload )	Sets the content of the request (optional data). Usually only set for POST requests.
void	SetContent ( TArray< uint8 >&& ContentPayload )	Sets the content of the request (optional data).
bool	SetContentAsStreamedFile ( const FString& Filename )	Sets the content of the request to stream from a file.
void	SetContentAsString ( const FString& ContentString )	Sets the content of the request as a string encoded as UTF8.
bool	SetContentFromStream ( TSharedRef< FArchive, ESPMode::ThreadSafe > Stream )	Sets the content of the request to stream directly from an archive.
void	SetDelegateThreadPolicy ( EHttpRequestDelegateThreadPolicy InThreadPolicy )	Set thread policy about which thread to complete this request
void	SetHeader ( const FString& HeaderName, const FString& HeaderValue )	Sets optional header info.
bool	SetResponseBodyReceiveStream ( TSharedRef< FArchive > Stream )	Sets the stream to receive the response body.
void	SetTimeout ( float InTimeoutSecs )	Sets an optional timeout in seconds for this entire HTTP request to complete.
void	SetURL ( const FString& URL )	Sets the URL for the request Eg.
void	SetVerb ( const FString& Verb )	Sets the verb used by the request.
void	Tick ( float DeltaSeconds )	Used to tick the request

Overridden from IHttpBase

Type	Name	Description
TArray< FString >	GetAllHeaders ()	Return all headers in an array in "Name: Value" format.
const TArray< uint8 > &	GetContent ()	Get the content payload of the request or response.
uint64	GetContentLength ()	Shortcut to get the Content-Length header value.
FString	GetContentType ()	Shortcut to get the Content-Type header value (if available)
FString	GetHeader ( const FString& HeaderName )	Gets the value of a header, or empty string if not found.
FString	GetURL ()	Get the URL used to send the request.
FString	GetURLParameter ( const FString& ParameterName )	Gets an URL parameter.

Navigation