FQosInterface

Main Qos interface for actions related to server quality of service

Choose your operating system:

Windows

macOS

Linux

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

Name Description

Protected function

FQosInterface()

Functions

Name Description

Public function Const

bool

 

AllRegionsFound()

Public function

void

 

BeginQosEvaluation

(
    UWorld* World,
    const TSharedPtr< IAnalyticsProvide...,
    const FSimpleDelegate& OnComplete
)

Start running the async QoS evaluation

Public function

void

 

ClearSelectedRegion()

Clear the region to nothing, used for logging out

Public function

void

 

DumpRegionStats()

Debug output for current region / datacenter information

Public function

void

 

ForceSelectRegion

(
    const FString& RegionId
)

Force the selected region creating a fake RegionOption if necessary

Public function Static

TSharedRef< ...

 

Get()

Get the interface singleton

Public function 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).

Public function Const

FString

 

GetBestRegion()

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

Public function 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).

Public function Const

FString

 

GetRegionId()

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

Public function Const

const TArray...

 

GetRegionOptions()

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

Public function Const

void

 

GetSubregionPreferences

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

Get a sorted list of subregions within a region

Public function

bool

 

Init()

Re-initialize our FQosRegionManager instance

Public function Const

bool

 

IsQosEvaluationInProgress()

Returns true if Qos is in the process of being evaluated

Public function Const

bool

 

IsUsableRegion

(
    const FString& InRegionId
)

Public function

FOnQosEvalCo...

 

OnQosEvalComplete()

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

Public function

void

 

RegisterQoSSettingsChangedDelegate

(
    const FSimpleDelegate& OnQoSSettin...
)

Register a delegate to be called when QoS settings have changed.

Public function

bool

 

SetSelectedRegion

(
    const FString& RegionId
)

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

Overridden from FGCObject

Name Description

Protected function Virtual

void

 

AddReferencedObjects

(
    FReferenceCollector& Collector
)

FGCObject interface

Protected function Virtual Const

FString

 

GetReferencerName()

Use this method to report a name for your referencer.

Typedefs

Name

Description

FOnQosEvalCompleteDelegate