Navigation
API > API/Runtime > API/Runtime/BackgroundHTTP
Interface for Http requests (created using FHttpFactory)
| Name | IBackgroundHttpRequest |
| Type | class |
| Header File | /Engine/Source/Runtime/Online/BackgroundHTTP/Public/Interfaces/IBackgroundHttpRequest.h |
| Include Path | #include "Interfaces/IBackgroundHttpRequest.h" |
Syntax
class IBackgroundHttpRequest : public TSharedFromThis< IBackgroundHttpRequest, ESPMode::ThreadSafe >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → IBackgroundHttpRequest
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IBackgroundHttpRequest() |
Destructor for overrides | Interfaces/IBackgroundHttpRequest.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CancelRequest() |
Called to cancel a request that is still being processed | Interfaces/IBackgroundHttpRequest.h | |
void CompleteWithExistingResponseData
(
FBackgroundHttpResponsePtr BackgroundResponse |
Function used to complete an IHttpBackgroundRequest from an external source, passing it in a pre-existing response data. | Interfaces/IBackgroundHttpRequest.h | |
| Returns debug text for download screen to help troubleshoot download issues | Interfaces/IBackgroundHttpRequest.h | ||
virtual uint64 GetExpectedResultSize() |
Returns expected result size for the request, set by SetExpectedResultSize. | Interfaces/IBackgroundHttpRequest.h | |
const FString & GetRequestID() |
Gets the associated RequestID for this BackgroundDownload. | Interfaces/IBackgroundHttpRequest.h | |
| Gets the associated Requeset's Priority for Background Downloadings. | Interfaces/IBackgroundHttpRequest.h | ||
const FBackgroundHttpResponsePtr GetResponse() |
Get the associated Response | Interfaces/IBackgroundHttpRequest.h | |
| Gets the current URL List that this background request is currently processing. | Interfaces/IBackgroundHttpRequest.h | ||
bool HandleDelayedProcess () |
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. | Interfaces/IBackgroundHttpRequest.h | |
FBackgroundHttpRequestCompleteDelegate & OnProcessRequestComplete() |
Delegate called when the request is complete. See FBackgroundHttpRequestCompleteDelegate | Interfaces/IBackgroundHttpRequest.h | |
FBackgroundHttpProgressUpdateDelegate & OnProgressUpdated() |
Delegate called when the request has a progress update. | Interfaces/IBackgroundHttpRequest.h | |
FBackgroundHttpRequestMetricsDelegate & OnRequestMetrics() |
Delegate called when the request's metrics were calculated | Interfaces/IBackgroundHttpRequest.h | |
FBackgroundHttpRequestMetricsExtendedDelegate & OnRequestMetricsExtended() |
Delegate called when the request's extended metrics were calculated | Interfaces/IBackgroundHttpRequest.h | |
void PauseRequest() |
Called to pause a request that is still being processed | Interfaces/IBackgroundHttpRequest.h | |
bool ProcessRequest () |
Called to begin processing the request. | Interfaces/IBackgroundHttpRequest.h | |
void ResumeRequest() |
Called to resume a request that was previously paused | Interfaces/IBackgroundHttpRequest.h | |
void SetCompleteNotification
(
FBackgroundHttpNotificationObjectPtr DownloadCompleteNotificationObject |
Sets an FHTTPRequestDownloadNotificationObject to be mapped to this HTTPRequest. | Interfaces/IBackgroundHttpRequest.h | |
virtual void SetExpectedResultSize
(
const uint64 ExpectedSize |
Sets expected result size for the request, might be used by the implementation to check file size before invoking completion notification. | Interfaces/IBackgroundHttpRequest.h | |
virtual void SetMetrics
(
const int32 TotalBytesDownloaded, |
Set metrics for analytics event | Interfaces/IBackgroundHttpRequest.h | |
virtual void SetMetricsExtended
(
const FBackgroundHttpRequestMetricsExtended ExtendedMetrics |
Set extended metrics for analytics event | Interfaces/IBackgroundHttpRequest.h | |
void SetRequestID
(
const FString& NewRequestID |
Sets the associated RequestID for this BackgroundDownload. | Interfaces/IBackgroundHttpRequest.h | |
void SetRequestPriority
(
EBackgroundHTTPPriority NewPriority |
Sets the associated Requeset's Priority for Background Downloadings. | Interfaces/IBackgroundHttpRequest.h | |
void SetURLAsList
(
const TArray< FString >& URLs, |
Sets up a list of URLs to automatically fall through as each one fails. | Interfaces/IBackgroundHttpRequest.h |