UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FBackgroundHttpFileHashHelper Class Reference

#include <BackgroundHttpFileHashHelper.h>

Public Member Functions

 FBackgroundHttpFileHashHelper ()
 
BACKGROUNDHTTPFILEHASH_API void LoadData ()
 
BACKGROUNDHTTPFILEHASH_API void SaveData ()
 
BACKGROUNDHTTPFILEHASH_API FString ToString () const
 
BACKGROUNDHTTPFILEHASH_API bool InitFromString (const FString &StringIn)
 
BACKGROUNDHTTPFILEHASH_API bool FindTempFilenameMappingForURL (const FString &URL, FString &OutTempFilename) const
 
BACKGROUNDHTTPFILEHASH_API const FString * FindTempFilenameMappingForURL (const FString &URL) const
 
BACKGROUNDHTTPFILEHASH_API const FString & FindOrAddTempFilenameMappingForURL (const FString &URL)
 
BACKGROUNDHTTPFILEHASH_API void RemoveURLMapping (const FString &URL)
 
BACKGROUNDHTTPFILEHASH_API bool FindMappedURLForTempFilename (const FString &TempFilename, FString &OutMappedURL) const
 
BACKGROUNDHTTPFILEHASH_API const FString * FindMappedURLForTempFilename (const FString &TempFilename) const
 
BACKGROUNDHTTPFILEHASH_API void DeleteURLMappingsWithoutTempFiles ()
 

Static Public Member Functions

static BACKGROUNDHTTPFILEHASH_API const FString & GetTemporaryRootPath ()
 
static BACKGROUNDHTTPFILEHASH_API const FString & GetTempFileExtension ()
 
static BACKGROUNDHTTPFILEHASH_API FString GetFullPathOfTempFilename (const FString &TempFilename)
 

Detailed Description

Helper that handles generating unique hashed file paths to use store to store BackgroundHTTP work once completed. Can be saved and loaded to/from disk to handle persistence across session when background work is compelted without any usefull program state. NOTE: This is in it's own separate module as some platforms (IOS, etc.) need to include this functionality in ApplicationCore and thus fully adding a dependency to those modules on BackgroundHTTP would not work

Constructor & Destructor Documentation

◆ FBackgroundHttpFileHashHelper()

FBackgroundHttpFileHashHelper::FBackgroundHttpFileHashHelper ( )
inline

Member Function Documentation

◆ DeleteURLMappingsWithoutTempFiles()

void FBackgroundHttpFileHashHelper::DeleteURLMappingsWithoutTempFiles ( )

◆ FindMappedURLForTempFilename() [1/2]

const FString * FBackgroundHttpFileHashHelper::FindMappedURLForTempFilename ( const FString &  TempFilename) const

◆ FindMappedURLForTempFilename() [2/2]

bool FBackgroundHttpFileHashHelper::FindMappedURLForTempFilename ( const FString &  TempFilename,
FString &  OutMappedURL 
) const

◆ FindOrAddTempFilenameMappingForURL()

const FString & FBackgroundHttpFileHashHelper::FindOrAddTempFilenameMappingForURL ( const FString &  URL)

◆ FindTempFilenameMappingForURL() [1/2]

const FString * FBackgroundHttpFileHashHelper::FindTempFilenameMappingForURL ( const FString &  URL) const

◆ FindTempFilenameMappingForURL() [2/2]

bool FBackgroundHttpFileHashHelper::FindTempFilenameMappingForURL ( const FString &  URL,
FString &  OutTempFilename 
) const

◆ GetFullPathOfTempFilename()

FString FBackgroundHttpFileHashHelper::GetFullPathOfTempFilename ( const FString &  TempFilename)
static

◆ GetTempFileExtension()

const FString & FBackgroundHttpFileHashHelper::GetTempFileExtension ( )
static

◆ GetTemporaryRootPath()

const FString & FBackgroundHttpFileHashHelper::GetTemporaryRootPath ( )
static

◆ InitFromString()

bool FBackgroundHttpFileHashHelper::InitFromString ( const FString &  StringIn)

◆ LoadData()

void FBackgroundHttpFileHashHelper::LoadData ( )

◆ RemoveURLMapping()

void FBackgroundHttpFileHashHelper::RemoveURLMapping ( const FString &  URL)

◆ SaveData()

void FBackgroundHttpFileHashHelper::SaveData ( )

◆ ToString()

FString FBackgroundHttpFileHashHelper::ToString ( ) const

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