1. Epic GamesDeveloper
  3. IHttpRequest

IHttpRequest

Interface for Http requests (created using FHttpFactory)

API > API/Runtime > API/Runtime/HTTP > API/Runtime/HTTP/Interfaces

Inheritance Hierarchy

References

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

Syntax

class IHttpRequest :  
    public IHttpBase ,  
    public TSharedFromThis< IHttpRequest, ESPMode::ThreadSafe >

Remarks

Interface for Http requests (created using FHttpFactory)

Destructors

  Type Name Description
Public function Virtual   Destructor for overrides

Functions

  Type Name Description
Public function void

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

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

GetOption ( const FName Option
)

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

GetVerb ()

 Gets the verb (GET, PUT, POST) used by the request.
Public function FHttpRequestHeaderReceivedDelegate & Delegate called to signal the receipt of a header. See FHttpRequestHeaderReceivedDelegate
Public function FHttpRequestCompleteDelegate & Delegate called when the request is complete. See FHttpRequestCompleteDelegate
Public function FHttpRequestProgressDelegate64 & Delegate called to update the request/response progress. See FHttpRequestProgressDelegate64
Public function FHttpRequestWillRetryDelegate & Delegate called when the request will be retried
Public function FHttpRequestStatusCodeReceivedDelegate & Delegate called to signal the receipt of a header. See FHttpRequestStatusCodeReceivedDelegate
Public function bool Called to begin processing the request.
Public function void Blocking call to wait the request until it's completed
Public function void Reset the elapsed timeout duration and flag, after the request completed and need to be reused
Public function void

SetActivityTimeout ( float InTimeoutSecs
)

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

SetContent ( const TArray< uint8 >& ContentPayload
)

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

SetContent ( TArray< uint8 >&& ContentPayload
)

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

SetContentAsStreamedFile ( const FString& Filename
)

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

SetContentAsString ( const FString& ContentString
)

 Sets the content of the request as a string encoded as UTF8.
Public function bool Sets the content of the request to stream directly from an archive.
Public function bool Sets the content of the request to stream directly from an delegate.
Public function 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 void

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

 Sets optional header info.
Public function void

SetOption ( const FName Option,
const FString& OptionValue
)

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

SetTimeout ( float InTimeoutSecs
)

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

SetURL ( const FString& URL
)

 Sets the URL for the request Eg.
Public function void

SetVerb ( const FString& Verb
)

 Sets the verb used by the request.
Public function void

Tick ( float DeltaSeconds
)

 Used to tick the request

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page