UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
FApplePlatformBackgroundHttpManager Class Reference

#include <ApplePlatformBackgroundHttpManager.h>

+ Inheritance diagram for FApplePlatformBackgroundHttpManager:

Public Member Functions

 FApplePlatformBackgroundHttpManager ()
 
virtual ~FApplePlatformBackgroundHttpManager ()
 
virtual void AddRequest (const FBackgroundHttpRequestPtr Request) override
 
virtual void RemoveRequest (const FBackgroundHttpRequestPtr Request) override
 
virtual void SetCellularPreference (int32 Value) override
 
virtual bool IsGenericImplementation () const override
 
virtual bool Tick (float DeltaTime) override
 
- Public Member Functions inherited from FBackgroundHttpManagerImpl
BACKGROUNDHTTP_API FBackgroundHttpManagerImpl ()
 
virtual BACKGROUNDHTTP_API ~FBackgroundHttpManagerImpl ()
 
virtual BACKGROUNDHTTP_API void Initialize () override
 
virtual BACKGROUNDHTTP_API void Shutdown () override
 
virtual BACKGROUNDHTTP_API void DeleteAllTemporaryFiles () override
 
virtual BACKGROUNDHTTP_API int GetMaxActiveDownloads () const override
 
virtual BACKGROUNDHTTP_API void SetMaxActiveDownloads (int MaxActiveDownloads) override
 
virtual BACKGROUNDHTTP_API FString GetTempFileLocationForURL (const FString &URL) override
 
virtual BACKGROUNDHTTP_API void CleanUpDataAfterCompletingRequest (const FBackgroundHttpRequestPtr Request) override
 
- Public Member Functions inherited from IBackgroundHttpManager
virtual ~IBackgroundHttpManager ()=default
 
- 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
 
- Public Member Functions inherited from FTSTickerObjectBase
 UE_NONCOPYABLE (FTSTickerObjectBase)
 
CORE_API FTSTickerObjectBase (float InDelay=0.0f, FTSTicker &Ticker=FTSTicker::GetCoreTicker())
 
virtual CORE_API ~FTSTickerObjectBase ()
 

Additional Inherited Members

- Protected Member Functions inherited from FBackgroundHttpManagerImpl
virtual BACKGROUNDHTTP_API bool AssociateWithAnyExistingRequest (const FBackgroundHttpRequestPtr Request) override
 
virtual BACKGROUNDHTTP_API bool CheckForExistingCompletedDownload (const FBackgroundHttpRequestPtr Request, FString &ExistingFilePathOut, int64 &ExistingFileSizeOut)
 
virtual BACKGROUNDHTTP_API void ActivatePendingRequests ()
 
virtual BACKGROUNDHTTP_API void DeleteStaleTempFiles ()
 
virtual BACKGROUNDHTTP_API void GatherAllTempFilenames (TArray< FString > &OutAllTempFilenames, bool bOutputAsFullPaths=false) const
 
virtual BACKGROUNDHTTP_API void ConvertAllTempFilenamesToFullPaths (TArray< FString > &OutFilenamesAsFullPaths, const TArray< FString > &FilenamesToConvertToFullPaths) const
 
virtual BACKGROUNDHTTP_API void GatherTempFilesOlderThen (TArray< FString > &OutTimedOutTempFilenames, double SecondsToConsiderOld, TArray< FString > *OptionalFileList=nullptr) const
 
virtual BACKGROUNDHTTP_API void GatherTempFilesWithoutURLMappings (TArray< FString > &OutTempFilesMissingURLMappings, TArray< FString > *OptionalFileList=nullptr) const
 
virtual BackgroundHttpFileHashHelperRef GetFileHashHelper ()
 
virtual const BackgroundHttpFileHashHelperRef GetFileHashHelper () const
 
- Protected Member Functions inherited from TSharedFromThis< IBackgroundHttpManager >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThis & operator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 
- 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)
 
- Protected Attributes inherited from FBackgroundHttpManagerImpl
TArray< FBackgroundHttpRequestPtr > PendingStartRequests
 
FRWLock PendingRequestLock
 
TArray< FBackgroundHttpRequestPtr > ActiveRequests
 
FRWLock ActiveRequestLock
 
volatile int NumCurrentlyActiveRequests
 
TAtomic< int > MaxActiveDownloads
 

Detailed Description

Manages Background Http request that are currently being processed if we are on an Apple Platform

Constructor & Destructor Documentation

◆ FApplePlatformBackgroundHttpManager()

FApplePlatformBackgroundHttpManager::FApplePlatformBackgroundHttpManager ( )

◆ ~FApplePlatformBackgroundHttpManager()

FApplePlatformBackgroundHttpManager::~FApplePlatformBackgroundHttpManager ( )
virtual

Member Function Documentation

◆ AddRequest()

void FApplePlatformBackgroundHttpManager::AddRequest ( const FBackgroundHttpRequestPtr  Request)
overridevirtual

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

Reimplemented from FBackgroundHttpManagerImpl.

◆ IsGenericImplementation()

virtual bool FApplePlatformBackgroundHttpManager::IsGenericImplementation ( ) const
inlineoverridevirtual

Returns whether or not this is a platform specific implementation

Implements IBackgroundHttpManager.

◆ RemoveRequest()

void FApplePlatformBackgroundHttpManager::RemoveRequest ( const FBackgroundHttpRequestPtr  Request)
overridevirtual

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

Parameters
Request- the request object to remove

Reimplemented from FBackgroundHttpManagerImpl.

◆ SetCellularPreference()

void FApplePlatformBackgroundHttpManager::SetCellularPreference ( int32  Value)
overridevirtual

Setting cellular preference

Reimplemented from FBackgroundHttpManagerImpl.

◆ Tick()

bool FApplePlatformBackgroundHttpManager::Tick ( float  DeltaTime)
overridevirtual

Pure virtual that must be overloaded by the inheriting class.

Parameters
DeltaTimetime passed since the last call.
Returns
true if should continue ticking

Reimplemented from FBackgroundHttpManagerImpl.

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