1. Epic GamesDeveloper
  3. FBackgroundHttpManagerImpl

FBackgroundHttpManagerImpl

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

API > API/Runtime > API/Runtime/BackgroundHTTP

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

   
Name FBackgroundHttpManagerImpl
Type class
Header File /Engine/Source/Runtime/Online/BackgroundHTTP/Public/BackgroundHttpManagerImpl.h
Include Path #include "BackgroundHttpManagerImpl.h"

Syntax

class FBackgroundHttpManagerImpl :  
    public IBackgroundHttpManager ,  
    public FTSTickerObjectBase

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FBackgroundHttpManagerImpl()

   BackgroundHttpManagerImpl.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FBackgroundHttpManagerImpl()

   BackgroundHttpManagerImpl.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
FileHashHelper BackgroundHttpFileHashHelperRef   BackgroundHttpManagerImpl.h  

Functions

Public

Overridden from IBackgroundHttpManager

Name Remarks Include Path Unreal Specifiers

virtual 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 BackgroundHttpManagerImpl.h  

virtual void CleanUpDataAfterCompletingRequest ( const FBackgroundHttpRequestPtr Request
)

 Function that cleans up any persistent data after we have completed a reqeust. BackgroundHttpManagerImpl.h  

virtual void DeleteAllTemporaryFiles ()

 Function to remove all temporary files used by the system to store completed downloads. BackgroundHttpManagerImpl.h  

virtual int GetMaxActiveDownloads()

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

virtual FString GetTempFileLocationForURL ( const FString& URL
)

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

virtual void Initialize()

 Initialize BackgroundHttpManagerImpl.h  

virtual void RemoveRequest ( const FBackgroundHttpRequestPtr Request
)

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

virtual void SetCellularPreference ( int32 Value
)

 Setting cellular preference BackgroundHttpManagerImpl.h  

virtual void SetMaxActiveDownloads ( int MaxActiveDownloads
)

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

virtual void Shutdown()

 Shutdown BackgroundHttpManagerImpl.h  

Overridden from FTSTickerObjectBase

Name Remarks Include Path Unreal Specifiers

virtual bool Tick ( float DeltaTime
)

 FTSTickerObjectBase implementation. BackgroundHttpManagerImpl.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void ActivatePendingRequests()

   BackgroundHttpManagerImpl.h  

virtual bool CheckForExistingCompletedDownload ( const FBackgroundHttpRequestPtr Request,
FString& ExistingFilePathOut,
int64& ExistingFileSizeOut
)

   BackgroundHttpManagerImpl.h  

virtual void ConvertAllTempFilenamesToFullPaths ( TArray< FString >& OutFilenamesAsFullPaths,
const TArray< FString >& FilenamesToConvertToFullPaths
) const

 Helper function that converts the supplied list of Temp folder filenames to a list that is always all full paths. BackgroundHttpManagerImpl.h  

virtual void DeleteStaleTempFiles()

 Different from DeleteAllTemporaryFiles as this doesn't delete all files but rather cleans up specific bad files that have gone stale. BackgroundHttpManagerImpl.h  

virtual void GatherAllTempFilenames ( TArray< FString >& OutAllTempFilenames,
bool bOutputAsFullPaths
) const

 Gets a list of full filenames for all temp files. BackgroundHttpManagerImpl.h  

virtual void GatherTempFilesOlderThen ( TArray< FString >& OutTimedOutTempFilenames,
double SecondsToConsiderOld,
TArray< FString >* OptionalFileList
) const

 Gather a list of any temp files that have timed out of our BackgroundHTTP settings. BackgroundHttpManagerImpl.h  

virtual void GatherTempFilesWithoutURLMappings ( TArray< FString >& OutTempFilesMissingURLMappings,
TArray< FString >* OptionalFileList
) const

 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. BackgroundHttpManagerImpl.h  

virtual BackgroundHttpFileHashHelperRef GetFileHashHelper ()

 Gets our FileHashHelper to compute temp file mappings. BackgroundHttpManagerImpl.h  

virtual const BackgroundHttpFileHashHelperRef GetFileHashHelper ()

   BackgroundHttpManagerImpl.h  

Overridden from IBackgroundHttpManager

Name Remarks Include Path Unreal Specifiers

virtual 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. BackgroundHttpManagerImpl.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page