Navigation
API > API/Runtime > API/Runtime/BackgroundHTTP
Contains implementation of some common functions that don't have to vary between implementation
| Name | FBackgroundHttpRequestImpl |
| Type | class |
| Header File | /Engine/Source/Runtime/Online/BackgroundHTTP/Public/BackgroundHttpRequestImpl.h |
| Include Path | #include "BackgroundHttpRequestImpl.h" |
Syntax
class FBackgroundHttpRequestImpl : public IBackgroundHttpRequest
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FBackgroundHttpRequestImpl() |
BackgroundHttpRequestImpl.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FBackgroundHttpRequestImpl() |
BackgroundHttpRequestImpl.h |
Structs
| Name | Remarks |
|---|---|
| FDownloadMetricsInfo |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void NotifyNotificationObjectOfComplete
(
const bool bWasSuccess |
BackgroundHttpRequestImpl.h | ||
virtual void NotifyRequestMetricsAvailable
(
const int32 TotalBytesDownloaded, |
BackgroundHttpRequestImpl.h | ||
virtual void OnBackgroundDownloadComplete() |
This should be called from the platform level when a BG download finishes. | BackgroundHttpRequestImpl.h |
Overridden from IBackgroundHttpRequest
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CancelRequest() |
Called to cancel a request that is still being processed | BackgroundHttpRequestImpl.h | |
virtual void CompleteWithExistingResponseData
(
FBackgroundHttpResponsePtr BackgroundResponse |
Function used to complete an IHttpBackgroundRequest from an external source, passing it in a pre-existing response data. | BackgroundHttpRequestImpl.h | |
virtual uint64 GetExpectedResultSize() |
Returns expected result size for the request, set by SetExpectedResultSize. | BackgroundHttpRequestImpl.h | |
virtual const FString & GetRequestID() |
Gets the associated RequestID for this BackgroundDownload. | BackgroundHttpRequestImpl.h | |
virtual EBackgroundHTTPPriority GetRequestPriority () |
Gets the associated Requeset's Priority for Background Downloadings. | BackgroundHttpRequestImpl.h | |
virtual const FBackgroundHttpResponsePtr GetResponse() |
Get the associated Response | BackgroundHttpRequestImpl.h | |
virtual const TArray< FString > & GetURLList() |
Gets the current URL List that this background request is currently processing. | BackgroundHttpRequestImpl.h | |
virtual 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. | BackgroundHttpRequestImpl.h | |
virtual FBackgroundHttpRequestCompleteDelegate & OnProcessRequestComplete() |
Delegate called when the request is complete. See FBackgroundHttpRequestCompleteDelegate | BackgroundHttpRequestImpl.h | |
virtual FBackgroundHttpProgressUpdateDelegate & OnProgressUpdated() |
Delegate called when the request has a progress update. | BackgroundHttpRequestImpl.h | |
virtual FBackgroundHttpRequestMetricsDelegate & OnRequestMetrics() |
Delegate called when the request's metrics were calculated | BackgroundHttpRequestImpl.h | |
virtual void PauseRequest() |
Called to pause a request that is still being processed | BackgroundHttpRequestImpl.h | |
virtual bool ProcessRequest() |
IBackgroundHttpRequest. | BackgroundHttpRequestImpl.h | |
virtual void ResumeRequest() |
Called to resume a request that was previously paused | BackgroundHttpRequestImpl.h | |
virtual void SetCompleteNotification
(
FBackgroundHttpNotificationObjectPtr DownloadCompleteNotificationObject |
Sets an FHTTPRequestDownloadNotificationObject to be mapped to this HTTPRequest. | BackgroundHttpRequestImpl.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. | BackgroundHttpRequestImpl.h | |
virtual void SetRequestID
(
const FString& NewRequestID |
Sets the associated RequestID for this BackgroundDownload. | BackgroundHttpRequestImpl.h | |
virtual void SetRequestPriority
(
EBackgroundHTTPPriority NewPriority |
Sets the associated Requeset's Priority for Background Downloadings. | BackgroundHttpRequestImpl.h | |
virtual void SetURLAsList
(
const TArray< FString >& URLs, |
Sets up a list of URLs to automatically fall through as each one fails. | BackgroundHttpRequestImpl.h |