Loading...
Searching...
No Matches
AccelByte::Api::QosManager Class Reference

QosManager API to manage Qos Server(s). More...

#include <AccelByteQosManagerApi.h>

Inheritance diagram for AccelByte::Api::QosManager:

Public Member Functions

 QosManager (const Credentials &CredentialsRef, const Settings &SettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient=nullptr)
 QosManager (const Credentials &CredentialsRef, const Settings &SettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
void GetQosServers (const THandler< FAccelByteModelsQosServerList > &OnSuccess, const FErrorHandler &OnError)
 Get List of Qos Server(s). Returns the processed Request for optional polling later.
void GetActiveQosServers (const THandler< FAccelByteModelsQosServerList > &OnSuccess, const FErrorHandler &OnError)
 Get List of Qos Server(s) that have ACTIVE status in the game namespace.
Public Member Functions inherited from AccelByte::FApiBase
 FApiBase (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient)
 FApiBase (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
void SetApiClient (TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient)

Additional Inherited Members

Protected Member Functions inherited from AccelByte::FApiBase
template<typename T>
bool ValidateAccelByteId (FString const &Id, EAccelByteIdHypensRule HypenRule, FString const &ErrorMessage, T const &OnError)
Protected Attributes inherited from AccelByte::FApiBase
TSharedRef< Credentials const, ESPMode::ThreadSafe > CredentialsRef
Settings const & SettingsRef
FHttpRetrySchedulerBaseHttpRef
FHttpClient HttpClient
FAccelBytePlatformPtr AccelBytePlatformPtr

Detailed Description

QosManager API to manage Qos Server(s).

Member Function Documentation

◆ GetActiveQosServers()

void AccelByte::Api::QosManager::GetActiveQosServers ( const THandler< FAccelByteModelsQosServerList > & OnSuccess,
const FErrorHandler & OnError )

Get List of Qos Server(s) that have ACTIVE status in the game namespace.

Parameters
OnSuccessThis will be called when the operation succeeded. The result is FAccelByteModelsQosServerList.
OnErrorThis will be called when the operation failed.

◆ GetQosServers()

void AccelByte::Api::QosManager::GetQosServers ( const THandler< FAccelByteModelsQosServerList > & OnSuccess,
const FErrorHandler & OnError )

Get List of Qos Server(s). Returns the processed Request for optional polling later.

Parameters
OnSuccessThis will be called when the operation succeeded. The result is FAccelByteModelsQosServerList.
OnErrorThis will be called when the operation failed.