Navigation
API > API/Runtime > API/Runtime/HTTP
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.
| Name | FHttpRequestAdapterBase |
| Type | class |
| Header File | /Engine/Source/Runtime/Online/HTTP/Public/HttpRequestAdapter.h |
| Include Path | #include "HttpRequestAdapter.h" |
Syntax
class FHttpRequestAdapterBase : public FHttpRequestImpl
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FHttpRequestAdapterBase
(
const TSharedRef< IHttpRequest >& InHttpRequest |
HttpRequestAdapter.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FHttpRequestAdapterBase() |
HttpRequestAdapter.h |
Functions
Public
Overridden from IHttpRequest
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AppendToHeader
(
const FString& HeaderName, |
Appends to the value already set in the header. | HttpRequestAdapter.h | |
virtual void ClearTimeout() |
Clears the optional timeout in seconds for this HTTP request, causing the default value from FHttpModule::GetTimeout() to be used. | HttpRequestAdapter.h | |
virtual EHttpRequestDelegateThreadPolicy GetDelegateThreadPolicy() |
Get thread policy about which thread to complete this request | HttpRequestAdapter.h | |
virtual float GetElapsedTime() |
Gets the time that it took for the server to fully respond to the request. | HttpRequestAdapter.h | |
| Get the current value for the given option | HttpRequestAdapter.h | ||
virtual EHttpRequestPriority GetPriority() |
Get request priority, which is used to decide the position in the queue when max concurrent limit reached | HttpRequestAdapter.h | |
virtual const FHttpResponsePtr GetResponse() |
Get the associated Response | HttpRequestAdapter.h | |
virtual TOptional< float > GetTimeout () |
Gets the optional timeout in seconds for this entire HTTP request to complete. | HttpRequestAdapter.h | |
virtual FString GetVerb() |
Gets the verb (GET, PUT, POST) used by the request. | HttpRequestAdapter.h | |
virtual void ProcessRequestUntilComplete () |
Blocking call to wait the request until it's completed | HttpRequestAdapter.h | |
virtual void ResetTimeoutStatus() |
Reset the elapsed timeout duration and flag, after the request completed and need to be reused | HttpRequestAdapter.h | |
virtual void SetActivityTimeout
(
float InTimeoutSecs |
Sets an optional activity timeout in seconds for this HTTP request. | HttpRequestAdapter.h | |
virtual void SetContent
(
const TArray< uint8 >& ContentPayload |
Sets the content of the request (optional data). Usually only set for POST requests. | HttpRequestAdapter.h | |
virtual void SetContent
(
TArray< uint8 >&& ContentPayload |
Sets the content of the request (optional data). | HttpRequestAdapter.h | |
virtual bool SetContentAsStreamedFile
(
const FString& Filename |
Sets the content of the request to stream from a file. | HttpRequestAdapter.h | |
virtual void SetContentAsString
(
const FString& ContentString |
Sets the content of the request as a string encoded as UTF8. | HttpRequestAdapter.h | |
virtual bool SetContentFromStream
(
TSharedRef< FArchive, ESPMode::ThreadSafe > Stream |
Sets the content of the request to stream directly from an archive. | HttpRequestAdapter.h | |
virtual void SetDelegateThreadPolicy
(
EHttpRequestDelegateThreadPolicy InThreadPolicy |
Set thread policy about which thread to trigger the delegates, set by FHttpManager::SetRequestCompletedDelegate, IHttpRequest::OnStatusCodeReceived, IHttpRequest::OnHeaderReceived, IHttpRequest::OnRequestProgress64 and IHttpRequest::OnProcessRequestComplete. | HttpRequestAdapter.h | |
| Sets optional header info. | HttpRequestAdapter.h | ||
| Sets the given option for this Request Must be set before calling ProcessRequest. | HttpRequestAdapter.h | ||
virtual void SetPriority
(
EHttpRequestPriority InPriority |
Set priority of the request, which will be used to decide the position in the queue when max concurrent limit reached | HttpRequestAdapter.h | |
virtual bool SetResponseBodyReceiveStream
(
TSharedRef< FArchive > Stream |
Sets the stream to receive the response body. | HttpRequestAdapter.h | |
virtual void SetTimeout
(
float InTimeoutSecs |
Sets an optional timeout in seconds for this entire HTTP request to complete. | HttpRequestAdapter.h | |
| Sets the URL for the request Eg. | HttpRequestAdapter.h | ||
| Sets the verb used by the request. | HttpRequestAdapter.h | ||
virtual void Tick
(
float DeltaSeconds |
Used to tick the request | HttpRequestAdapter.h |
Overridden from IHttpBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Return all headers in an array in "Name: Value" format. | HttpRequestAdapter.h | ||
virtual const TArray< uint8 > & GetContent() |
Get the content payload of the request or response. | HttpRequestAdapter.h | |
virtual uint64 GetContentLength () |
Shortcut to get the Content-Length header value. | HttpRequestAdapter.h | |
virtual FString GetContentType() |
Shortcut to get the Content-Type header value (if available) | HttpRequestAdapter.h | |
virtual const FString & GetEffectiveURL() |
Get the effective URL in case of redirected. If not redirected, it's the same as GetURL | HttpRequestAdapter.h | |
virtual EHttpFailureReason GetFailureReason() |
Get the reason of th failure if GetStatus returns Failed | HttpRequestAdapter.h | |
| Gets the value of a header, or empty string if not found. | HttpRequestAdapter.h | ||
virtual EHttpRequestStatus::Type GetStatus() |
Get the current status of the request being processed | HttpRequestAdapter.h | |
virtual const FString & GetURL() |
Get the URL used to send the request. | HttpRequestAdapter.h | |
virtual FString GetURLParameter
(
const FString& ParameterName |
Gets an URL parameter. | HttpRequestAdapter.h |