Navigation
| Name | BackgroundHTTP |
| Type | Runtime |
| Location | /Engine/Source/Runtime/Online/BackgroundHTTP/ |
| Module Build Rules | BackgroundHTTP.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FBackgroundHttpManagerImpl | Contains implementation of some common functions that don't vary between implementation |
| FBackgroundHttpModule | Module for Http Background request implementations |
| FBackgroundHttpNotificationObject | |
| FBackgroundHttpRequestImpl | Contains implementation of some common functions that don't have to vary between implementation |
| FBackgroundHttpResponseImpl | Contains implementation of some common functions that don't vary between implementation |
| FGenericPlatformBackgroundHttp | Generic version of Background Http implementations for platforms that don't need a special implementation Intended usage is to use FPlatformBackgroundHttp instead of FGenericPlatformHttp On platforms without a specific implementation, you should still use FPlatformBackgroundHttp and it will call into these functions |
| FGenericPlatformBackgroundHttpManager | Manages Background Http request that are currently being processed if no platform specific implementation has been made. |
| FGenericPlatformBackgroundHttpRequest | Contains implementation of some common functions that don't vary between implementation |
| FGenericPlatformBackgroundHttpResponse | Contains implementation of some common functions that don't vary between implementation |
| FModularFeaturePlatformBackgroundHttp | This version of BackgroundHttp is designed to be used by any platform that relies on a ModularFeature to override the BackgroundHttp behavior. |
Structs
| Name | Remarks |
|---|---|
| FBackgroundHttpRequestMetricsExtended |
Interfaces
| Name | Remarks |
|---|---|
| IBackgroundHttpManager | |
| IBackgroundHttpModularFeature | This version of BackgroundHttp is designed to be used by any platform that relies on a ModularFeature to override the BackgroundHttp behavior. |
| IBackgroundHttpRequest | Interface for Http requests (created using FHttpFactory) |
| IBackgroundHttpResponse | Interface for Http Background Responses |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FBackgroundHttpManagerPtr | TSharedPtr< class IBackgroundHttpManager, ESPMode::ThreadSafe > | Interfaces/IBackgroundHttpManager.h | |
| FBackgroundHttpManagerPtr | TSharedPtr< class IBackgroundHttpManager, ESPMode::ThreadSafe > | Interfaces/IBackgroundHttpRequest.h | |
| FBackgroundHttpNotificationObjectPtr | TSharedPtr< FBackgroundHttpNotificationObject, ESPMode::ThreadSafe > | BackgroundHttpNotificationObject.h | |
| FBackgroundHttpProgressUpdateDelegate | TBaseDelegate_ThreeParams< void, FBackgroundHttpRequestPtr, int32, int32 > | Delegate Called when a Background Http request updates its progress | Interfaces/IBackgroundHttpRequest.h |
| FBackgroundHttpRequestCompleteDelegate | TBaseDelegate_TwoParams< void, FBackgroundHttpRequestPtr, bool > | Delegate called when a Background Http request completes | Interfaces/IBackgroundHttpRequest.h |
| FBackgroundHttpRequestMetricsDelegate | TBaseDelegate_ThreeParams< void, FBackgroundHttpRequestPtr, int32, float > | Delegate called when a Background Http request metrics are ready | Interfaces/IBackgroundHttpRequest.h |
| FBackgroundHttpRequestMetricsExtendedDelegate | TBaseDelegate_TwoParams< void, FBackgroundHttpRequestPtr, FBackgroundHttpRequestMetricsExtended > | Delegate called when a Background Http request extended metrics are ready | Interfaces/IBackgroundHttpRequest.h |
| FBackgroundHttpRequestPtr | TSharedPtr< class IBackgroundHttpRequest, ESPMode::ThreadSafe > | Included as we use EHttpResponseCode. | Interfaces/IBackgroundHttpRequest.h |
| FBackgroundHttpResponsePtr | TSharedPtr< class IBackgroundHttpResponse, ESPMode::ThreadSafe > | Interfaces/IBackgroundHttpRequest.h | |
| FPlatformBackgroundHttp | FGenericPlatformBackgroundHttp | Currently no implementation on Unix. | Unix/UnixPlatformBackgroundHttp.h |
Enums
Public
| Name | Remarks |
|---|---|
| EBackgroundHTTPPriority | Enum used to describe download priority. |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const TCHAR * LexToString
(
EBackgroundHTTPPriority InType |
Interfaces/IBackgroundHttpRequest.h | ||
bool LexTryParseString
(
EBackgroundHTTPPriority& OutMode, |
Interfaces/IBackgroundHttpRequest.h |