UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
IOSBackgroundURLSessionHandler.cpp File Reference

Classes

class  FBackgroundNSURLSessionDownloadTaskData
 
class  FBackgroundNSURLCDNInfo
 
class  FBackgroundNSURLSession
 

Macros

#define UE_DNLD_LOG(...)   LogIOSBackgroundDownloadMessage([NSString stringWithFormat:__VA_ARGS__])
 

Enumerations

enum class  EBackgroundNSURLCDNInfoResponse : uint32 { Ok = 1 , Timeout = 2 , Error = 3 }
 

Functions

 DEFINE_LOG_CATEGORY_STATIC (LogIOSBackgroundDownload, Log, All)
 

Variables

NSString *const SerializationKeyProtocolVersion = @"v"
 
NSString *const SerializationKeyCDNs = @"c"
 
NSString *const SerializationKeyPath = @"p"
 
NSString *const SerializationKeyRetryCountPerURL = @"r"
 
NSString *const SerializationKeyExpectedResultSize = @"s"
 
NSString *const SerializationKeyExpectedResultSizeFromHeaderRequest = @"h"
 
NSURLSession_HeadRequestSession
 
NSMutableDictionary< __kindof NSNumber *, __kindof NSURLSessionDownloadTask * > * _AllDownloads
 
NSUInteger _NextDownloadId
 
std::promise< void_AllDownloadsPromise
 
std::future< void_AllDownloadsFuture
 
NSMutableArray< __kindof FBackgroundNSURLCDNInfo * > * _CDNInfo
 
NSTimer_ForegroundStaleDownloadCheckTimer
 
BackgroundHttpFileHashHelperPtr _HelperPtr
 
int32 _MaximumConnectionsPerHost
 
int32 _RetryResumeDataLimit
 
int32 _HeadRequestTimeout
 
bool _bCDNReorderByPingTime
 
double _CheckForForegroundStaleDownloadsWithInterval
 
double _ForegroundStaleDownloadTimeout
 
std::atomic< bool_bAnyTaskDidCompleteWithError
 
NSString *const NSURLSessionIdentifier = @"com.epicgames.backgrounddownloads"
 
NSProgressUserInfoKey const NSProgressDownloadLastUpdateTime = @"com.epicgames.nsprogress.lastupdatetime"
 
NSProgressUserInfoKey const NSProgressDownloadCompletedBytes = @"com.epicgames.nsprogress.completedbytes"
 
NSProgressUserInfoKey const NSProgressDownloadResultStatusCode = @"com.epicgames.nsprogress.resultstatuscode"
 
NSProgressUserInfoKey const NSProgressDownloadResultTempFilePath = @"com.epicgames.nsprogress.tempfilepath"
 

Macro Definition Documentation

◆ UE_DNLD_LOG

#define UE_DNLD_LOG (   ...)    LogIOSBackgroundDownloadMessage([NSString stringWithFormat:__VA_ARGS__])

Enumeration Type Documentation

◆ EBackgroundNSURLCDNInfoResponse

Enumerator
Ok 
Timeout 
Error 

Function Documentation

◆ DEFINE_LOG_CATEGORY_STATIC()

DEFINE_LOG_CATEGORY_STATIC ( LogIOSBackgroundDownload  ,
Log  ,
All   
)

Variable Documentation

◆ _AllDownloads

◆ _AllDownloadsFuture

std::future<void> _AllDownloadsFuture

◆ _AllDownloadsPromise

std::promise<void> _AllDownloadsPromise

◆ _bAnyTaskDidCompleteWithError

std::atomic<bool> _bAnyTaskDidCompleteWithError

◆ _bCDNReorderByPingTime

bool _bCDNReorderByPingTime

◆ _CDNInfo

◆ _CheckForForegroundStaleDownloadsWithInterval

double _CheckForForegroundStaleDownloadsWithInterval

◆ _ForegroundStaleDownloadCheckTimer

NSTimer* _ForegroundStaleDownloadCheckTimer

◆ _ForegroundStaleDownloadTimeout

double _ForegroundStaleDownloadTimeout

◆ _HeadRequestSession

NSURLSession* _HeadRequestSession
Initial value:
{
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127

◆ _HeadRequestTimeout

int32 _HeadRequestTimeout

◆ _HelperPtr

◆ _MaximumConnectionsPerHost

int32 _MaximumConnectionsPerHost

◆ _NextDownloadId

NSUInteger _NextDownloadId

◆ _RetryResumeDataLimit

int32 _RetryResumeDataLimit

◆ NSProgressDownloadCompletedBytes

NSProgressUserInfoKey const NSProgressDownloadCompletedBytes = @"com.epicgames.nsprogress.completedbytes"

◆ NSProgressDownloadLastUpdateTime

NSProgressUserInfoKey const NSProgressDownloadLastUpdateTime = @"com.epicgames.nsprogress.lastupdatetime"

◆ NSProgressDownloadResultStatusCode

NSProgressUserInfoKey const NSProgressDownloadResultStatusCode = @"com.epicgames.nsprogress.resultstatuscode"

◆ NSProgressDownloadResultTempFilePath

NSProgressUserInfoKey const NSProgressDownloadResultTempFilePath = @"com.epicgames.nsprogress.tempfilepath"

◆ NSURLSessionIdentifier

NSString* const NSURLSessionIdentifier = @"com.epicgames.backgrounddownloads"

◆ SerializationKeyCDNs

NSString* const SerializationKeyCDNs = @"c"

◆ SerializationKeyExpectedResultSize

NSString* const SerializationKeyExpectedResultSize = @"s"

◆ SerializationKeyExpectedResultSizeFromHeaderRequest

NSString* const SerializationKeyExpectedResultSizeFromHeaderRequest = @"h"

◆ SerializationKeyPath

NSString* const SerializationKeyPath = @"p"

◆ SerializationKeyProtocolVersion

NSString* const SerializationKeyProtocolVersion = @"v"

◆ SerializationKeyRetryCountPerURL

NSString* const SerializationKeyRetryCountPerURL = @"r"