IBackgroundHttpManager Class Reference

#include <IBackgroundHttpManager.h>

Inheritance diagram for IBackgroundHttpManager:

Public Member Functions
virtual	~IBackgroundHttpManager ()=default
virtual void	Initialize ()=0
virtual void	Shutdown ()=0
virtual void	AddRequest (const FBackgroundHttpRequestPtr Request)=0
virtual void	RemoveRequest (const FBackgroundHttpRequestPtr Request)=0
virtual void	DeleteAllTemporaryFiles ()=0
virtual bool	IsGenericImplementation () const =0
virtual int	GetMaxActiveDownloads () const =0
virtual void	SetMaxActiveDownloads (int MaxActiveDownloads)=0
virtual FString	GetTempFileLocationForURL (const FString &URL)=0
virtual void	CleanUpDataAfterCompletingRequest (const FBackgroundHttpRequestPtr Request)=0
virtual void	SetCellularPreference (int32 Value)=0
Public Member Functions inherited from TSharedFromThis< IBackgroundHttpManager >
TSharedRef< IBackgroundHttpManager, Mode >	AsShared ()
TSharedRef< IBackgroundHttpManager const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< IBackgroundHttpManager, Mode >	AsWeak ()
TWeakPtr< IBackgroundHttpManager const, Mode >	AsWeak () const
TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const
void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Protected Member Functions
virtual bool	AssociateWithAnyExistingRequest (const FBackgroundHttpRequestPtr Request)=0
Protected Member Functions inherited from TSharedFromThis< IBackgroundHttpManager >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()

Additional Inherited Members
Static Protected Member Functions inherited from TSharedFromThis< IBackgroundHttpManager >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Constructor & Destructor Documentation

~IBackgroundHttpManager()

virtual IBackgroundHttpManager::~IBackgroundHttpManager ( )

virtualdefault

Member Function Documentation

AddRequest()

virtual void IBackgroundHttpManager::AddRequest ( const FBackgroundHttpRequestPtr  Request )

pure virtual

Adds a Background Http request instance to the manager for tracking Manager should always have a list of requests currently being processed

Parameters

Request

- the request object to add

Implemented in FBackgroundHttpManagerImpl, and FApplePlatformBackgroundHttpManager.

AssociateWithAnyExistingRequest()

virtual bool IBackgroundHttpManager::AssociateWithAnyExistingRequest ( const FBackgroundHttpRequestPtr  Request )

protectedpure virtual

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.

Parameters

Request

- The request to check for any existing request matches on.

Returns

bool - true if we found an existing request and associated with it. false otherwise.

Implemented in FBackgroundHttpManagerImpl.

CleanUpDataAfterCompletingRequest()

virtual void IBackgroundHttpManager::CleanUpDataAfterCompletingRequest ( const FBackgroundHttpRequestPtr  Request )

pure virtual

Function that cleans up any persistent data after we have completed a reqeust. Should really never be calling this outside of a BackgroundHTTP class

Implemented in FBackgroundHttpManagerImpl.

DeleteAllTemporaryFiles()

virtual void IBackgroundHttpManager::DeleteAllTemporaryFiles ( )

pure virtual

Function to remove all temporary files used by the system to store completed downloads. This should be called when there are no active background downloads that we care about to regain disk space from background downloads that may no longer be relevant (IE: downloads that were never moved after completion) but are still on disk.

Implemented in FBackgroundHttpManagerImpl.

GetMaxActiveDownloads()

virtual int IBackgroundHttpManager::GetMaxActiveDownloads ( ) const

pure virtual

Function that returns how many active BackgroundHttpRequests we should have actively downloading at once.

Returns

int Number of downloads we should have active at once.

Implemented in FBackgroundHttpManagerImpl.

GetTempFileLocationForURL()

virtual FString IBackgroundHttpManager::GetTempFileLocationForURL ( const FString &  URL )

pure virtual

Function that returns an FString fullpath where we would expect the given URL's temp file to be located

Implemented in FBackgroundHttpManagerImpl.

Initialize()

virtual void IBackgroundHttpManager::Initialize ( )

pure virtual

Initialize

Implemented in FBackgroundHttpManagerImpl.

IsGenericImplementation()

virtual bool IBackgroundHttpManager::IsGenericImplementation ( ) const

pure virtual

Returns whether or not this is a platform specific implementation

Implemented in FGenericPlatformBackgroundHttpManager, and FApplePlatformBackgroundHttpManager.

RemoveRequest()

virtual void IBackgroundHttpManager::RemoveRequest ( const FBackgroundHttpRequestPtr  Request )

pure virtual

Removes a Background Http request instance from the manager Presumably it is done being processed

Parameters

Request

- the request object to remove

Implemented in FBackgroundHttpManagerImpl, and FApplePlatformBackgroundHttpManager.

SetCellularPreference()

virtual void IBackgroundHttpManager::SetCellularPreference ( int32  Value )

pure virtual

Setting cellular preference

Implemented in FBackgroundHttpManagerImpl, and FApplePlatformBackgroundHttpManager.

SetMaxActiveDownloads()

virtual void IBackgroundHttpManager::SetMaxActiveDownloads ( int  MaxActiveDownloads )

pure virtual

Function that sets how many active BackgroundHttpRequests we should have actively downloading at once.

Parameters

MaxActiveDownloads

the maximum number of downloads that should be active at once

Implemented in FBackgroundHttpManagerImpl.

Shutdown()

virtual void IBackgroundHttpManager::Shutdown ( )

pure virtual

Shutdown

Implemented in FBackgroundHttpManagerImpl.

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/Online/BackgroundHTTP/Public/Interfaces/IBackgroundHttpManager.h