Navigation
API > API/Runtime > API/Runtime/BackgroundHTTP
| Name | IBackgroundHttpManager |
| Type | class |
| Header File | /Engine/Source/Runtime/Online/BackgroundHTTP/Public/Interfaces/IBackgroundHttpManager.h |
| Include Path | #include "Interfaces/IBackgroundHttpManager.h" |
Syntax
class IBackgroundHttpManager : public TSharedFromThis< IBackgroundHttpManager >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → IBackgroundHttpManager
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IBackgroundHttpManager() |
Interfaces/IBackgroundHttpManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddRequest
(
const FBackgroundHttpRequestPtr Request |
Adds a Background Http request instance to the manager for tracking Manager should always have a list of requests currently being processed | Interfaces/IBackgroundHttpManager.h | |
void CleanUpDataAfterCompletingRequest
(
const FBackgroundHttpRequestPtr Request |
Function that cleans up any persistent data after we have completed a reqeust. | Interfaces/IBackgroundHttpManager.h | |
void DeleteAllTemporaryFiles () |
Function to remove all temporary files used by the system to store completed downloads. | Interfaces/IBackgroundHttpManager.h | |
int GetMaxActiveDownloads() |
Function that returns how many active BackgroundHttpRequests we should have actively downloading at once. | Interfaces/IBackgroundHttpManager.h | |
| Function that returns an FString fullpath where we would expect the given URL's temp file to be located | Interfaces/IBackgroundHttpManager.h | ||
void Initialize() |
Initialize | Interfaces/IBackgroundHttpManager.h | |
bool IsGenericImplementation() |
Returns whether or not this is a platform specific implementation | Interfaces/IBackgroundHttpManager.h | |
void RemoveRequest
(
const FBackgroundHttpRequestPtr Request |
Removes a Background Http request instance from the manager Presumably it is done being processed | Interfaces/IBackgroundHttpManager.h | |
void SetCellularPreference
(
int32 Value |
Setting cellular preference | Interfaces/IBackgroundHttpManager.h | |
void SetMaxActiveDownloads
(
int MaxActiveDownloads |
Function that sets how many active BackgroundHttpRequests we should have actively downloading at once. | Interfaces/IBackgroundHttpManager.h | |
void Shutdown() |
Shutdown | Interfaces/IBackgroundHttpManager.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AssociateWithAnyExistingRequest
(
const FBackgroundHttpRequestPtr Request |
Designed to be called internally by AddRequest to associate our incoming request with any previously completed background downloads (might have completed before this app launch, or carried over from a previous application launch and be running without any other information. | Interfaces/IBackgroundHttpManager.h |