Navigation
API > API/Plugins > API/Plugins/Qos
Main Qos interface for actions related to server quality of service
| Name | FQosInterface |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineFramework/Source/Qos/Public/QosInterface.h |
| Include Path | #include "QosInterface.h" |
Syntax
class FQosInterface :
public TSharedFromThis< FQosInterface >,
public FGCObject
Inheritance Hierarchy
- TSharedFromThis< FQosInterface > → FQosInterface
- FGCObject → FQosInterface
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FQosInterface() |
QosInterface.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnQosEvalCompleteDelegate | TMulticastDelegate_NoParams< void > | QosInterface.h | |
| FOnQosRegionIdChanged | TMulticastDelegate_TwoParams< void, const FString &, const FString & > | Delegate that fires whenever the current QoS region ID changes. | QosInterface.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| RegionManager | TObjectPtr< UQosRegionManager > | Reference to the evaluator for making datacenter determinations | QosInterface.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AllRegionsFound() |
QosInterface.h | ||
void BeginQosEvaluation
(
UWorld* World, |
Start running the async QoS evaluation | QosInterface.h | |
void ClearSelectedRegion() |
Clear the region to nothing, used for logging out | QosInterface.h | |
void DumpRegionStats() |
Debug output for current region / datacenter information | QosInterface.h | |
void ForceSelectRegion
(
const FString& RegionId |
Force the selected region creating a fake RegionOption if necessary | QosInterface.h | |
FString GetBestRegion() |
Get the region ID with the current best ping time, checking ini and commandline overrides. | QosInterface.h | |
FString GetRegionId () |
Get the region ID for this instance, checking ini and commandline overrides. | QosInterface.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) | QosInterface.h | |
void GetSubregionPreferences
(
const FString& RegionId, |
Get a sorted list of subregions within a region | QosInterface.h | |
bool Init() |
Re-initialize our FQosRegionManager instance | QosInterface.h | |
bool IsQosEvaluationInProgress() |
Returns true if Qos is in the process of being evaluated | QosInterface.h | |
bool IsUsableRegion
(
const FString& InRegionId |
QosInterface.h | ||
FOnQosEvalCompleteDelegate & OnQosEvalComplete() |
Get the delegate that is invoked when the current/next QoS evaluation completes. | QosInterface.h | |
FOnQosRegionIdChanged & OnQosRegionIdChanged() |
QosInterface.h | ||
void RegisterQoSSettingsChangedDelegate
(
const FSimpleDelegate& OnQoSSettingsChanged |
Register a delegate to be called when QoS settings have changed. | QosInterface.h | |
bool SetSelectedRegion
(
const FString& RegionId |
Try to set the selected region ID (must be present in GetRegionOptions) | QosInterface.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddReferencedObjects
(
FReferenceCollector& Collector |
FGCObject interface | QosInterface.h | |
virtual FString GetReferencerName() |
QosInterface.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedRef< FQosInterface > Get() |
Get the interface singleton | QosInterface.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). | QosInterface.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). | QosInterface.h |