1. Epic GamesDeveloper
  3. HTTP

HTTP

API > API/Runtime

   
Name HTTP
Type Runtime
Location /Engine/Source/Runtime/Online/HTTP/
Module Build Rules HTTP.Build.cs

Classes

Name Remarks
FArchiveWithDelegate Delegate version of FArchive, for streaming interface
FDefaultUserAgentBuilder Utility structure to help with building the HTTP user agent string.
FGenericPlatformHttp Platform specific Http implementations Intended usage is to use FPlatformHttp instead of FGenericPlatformHttp
FHttpManager Manages Http request that are currently being processed
FHttpModule Module for Http request implementations Use FHttpFactory to create a new Http request
FHttpRequestAdapterBase Adapter class for IHttpRequest abstract interface does not fully expose the wrapped interface in the base.
FHttpRequestImpl Contains implementation of some common functions that don't vary between implementation
FManager  
FRequest Class FRequest is what the retry system accepts as inputs
FRequestPayload Abstraction that encapsulates the location of a request payload
FRequestPayloadInFileStream  
FRequestPayloadInMemory  
FUnixPlatformHttp Platform specific Http implementations

Structs

Name Remarks
FExponentialBackoffCurve Model for computing exponential backoff using the formula: Base**(CurrentRetryAttempt + Bias) Then applying jitter to the backoff.
FHttpConstants Universal HTTP Constants
FHttpStats  
FHttpStatsPlatform  
FHttpStatsPlatformMemoryPool  
FRetryDomains  

Interfaces

Name Remarks
IHttpBase Base interface for Http Requests and Responses.
IHttpRequest Interface for Http requests (created using FHttpFactory)
IHttpResponse Interface for Http responses that come back after starting an Http request

Typedefs

Name Type Remarks Include Path
FHttpManagerRequestAddedDelegate TBaseDelegate_OneParam< void, const FHttpRequestRef & > Delegate called when an Http request added. HttpManager.h
FHttpManagerRequestCompletedDelegate TBaseDelegate_OneParam< void, const FHttpRequestRef & > Delegate called when an Http request completes. HttpManager.h
FHttpRequestCompleteDelegate TTSDelegate< void(FHttpRequestPtr, FHttpResponsePtr, bool)> Delegate called when an Http request completes Interfaces/IHttpRequest.h
FHttpRequestHeaderReceivedDelegate TTSDelegate< void(FHttpRequestPtr, const FString &, const FString &)> Delegate called when an Http request receives a header Interfaces/IHttpRequest.h
FHttpRequestProgressDelegate TTSDelegate< void(FHttpRequestPtr, int32, int32)> Delegate called per tick to update an Http request upload or download size progress Interfaces/IHttpRequest.h
FHttpRequestProgressDelegate64 TTSDelegate< void(FHttpRequestPtr, uint64, uint64)> Delegate called per tick to update an Http request upload or download size progress Interfaces/IHttpRequest.h
FHttpRequestPtr TSharedPtr< IHttpRequest, ESPMode::ThreadSafe >   Interfaces/IHttpRequest.h
FHttpRequestPtr TSharedPtr< IHttpRequest, ESPMode::ThreadSafe >   HttpFwd.h
FHttpRequestRef TSharedRef< IHttpRequest, ESPMode::ThreadSafe >   Interfaces/IHttpRequest.h
FHttpRequestRef TSharedRef< IHttpRequest, ESPMode::ThreadSafe >   HttpFwd.h
FHttpRequestStatusCodeReceivedDelegate TTSDelegate< void(FHttpRequestPtr, int32)> Delegate called when an Http request receives status code Interfaces/IHttpRequest.h
FHttpRequestStreamDelegate TTSDelegate< bool(void *, int64)> Delegate called when an Http request will send/recv data through stream Interfaces/IHttpRequest.h
FHttpRequestStreamDelegateV2 TTSDelegate< void(void *, int64 &)> Delegate called when an Http request will send/recv data through stream Interfaces/IHttpRequest.h
FHttpRequestWillRetryDelegate TTSDelegate< void(FHttpRequestPtr, FHttpResponsePtr, float)> Delegate called when an Http request will be retried in the future Interfaces/IHttpRequest.h
FHttpResponsePtr TSharedPtr< IHttpResponse, ESPMode::ThreadSafe >   Interfaces/IHttpRequest.h
FHttpResponsePtr TSharedPtr< IHttpResponse, ESPMode::ThreadSafe >   HttpFwd.h
FHttpResponseRef TSharedRef< IHttpResponse, ESPMode::ThreadSafe >   Interfaces/IHttpRequest.h
FHttpResponseRef TSharedRef< IHttpResponse, ESPMode::ThreadSafe >   HttpFwd.h
FPlatformHttp FUnixPlatformHttp   Unix/UnixPlatformHttp.h
FRandomFailureRateSetting TOptional< float >   HttpFwd.h
FRetryDomainsPtr TSharedPtr< FRetryDomains, ESPMode::ThreadSafe >   HttpFwd.h
FRetryLimitCountSetting TOptional< RetryLimitCountType >   HttpFwd.h
FRetryResponseCodes TSet< int32 >   HttpFwd.h
FRetryTimeoutRelativeSecondsSetting TOptional< RetryTimeoutRelativeSecondsType >   HttpFwd.h
FRetryVerbs TSet< FName >   HttpFwd.h
RetryLimitCountType uint32   HttpFwd.h
RetryTimeoutRelativeSecondsType double   HttpFwd.h

