BackgroundHttpResourceTimeout

BackgroundHttpResourceTimeout

#Overview

name: BackgroundHttpResourceTimeout

The value of this variable can be defined or overridden in .ini config files. 1 .ini config file referencing this setting variable.

It is referenced in 1 C++ source file.

#Summary

#Setting Variables

#References In INI files

Location: <Workspace>/Engine/Config/IOS/BaseIOSEngine.ini:49, section: [BackgroundHttp.iOSSettings]

#References in C++ code

#Callsites

This variable is referenced in the following C++ source code:

#Loc: <Workspace>/Engine/Source/Runtime/ApplicationCore/Private/IOS/IOSBackgroundURLSessionHandler.cpp:41

Scope (from outer to inner):

file
function     bool FBackgroundURLSessionHandler::InitBackgroundSession

Source code excerpt:

				GConfig->GetFloat(TEXT("BackgroundHttp.iOSSettings"), TEXT("BackgroundReceiveTimeout"), BackgroundHttpTimeout, GEngineIni);

                float BackgroundHttpResourceTimeout = 3600.f;
                GConfig->GetFloat(TEXT("BackgroundHttp.iOSSettings"), TEXT("BackgroundHttpResourceTimeout"), BackgroundHttpResourceTimeout, GEngineIni);
                
				NSURLSessionConfiguration *config = [NSURLSessionConfiguration backgroundSessionConfigurationWithIdentifier : SessionIdentifier.GetNSString()];
				config.discretionary = NO;
				config.sessionSendsLaunchEvents = YES;
				config.shouldUseExtendedBackgroundIdleMode = YES;
				config.timeoutIntervalForRequest = BackgroundHttpTimeout;	        //Timeout for requests not getting a response from server at the iOS level. Will still work in the BG.
				config.timeoutIntervalForResource = BackgroundHttpResourceTimeout;  //Will automatically retry everytime above setting causes a timeout until this many seconds pass. Then we will get
                                                                                    //an error result. No Error for server not responding until is sent by a background task until this timeout is reached.
                //Other unused settings we might want to configure
				//HTTPMaximumConnectionsPerHost
				//allowsCellularAccess
                
                //Can't use on BG session, but may need to consider for any future FG session work: