AWS SDK for C++  1.7.209
AWS SDK for C++
Public Member Functions | List of all members
Aws::GameLift::Model::PlayerLatencyPolicy Class Reference

#include <PlayerLatencyPolicy.h>

Public Member Functions

 PlayerLatencyPolicy ()
 
 PlayerLatencyPolicy (Aws::Utils::Json::JsonView jsonValue)
 
PlayerLatencyPolicyoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
int GetMaximumIndividualPlayerLatencyMilliseconds () const
 
bool MaximumIndividualPlayerLatencyMillisecondsHasBeenSet () const
 
void SetMaximumIndividualPlayerLatencyMilliseconds (int value)
 
PlayerLatencyPolicyWithMaximumIndividualPlayerLatencyMilliseconds (int value)
 
int GetPolicyDurationSeconds () const
 
bool PolicyDurationSecondsHasBeenSet () const
 
void SetPolicyDurationSeconds (int value)
 
PlayerLatencyPolicyWithPolicyDurationSeconds (int value)
 

Detailed Description

Queue setting that determines the highest latency allowed for individual players when placing a game session. When a latency policy is in force, a game session cannot be placed at any destination in a region where a player is reporting latency higher than the cap. Latency policies are only enforced when the placement request contains player latency information.

See Also:

AWS API Reference

Definition at line 47 of file PlayerLatencyPolicy.h.

Constructor & Destructor Documentation

◆ PlayerLatencyPolicy() [1/2]

Aws::GameLift::Model::PlayerLatencyPolicy::PlayerLatencyPolicy ( )

◆ PlayerLatencyPolicy() [2/2]

Aws::GameLift::Model::PlayerLatencyPolicy::PlayerLatencyPolicy ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetMaximumIndividualPlayerLatencyMilliseconds()

int Aws::GameLift::Model::PlayerLatencyPolicy::GetMaximumIndividualPlayerLatencyMilliseconds ( ) const
inline

The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.

Definition at line 60 of file PlayerLatencyPolicy.h.

◆ GetPolicyDurationSeconds()

int Aws::GameLift::Model::PlayerLatencyPolicy::GetPolicyDurationSeconds ( ) const
inline

The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out.

Definition at line 86 of file PlayerLatencyPolicy.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::GameLift::Model::PlayerLatencyPolicy::Jsonize ( ) const

◆ MaximumIndividualPlayerLatencyMillisecondsHasBeenSet()

bool Aws::GameLift::Model::PlayerLatencyPolicy::MaximumIndividualPlayerLatencyMillisecondsHasBeenSet ( ) const
inline

The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.

Definition at line 66 of file PlayerLatencyPolicy.h.

◆ operator=()

PlayerLatencyPolicy& Aws::GameLift::Model::PlayerLatencyPolicy::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PolicyDurationSecondsHasBeenSet()

bool Aws::GameLift::Model::PlayerLatencyPolicy::PolicyDurationSecondsHasBeenSet ( ) const
inline

The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out.

Definition at line 93 of file PlayerLatencyPolicy.h.

◆ SetMaximumIndividualPlayerLatencyMilliseconds()

void Aws::GameLift::Model::PlayerLatencyPolicy::SetMaximumIndividualPlayerLatencyMilliseconds ( int  value)
inline

The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.

Definition at line 72 of file PlayerLatencyPolicy.h.

◆ SetPolicyDurationSeconds()

void Aws::GameLift::Model::PlayerLatencyPolicy::SetPolicyDurationSeconds ( int  value)
inline

The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out.

Definition at line 100 of file PlayerLatencyPolicy.h.

◆ WithMaximumIndividualPlayerLatencyMilliseconds()

PlayerLatencyPolicy& Aws::GameLift::Model::PlayerLatencyPolicy::WithMaximumIndividualPlayerLatencyMilliseconds ( int  value)
inline

The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.

Definition at line 78 of file PlayerLatencyPolicy.h.

◆ WithPolicyDurationSeconds()

PlayerLatencyPolicy& Aws::GameLift::Model::PlayerLatencyPolicy::WithPolicyDurationSeconds ( int  value)
inline

The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out.

Definition at line 107 of file PlayerLatencyPolicy.h.


The documentation for this class was generated from the following file: