Open 3D Engine AWSMetrics Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Attributes | List of all members
AWSMetrics::ClientConfiguration Class Reference

ClientConfiguration is used to retrieve and store client settings from a local configuration JSON file. More...

#include <ClientConfiguration.h>

Public Member Functions

bool InitClientConfiguration ()
 
AZ::s64 GetMaxQueueSizeInBytes () const
 
AZ::s64 GetQueueFlushPeriodInSeconds () const
 
bool OfflineRecordingEnabled () const
 
AZ::s64 GetMaxNumRetries () const
 
const char * GetMetricsFileDir () const
 
const char * GetMetricsFileFullPath () const
 
void UpdateOfflineRecordingStatus (bool enable)
 

Static Public Attributes

static constexpr const char AWSMetricsMaxQueueSizeInMbKey [] = "/Gems/AWSMetrics/MaxQueueSizeInMb"
 
static constexpr const char AWSMetricsQueueFlushPeriodInSecondsKey [] = "/Gems/AWSMetrics/QueueFlushPeriodInSeconds"
 
static constexpr const char AWSMetricsOfflineRecordingEnabledKey [] = "/Gems/AWSMetrics/OfflineRecording"
 
static constexpr const char AWSMetricsMaxNumRetriesKey [] = "/Gems/AWSMetrics/MaxNumRetries"
 

Detailed Description

ClientConfiguration is used to retrieve and store client settings from a local configuration JSON file.

Member Function Documentation

◆ GetMaxNumRetries()

AZ::s64 AWSMetrics::ClientConfiguration::GetMaxNumRetries ( ) const

Retrieve the settings for the maximum number of retries.

Returns
Maximum number of retries.

◆ GetMaxQueueSizeInBytes()

AZ::s64 AWSMetrics::ClientConfiguration::GetMaxQueueSizeInBytes ( ) const

Retrieve the max queue size setting.

Returns
Max queue size in bytes.

◆ GetMetricsFileDir()

const char * AWSMetrics::ClientConfiguration::GetMetricsFileDir ( ) const

Retrieve the directory of the local metrics file

Returns
Directory of the local metrics file

◆ GetMetricsFileFullPath()

const char * AWSMetrics::ClientConfiguration::GetMetricsFileFullPath ( ) const

Retrieve the full path of the local metrics file

Returns
Full path of the local metrics file

◆ GetQueueFlushPeriodInSeconds()

AZ::s64 AWSMetrics::ClientConfiguration::GetQueueFlushPeriodInSeconds ( ) const

Retrieve the flush period setting.

Returns
Flush period in seconds.

◆ InitClientConfiguration()

bool AWSMetrics::ClientConfiguration::InitClientConfiguration ( )

Initialize the client settings based on the global setting registry.

Returns
whether the operation is successful

◆ OfflineRecordingEnabled()

bool AWSMetrics::ClientConfiguration::OfflineRecordingEnabled ( ) const

Status of the offline recording. Metrics will be sent to a local file instead of the backend if the offline recording is enabled.

Returns
Whether the offline recording is enabled.

◆ UpdateOfflineRecordingStatus()

void AWSMetrics::ClientConfiguration::UpdateOfflineRecordingStatus ( bool  enable)

Enable/Disable the offline recording.

Parameters
enableWhether to enable the offline recording.
The documentation for this class was generated from the following file: