FBackgroundHttpManagerImpl | Unreal Engine 5.4 Documentation

API > API/Runtime > API/Runtime/BackgroundHTTP

Inheritance Hierarchy

References


Module	BackgroundHTTP
Header	/Engine/Source/Runtime/Online/BackgroundHTTP/Public/BackgroundHttpManagerImpl.h
Include	#include "BackgroundHttpManagerImpl.h"

Syntax

class FBackgroundHttpManagerImpl :  
    public IBackgroundHttpManager ,  
    public FTSTickerObjectBase

Remarks

Contains implementation of some common functions that don't vary between implementation

Variables

Type	Name	Description
FRWLock	ActiveRequestLock
TArray< FBackgroundHttpRequestPtr >	ActiveRequests	List of Background Http requests that are actively being processed
TAtomic< int >	MaxActiveDownloads
volatile int	NumCurrentlyActiveRequests	Count of how many requests we have active
FRWLock	PendingRequestLock
TArray< FBackgroundHttpRequestPtr >	PendingStartRequests	List of Background Http requests that we have called AddRequest on, but have not yet started due to platform active download limits

Constructors

	Type	Name	Description
		FBackgroundHttpManagerImpl ()

Destructors

	Type	Name	Description
		~FBackgroundHttpManagerImpl ()

Functions

Type	Name	Description
void	ActivatePendingRequests ()
bool	CheckForExistingCompletedDownload ( const FBackgroundHttpRequestPtr Request, FString& ExistingFilePathOut, int64& ExistingFileSizeOut )
void	ConvertAllTempFilenamesToFullPaths ( TArray< FString >& OutFilenamesAsFullPaths, const TArray< FString >& FilenamesToConvertToFullPaths )	Helper function that converts the supplied list of Temp folder filenames to a list that is always all full paths.
void	DeleteStaleTempFiles ()	Different from DeleteAllTemporaryFiles as this doesn't delete all files but rather cleans up specific bad files that have gone stale.
void	GatherAllTempFilenames ( TArray< FString >& OutAllTempFilenames, bool bOutputAsFullPaths )	Gets a list of full filenames for all temp files.
void	GatherTempFilesOlderThen ( TArray< FString >& OutTimedOutTempFilenames, double SecondsToConsiderOld, TArray< FString >* OptionalFileList )	Gather a list of any temp files that have timed out of our BackgroundHTTP settings.
void	GatherTempFilesWithoutURLMappings ( TArray< FString >& OutTempFilesMissingURLMappings, TArray< FString >* OptionalFileList )	Gather a list of any temp files that have no corresponding URL Mapping entry If OptionalFileListToCheck is empty will check all temp files in the backgroundhttp temp file folder.
BackgroundHttpFileHashHelperRef	GetFileHashHelper ()	Gets our FileHashHelper to compute temp file mappings.
const BackgroundHttpFileHashHelperRef	GetFileHashHelper ()

Overridden from IBackgroundHttpManager

Type	Name	Description
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
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.
void	CleanUpDataAfterCompletingRequest ( const FBackgroundHttpRequestPtr Request )	Function that cleans up any persistent data after we have completed a reqeust.
void	DeleteAllTemporaryFiles ()	Function to remove all temporary files used by the system to store completed downloads.
int	GetMaxActiveDownloads ()	Function that returns how many active BackgroundHttpRequests we should have actively downloading at once.
FString	GetTempFileLocationForURL ( const FString& URL )	Function that returns an FString fullpath where we would expect the given URL's temp file to be located
void	Initialize ()	Initialize
void	RemoveRequest ( const FBackgroundHttpRequestPtr Request )	Removes a Background Http request instance from the manager Presumably it is done being processed
void	SetCellularPreference ( int32 Value )	Setting cellular preference
void	SetMaxActiveDownloads ( int MaxActiveDownloads )	Function that sets how many active BackgroundHttpRequests we should have actively downloading at once.
void	Shutdown ()	Shutdown