Navigation
API > API/Runtime > API/Runtime/BackgroundHTTP
Inheritance Hierarchy
- TSharedFromThis
- IBackgroundHttpRequest
- FBackgroundHttpRequestImpl
- FGenericPlatformBackgroundHttpRequest
References
| Module | BackgroundHTTP |
| Header | /Engine/Source/Runtime/Online/BackgroundHTTP/Public/BackgroundHttpRequestImpl.h |
| Include | #include "BackgroundHttpRequestImpl.h" |
Syntax
class FBackgroundHttpRequestImpl : public IBackgroundHttpRequest
Remarks
Contains implementation of some common functions that don't have to vary between implementation
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
TSharedPtr< FBackgroundHttpNotificationObject, ESPMode::ThreadSafe > | DownloadCompleteNotificationObject | |
 |
FBackgroundHttpProgressUpdateDelegate | HttpProgressUpdateDelegate | |
 |
FBackgroundHttpRequestCompleteDelegate | HttpRequestCompleteDelegate | |
 |
int | NumberOfTotalRetries | |
 |
FString | RequestID | |
 |
EBackgroundHTTPPriority | RequestPriority | |
 |
FBackgroundHttpResponsePtr | Response | |
 |
TArray< FString > | URLList |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
void | NotifyNotificationObjectOfComplete
(
bool bWasSuccess |
|
  |
void | This should be called from the platform level when a BG download finishes. |
Overridden from IBackgroundHttpRequest
| Type | Name | Description | |
|---|---|---|---|
  |
void | Called to cancel a request that is still being processed | |
  |
void | CompleteWithExistingResponseData
(
FBackgroundHttpResponsePtr BackgroundResponse |
Function used to complete an IHttpBackgroundRequest from an external source, passing it in a pre-existing response data. |
   |
const FString & | GetRequestID () |
Gets the associated RequestID for this BackgroundDownload. |
   |
EBackgroundHTTPPriority | Gets the associated Requeset's Priority for Background Downloadings. | |
   |
const FBackgroundHttpResponsePtr | GetResponse () |
Get the associated Response |
   |
const TArray< FString > & | GetURLList () |
Gets the current URL List that this background request is currently processing. |
  |
bool | Called by certain platform's implementation when we have to wait for the BackgroundHttpManager / PlatformBackgroundHttp to do some work before we can finish our ProcessRequest call. | |
  |
FBackgroundHttpRequestCompleteDelegate & | Delegate called when the request is complete. See FBackgroundHttpRequestCompleteDelegate | |
  |
FBackgroundHttpProgressUpdateDelegate & | Delegate called when the request has a progress update. | |
  |
void | PauseRequest () |
Called to pause a request that is still being processed |
  |
bool | IBackgroundHttpRequest. | |
  |
void | Called to resume a request that was previously paused | |
  |
void | SetCompleteNotification
(
FBackgroundHttpNotificationObjectPtr DownloadCompleteNotificationObject |
Sets an FHTTPRequestDownloadNotificationObject to be mapped to this HTTPRequest. |
  |
void | SetRequestID
(
const FString& NewRequestID |
Sets the associated RequestID for this BackgroundDownload. |
  |
void | SetRequestPriority
(
EBackgroundHTTPPriority NewPriority |
Sets the associated Requeset's Priority for Background Downloadings. |
  |
void | SetURLAsList
(
const TArray< FString >& URLs, |
Sets up a list of URLs to automatically fall through as each one fails. |