AccelByte::Api::Qos Class Reference

Qos to manage specific QoS (Latencies/Ping) Server(s). More...

#include <AccelByteQos.h>

Inheritance diagram for AccelByte::Api::Qos:

Public Member Functions
	Qos (Credentials &NewCredentialsRef, const Settings &NewSettingsRef, FAccelByteMessagingSystem &InMessagingSystemRef, const QosManagerWPtr QosManagerWeak, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient=nullptr)
	Qos (Credentials &NewCredentialsRef, const Settings &NewSettingsRef, FAccelByteMessagingSystem &InMessagingSystemRef, const QosManagerWPtr QosManagerWeak, FAccelBytePlatformPtr const &InAccelBytePlatform)
	Qos (Qos const &)=delete
	Qos (Qos &&)=delete
Qos &	operator= (Qos const &)=delete
Qos &	operator= (Qos &&)=delete
void	SetApiClient (TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > InApiClient)
void	GetServerLatencies (const THandler< TArray< TPair< FString, float > > > &OnSuccess, FErrorHandler const &OnError)
	Check server latencies (ping) per-region, with optional polling.
void	GetActiveServerLatencies (const THandler< TArray< TPair< FString, float > > > &OnSuccess, FErrorHandler const &OnError)
	Check server latencies (ping) per-region that have status ACTIVE.
void	StartLatencyPollers ()
	Start the latency polling schedulers.
void	StopLatencyPollers ()
	Wrapper for RemoveFromTicker() for PollLatenciesHandle and PollServerLatenciesHandle.
bool	AreLatencyPollersActive () const noexcept
	Check whether latency polling schedulers are active.
TArray< TPair< FString, float > >	GetCachedLatencies ()
	Get cached latencies data.
void	Startup ()
	Startup module.

Detailed Description

Qos to manage specific QoS (Latencies/Ping) Server(s).

Member Function Documentation

GetActiveServerLatencies()

void AccelByte::Api::Qos::GetActiveServerLatencies	(	const THandler< TArray< TPair< FString, float > > > &	OnSuccess,
		FErrorHandler const &	OnError )

Check server latencies (ping) per-region that have status ACTIVE.

Parameters

OnSuccess	If polling, this will also call every ping update success.
OnError	If polling, this will also call every ping update error.

GetServerLatencies()

void AccelByte::Api::Qos::GetServerLatencies	(	const THandler< TArray< TPair< FString, float > > > &	OnSuccess,
		FErrorHandler const &	OnError )

Check server latencies (ping) per-region, with optional polling.

• Optional Pulling (default off), unless .ini polling Settings.QosLatencyPollIntervalSecs > 0.
• Latencies will be cached, then optionally polled (using cached QoS Servers).
  • Set @ Settings ini (# seconds) via QosLatencyPollIntervalSecs.
• QoS Servers will optionally be polled.
  • Set @ Settings ini (# seconds) via QosServerLatencyPollIntervalSecs.

Parameters

OnSuccess	If polling, this will also call every ping update success.
OnError	If polling, this will also call every ping update error.