Enums

Public

Name Remarks
EHttpFailureReason The reason of the failure when HTTP request failed
EHttpFlushReason  
EHttpRequestDelegateThreadPolicy Enumerates thread policy about which thread to complete the http request
EHttpRequestStatus::Type Enumerates the current state of an Http request
EHttpResponseCodes::Type  

Constants

Name Type Remarks Include Path
EHttpResponseCodes::ErrorNamespace const FString   Interfaces/IHttpResponse.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool EHttpRequestStatus::IsFinished ( const EHttpRequestStatus::Type Value
)

   Interfaces/IHttpBase.h  

const TCHAR * EHttpRequestStatus::ToString ( EHttpRequestStatus::Type EnumVal
)

   Interfaces/IHttpBase.h  

FText EHttpResponseCodes::GetDescription ( EHttpResponseCodes::Type StatusCode
)

   Interfaces/IHttpResponse.h  

FString EHttpResponseCodes::GetResponseCodeAsErrorCode ( int32 StatusCode
)

   Interfaces/IHttpResponse.h  

bool EHttpResponseCodes::IsOk ( int32 StatusCode
)

   Interfaces/IHttpResponse.h  

FString EHttpResponseCodes::ResponseCodeToString ( Type ResponseCode
)

   Interfaces/IHttpResponse.h  

RetryLimitCountType FHttpRetrySystem::RetryLimitCount ( uint32 Value
)

   HttpRetrySystem.h  

RetryTimeoutRelativeSecondsType FHttpRetrySystem::RetryTimeoutRelativeSeconds ( double Value
)

   HttpRetrySystem.h  

IntrinsicType FHttpRetrySystem::TZero()

   HttpRetrySystem.h  
Status code not set yet    

HTTP_RESPONSE_CODE ( SwitchProtocol,
101
)

 The server has switched protocols in an upgrade header.    

HTTP_RESPONSE_CODE ( Created,
201
)

 The request has been fulfilled and resulted in the creation of a new resource.    
The returned meta information in the entity-header is not the definitive set available from the origin server.    

HTTP_RESPONSE_CODE ( ResetContent,
205
)

 The request has been completed, and the client program should reset the document view that caused the request to be sent to allow the user to easily initiate another input action.    

HTTP_RESPONSE_CODE ( Ambiguous,
300
)

 The server couldn't decide what to return.    

HTTP_RESPONSE_CODE ( Redirect,
302
)

 The requested resource resides temporarily under a different uri (uniform resource identifier).    

HTTP_RESPONSE_CODE ( NotModified,
304
)

 The requested resource has not been modified.    

HTTP_RESPONSE_CODE ( RedirectKeepVerb,
307
)

 The redirected request keeps the same http verb. http/1.1 behavior.    

HTTP_RESPONSE_CODE ( Denied,
401
)

 The requested resource requires user authentication.    

HTTP_RESPONSE_CODE ( Forbidden,
403
)

 The server understood the request, but is refusing to fulfill it.    

HTTP_RESPONSE_CODE ( BadMethod,
405
)

 The http verb used is not allowed.    

HTTP_RESPONSE_CODE ( ProxyAuthReq,
407
)

 Proxy authentication required.    

HTTP_RESPONSE_CODE ( Conflict,
409
)

 The request could not be completed due to a conflict with the current state of the resource. the user should resubmit with more information.    

HTTP_RESPONSE_CODE ( LengthRequired,
411
)

 The server refuses to accept the request without a defined content length.    

HTTP_RESPONSE_CODE ( RequestTooLarge,
413
)

 The server is refusing to process a request because the request entity is larger than the server is willing or able to process.    

HTTP_RESPONSE_CODE ( UnsupportedMedia,
415
)

 The server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method.    

HTTP_RESPONSE_CODE ( RetryWith,
449
)

 The request should be retried after doing the appropriate action.    
The server does not support the functionality required to fulfill the request.    

HTTP_RESPONSE_CODE ( ServiceUnavail,
503
)

 The service is temporarily overloaded.    

const TCHAR * LexToString ( const EHttpFlushReason& FlushReason
)

   HttpManager.h  

const TCHAR * LexToString ( EHttpFailureReason HttpFailureReason
)

   Interfaces/IHttpBase.h  

Static

Name Remarks Include Path Unreal Specifiers

static const FName HttpRequestOptions::HttpVersion ( "HttpVersion"
)

   Interfaces/IHttpRequest.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page