1. Epic GamesDeveloper
  3. FHttpRequestAdapterBase

FHttpRequestAdapterBase

Adapter class for [IHttpRequest](API\Runtime\HTTP\Interfaces\IHttpRequest) abstract interface does not fully expose the wrapped interface in the base.

API > API/Runtime > API/Runtime/HTTP

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
Protected variable TSharedRef< IHttpRequest > HttpRequest  

Constructors

  Type Name Description
Public function  

FHttpRequestAdapterBase ( const TSharedRef< IHttpRequest >& InHttpRequest
)

  

Destructors

  Type Name Description
Public function    

Overridden from IHttpRequest

  Type Name Description
Public function Virtual void

AppendToHeader ( const FString& HeaderName,
const FString& AdditionalHeaderValue
)

 Appends to the value already set in the header.
Public function Virtual void Clears the optional timeout in seconds for this HTTP request, causing the default value from FHttpModule::GetTimeout() to be used.
Public function Virtual Const EHttpRequestDelegateThreadPolicy Get thread policy about which thread to complete this request
Public function Virtual Const float Gets the time that it took for the server to fully respond to the request.
Public function Virtual Const FString

GetOption ( const FName Option
)

 Get the current value for the given option
Public function Virtual Const const FHttpResponsePtr Get the associated Response
Public function Virtual Const TOptional< float > Gets the optional timeout in seconds for this entire HTTP request to complete.
Public function Virtual Const FString

GetVerb ()

 Gets the verb (GET, PUT, POST) used by the request.
Public function Virtual void Blocking call to wait the request until it's completed
Public function Virtual void Reset the elapsed timeout duration and flag, after the request completed and need to be reused
Public function Virtual void

SetActivityTimeout ( float InTimeoutSecs
)

 Sets an optional activity timeout in seconds for this HTTP request.
Public function Virtual void

SetContent ( const TArray< uint8 >& ContentPayload
)

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

SetContent ( TArray< uint8 >&& ContentPayload
)

 Sets the content of the request (optional data).
Public function Virtual bool

SetContentAsStreamedFile ( const FString& Filename
)

 Sets the content of the request to stream from a file.
Public function Virtual void

SetContentAsString ( const FString& ContentString
)

 Sets the content of the request as a string encoded as UTF8.
Public function Virtual bool Sets the content of the request to stream directly from an archive.
Public function Virtual void Set thread policy about which thread to trigger the delegates, set by FHttpManager::SetRequestCompletedDelegate, IHttpRequest::OnStatusCodeReceived, IHttpRequest::OnHeaderReceived, IHttpRequest::OnRequestProgress64 and IHttpRequest::OnProcessRequestComplete.
Public function Virtual void

SetHeader ( const FString& HeaderName,
const FString& HeaderValue
)

 Sets optional header info.
Public function Virtual void

SetOption ( const FName Option,
const FString& OptionValue
)

 Sets the given option for this Request Must be set before calling ProcessRequest.
Public function Virtual bool Sets the stream to receive the response body.
Public function Virtual void

SetTimeout ( float InTimeoutSecs
)

 Sets an optional timeout in seconds for this entire HTTP request to complete.
Public function Virtual void

SetURL ( const FString& URL
)

 Sets the URL for the request Eg.
Public function Virtual void

SetVerb ( const FString& Verb
)

 Sets the verb used by the request.
Public function Virtual void

Tick ( float DeltaSeconds
)

 Used to tick the request

Overridden from IHttpBase

  Type Name Description
Public function Virtual Const TArray< FString > Return all headers in an array in "Name: Value" format.
Public function Virtual Const const TArray< uint8 > & Get the content payload of the request or response.
Public function Virtual Const uint64 Shortcut to get the Content-Length header value.
Public function Virtual Const FString Shortcut to get the Content-Type header value (if available)
Public function Virtual Const const FString & Get the effective URL in case of redirected. If not redirected, it's the same as GetURL
Public function Virtual Const EHttpFailureReason Get the reason of th failure if GetStatus returns Failed
Public function Virtual Const FString

GetHeader ( const FString& HeaderName
)

 Gets the value of a header, or empty string if not found.
Public function Virtual Const EHttpRequestStatus::Type Get the current status of the request being processed
Public function Virtual Const FString

GetURL ()

 Get the URL used to send the request.
Public function Virtual Const FString

GetURLParameter ( const FString& ParameterName
)

 Gets an URL parameter.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page