IBackgroundHttpManager

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

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  
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  
  Interfaces/IBackgroundHttpManager.h  

FString GetTempFileLocationForURL ( const FString& URL,
const FString& RequestID
)

 Function that returns an FString fullpath where we would expect the given URL's temp part of the given RequestID to be located Interfaces/IBackgroundHttpManager.h  

void Initialize ( bool bClearPreExistingRequestsAtStartup
)

 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 network preference Interfaces/IBackgroundHttpManager.h  

void SetLimitedDataPreference ( int32 Value
)

 Setting limited data network 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  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual void GetActiveDownloadRequestIDs ( TSet< FString >& OutActiveIDs
) const

 Returns the set of RequestIDs that are actively being downloaded by the platform. Interfaces/IBackgroundHttpManager.h  

virtual void RequeueRequest ( const FBackgroundHttpRequestPtr Request
)

 Re-queues an active request by canceling the current platform download and creating a fresh one. 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  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page