Navigation
API > API/Plugins > API/Plugins/Qos
Inheritance Hierarchy
- TSharedFromThis
- FGCObject
- FQosInterface
References
| Module | Qos |
| Header | /Engine/Plugins/Online/OnlineFramework/Source/Qos/Public/QosInterface.h |
| Include | #include "QosInterface.h" |
Syntax
class FQosInterface :
public TSharedFromThis< FQosInterface >,
public FGCObject
Remarks
Main Qos interface for actions related to server quality of service
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
bool | ||
 |
void | BeginQosEvaluation
(
UWorld* World, |
Start running the async QoS evaluation |
 |
void | Clear the region to nothing, used for logging out | |
 |
void | Debug output for current region / datacenter information | |
 |
void | ForceSelectRegion
(
const FString& RegionId |
Force the selected region creating a fake RegionOption if necessary |
  |
TSharedRef< FQosInterface > | Get () |
Get the interface singleton |
  |
FString | Get the subregion id for this instance, checking ini and commandline overrides This is only relevant for dedicated servers (so they can advertise). | |
  |
FString | Get the region ID with the current best ping time, checking ini and commandline overrides. | |
  |
FString | Get the datacenter id for this instance, checking ini and commandline overrides This is only relevant for dedicated servers (so they can advertise). | |
  |
FString | GetRegionId () |
Get the region ID for this instance, checking ini and commandline overrides. |
  |
const TArray< FRegionQosInstance > & | Get the list of regions that the client can choose from (returned from search and must meet min ping requirements) | |
  |
void | GetSubregionPreferences
(
const FString& RegionId, |
Get a sorted list of subregions within a region |
 |
bool | Init () |
Re-initialize our FQosRegionManager instance |
  |
bool | Returns true if Qos is in the process of being evaluated | |
  |
bool | IsUsableRegion
(
const FString& InRegionId |
|
 |
FOnQosEvalCompleteDelegate & | Get the delegate that is invoked when the current/next QoS evaluation completes. | |
 |
FOnQosRegionIdChanged & | ||
 |
void | RegisterQoSSettingsChangedDelegate
(
const FSimpleDelegate& OnQoSSettingsChanged |
Register a delegate to be called when QoS settings have changed. |
 |
bool | SetSelectedRegion
(
const FString& RegionId |
Try to set the selected region ID (must be present in GetRegionOptions) |
Overridden from FGCObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | AddReferencedObjects
(
FReferenceCollector& Collector |
FGCObject interface |
   |
FString | Overload this method to report a name for your referencer |
Typedefs
| Name | Description |
|---|---|
| FOnQosEvalCompleteDelegate | |
| FOnQosRegionIdChanged | Delegate that fires whenever the current QoS region ID changes. |