1. Epic GamesDeveloper
  3. UQosRegionManager

UQosRegionManager

Main Qos interface for actions related to server quality of service

API > API/Plugins > API/Plugins/Qos

Main Qos interface for actions related to server quality of service

   
Name UQosRegionManager
Type class
Header File /Engine/Plugins/Online/OnlineFramework/Source/Qos/Public/QosRegionManager.h
Include Path #include "QosRegionManager.h"

Syntax

UCLASS (MinimalAPI, Config=Engine)  
class UQosRegionManager : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UQosRegionManager ( const FObjectInitializer& ObjectInitializer
)

   QosRegionManager.h  

Typedefs

Name Type Remarks Include Path
FOnQosEvalCompleteDelegate TMulticastDelegate_NoParams< void >   QosRegionManager.h
FOnQosRegionIdChanged TMulticastDelegate_TwoParams< void, const FString &, const FString & > Delegate that fires whenever the current QoS region ID changes. QosRegionManager.h

Constants

Name Type Remarks Include Path
SubspaceDelimiterDefault const TCHAR *   QosRegionManager.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bEnableSubspaceBiasOrder bool Global switch to enable/disable sorting of QoS datacenter results using rules-based comparison, where subspaces are encountered. QosRegionManager.h
  • Config
bRegionForcedViaCommandline bool Was the region forced via commandline QosRegionManager.h  
DatacenterDefinitions TArray< FQosDatacenterInfo > Metadata about datacenters within existing regions QosRegionManager.h
  • Config
Evaluator TObjectPtr< UQosEvaluator > Reference to the evaluator for making datacenter determinations (null when not active) QosRegionManager.h  
ForceRegionId FString Value forced to be the region (development) QosRegionManager.h  
LastCheckTimestamp FDateTime   QosRegionManager.h  
NumTestsPerRegion int32 Number of times to ping a given region using random sampling of available servers QosRegionManager.h
  • Config
OnQosEvalCompleteDelegate FOnQosEvalCompleteDelegate   QosRegionManager.h  
OnQosRegionIdChangedDelegate FOnQosRegionIdChanged   QosRegionManager.h  
OnQoSSettingsChangedDelegate FSimpleDelegate   QosRegionManager.h  
PingTimeout float Timeout value for each ping request QosRegionManager.h
  • Config
QosEvalResult EQosCompletionResult Result of the last datacenter test QosRegionManager.h  
RegionDefinitions TArray< FQosRegionInfo > Metadata about existing regions QosRegionManager.h
  • Config
RegionOptions TArray< FRegionQosInstance > Array of all known regions and the datacenters in them QosRegionManager.h  
SelectedRegionId FString Value set by the game to be the current region QosRegionManager.h  
SubspaceBiasParams FQosSubspaceComparisonParams Granular settings for biased subspace-based sorting algorithm which applies when returning all subregions for queries QosRegionManager.h
  • Config
SubspaceDelimiter FString Delimiter string that identifies a subspace datacenter ID. QosRegionManager.h
  • Config
UsableSubregions TArray< FString > List of all useable subregions sorted by ping. Does not include accelerated regions. QosRegionManager.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AllRegionsFound()

   QosRegionManager.h  

void BeginQosEvaluation ( UWorld* World,
const TSharedPtr< IAnalyticsProvider >& AnalyticsProvider,
const FSimpleDelegate& OnComplete
)

 Start running the async QoS evaluation QosRegionManager.h  

void ClearSelectedRegion()

 Clear the region to nothing, used for logging out QosRegionManager.h  

void DumpRegionStats()

 Debug output for current region / datacenter information QosRegionManager.h  

void ForceSelectRegion ( const FString& RegionId
)

 Force the selected region creating a fake RegionOption if necessary QosRegionManager.h  

FString GetBestRegion()

 Get the region ID with the current best ping time, checking ini and commandline overrides. QosRegionManager.h  

FString GetRegionId ()

 Get the region ID for this instance, checking ini and commandline overrides. QosRegionManager.h  

const TArray< FRegionQosInstance > & GetRegionOptions ()

 Get the list of regions that the client can choose from (returned from search and must meet min ping requirements) QosRegionManager.h  

void GetSubregionPreferences ( const FString& RegionId,
TArray< FString >& OutSubregions
) const

 Get a sorted list of subregions within a region QosRegionManager.h  

bool IsQosEvaluationInProgress()

 Returns true if Qos is in the process of being evaluated QosRegionManager.h  

bool IsUsableRegion ( const FString& InRegionId
) const

   QosRegionManager.h  

FOnQosEvalCompleteDelegate & OnQosEvalComplete()

 Get the delegate that is invoked when the current/next QoS evaluation completes. QosRegionManager.h  

FOnQosRegionIdChanged & OnQosRegionIdChanged()

   QosRegionManager.h  

virtual void PostReloadConfig ( FProperty* PropertyThatWasLoaded
)

 Begin UObject interface QosRegionManager.h  

void RegisterQoSSettingsChangedDelegate ( const FSimpleDelegate& OnQoSSettingsChanged
)

   QosRegionManager.h  

bool SetSelectedRegion ( const FString& RegionId,
bool bForce
)

 Try to set the selected region ID (must be present in GetRegionOptions) QosRegionManager.h  

Static

Name Remarks Include Path Unreal Specifiers

static const FRegionQosInstance * FindBestQosRegion ( const TArray< FRegionQosInstance >& Regions
)

 Finds the QOS region result that has the "best" ping result. QosRegionManager.h  

static const FRegionQosInstance * FindQosRegionById ( const TArray< FRegionQosInstance >& Regions,
const FString& RegionId
)

 Finds the QOS region result that matches the given region ID from an array of region results. QosRegionManager.h  

static FString GetAdvertisedSubregionId ()

 Get the subregion id for this instance, checking ini and commandline overrides This is only relevant for dedicated servers (so they can advertise). QosRegionManager.h  

static FString GetDatacenterId ()

 Get the datacenter id for this instance, checking ini and commandline overrides This is only relevant for dedicated servers (so they can advertise). QosRegionManager.h  

static bool TestCompareDatacentersBySubspace()

 Test methods for debugging datacenter comparisons that use special rules when dealing with subspaces. QosRegionManager.h  

static FRegionQosInstance TestCreateExampleRegionResult()

   QosRegionManager.h  

static bool TestSortDatacenterSubspacesByRecommended()

   QosRegionManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page