Aws::GameLift::Model::PlayerLatency Class Reference

#include <PlayerLatency.h>

Public Member Functions
	PlayerLatency ()
	PlayerLatency (Aws::Utils::Json::JsonView jsonValue)
PlayerLatency &	operator= (Aws::Utils::Json::JsonView jsonValue)
Aws::Utils::Json::JsonValue	Jsonize () const
const Aws::String &	GetPlayerId () const
bool	PlayerIdHasBeenSet () const
void	SetPlayerId (const Aws::String &value)
void	SetPlayerId (Aws::String &&value)
void	SetPlayerId (const char *value)
PlayerLatency &	WithPlayerId (const Aws::String &value)
PlayerLatency &	WithPlayerId (Aws::String &&value)
PlayerLatency &	WithPlayerId (const char *value)
const Aws::String &	GetRegionIdentifier () const
bool	RegionIdentifierHasBeenSet () const
void	SetRegionIdentifier (const Aws::String &value)
void	SetRegionIdentifier (Aws::String &&value)
void	SetRegionIdentifier (const char *value)
PlayerLatency &	WithRegionIdentifier (const Aws::String &value)
PlayerLatency &	WithRegionIdentifier (Aws::String &&value)
PlayerLatency &	WithRegionIdentifier (const char *value)
double	GetLatencyInMilliseconds () const
bool	LatencyInMillisecondsHasBeenSet () const
void	SetLatencyInMilliseconds (double value)
PlayerLatency &	WithLatencyInMilliseconds (double value)

Detailed Description

Regional latency information for a player, used when requesting a new game session with StartGameSessionPlacement. This value indicates the amount of time lag that exists when the player is connected to a fleet in the specified region. The relative difference between a player's latency values for multiple regions are used to determine which fleets are best suited to place a new game session for the player.

See Also:

AWS API Reference

Definition at line 46 of file PlayerLatency.h.

Constructor & Destructor Documentation

PlayerLatency() [1/2]

Aws::GameLift::Model::PlayerLatency::PlayerLatency

(

)

PlayerLatency() [2/2]

Aws::GameLift::Model::PlayerLatency::PlayerLatency

(

Aws::Utils::Json::JsonView

jsonValue

)

Member Function Documentation

GetLatencyInMilliseconds()

double Aws::GameLift::Model::PlayerLatency::GetLatencyInMilliseconds ( ) const

inline

Amount of time that represents the time lag experienced by the player when connected to the specified region.

Definition at line 141 of file PlayerLatency.h.

GetPlayerId()

const Aws::String& Aws::GameLift::Model::PlayerLatency::GetPlayerId ( ) const

inline

Unique identifier for a player associated with the latency data.

Definition at line 58 of file PlayerLatency.h.

GetRegionIdentifier()

const Aws::String& Aws::GameLift::Model::PlayerLatency::GetRegionIdentifier ( ) const

inline

Name of the region that is associated with the latency value.

Definition at line 99 of file PlayerLatency.h.

Jsonize()

Aws::Utils::Json::JsonValue Aws::GameLift::Model::PlayerLatency::Jsonize

(

)

const

LatencyInMillisecondsHasBeenSet()

bool Aws::GameLift::Model::PlayerLatency::LatencyInMillisecondsHasBeenSet ( ) const

inline

Amount of time that represents the time lag experienced by the player when connected to the specified region.

Definition at line 147 of file PlayerLatency.h.

operator=()

PlayerLatency& Aws::GameLift::Model::PlayerLatency::operator=

(

Aws::Utils::Json::JsonView

jsonValue

)

PlayerIdHasBeenSet()

bool Aws::GameLift::Model::PlayerLatency::PlayerIdHasBeenSet ( ) const

inline

Unique identifier for a player associated with the latency data.

Definition at line 63 of file PlayerLatency.h.

RegionIdentifierHasBeenSet()

bool Aws::GameLift::Model::PlayerLatency::RegionIdentifierHasBeenSet ( ) const

inline

Name of the region that is associated with the latency value.

Definition at line 104 of file PlayerLatency.h.

SetLatencyInMilliseconds()

void Aws::GameLift::Model::PlayerLatency::SetLatencyInMilliseconds ( double  value )

inline

Amount of time that represents the time lag experienced by the player when connected to the specified region.

Definition at line 153 of file PlayerLatency.h.

SetPlayerId() [1/3]

void Aws::GameLift::Model::PlayerLatency::SetPlayerId ( const Aws::String &  value )

inline

Unique identifier for a player associated with the latency data.

Definition at line 68 of file PlayerLatency.h.

SetPlayerId() [2/3]

void Aws::GameLift::Model::PlayerLatency::SetPlayerId ( Aws::String &&  value )

inline

Unique identifier for a player associated with the latency data.

Definition at line 73 of file PlayerLatency.h.

SetPlayerId() [3/3]

void Aws::GameLift::Model::PlayerLatency::SetPlayerId ( const char *  value )

inline

Unique identifier for a player associated with the latency data.

Definition at line 78 of file PlayerLatency.h.

SetRegionIdentifier() [1/3]

void Aws::GameLift::Model::PlayerLatency::SetRegionIdentifier ( const Aws::String &  value )

inline

Name of the region that is associated with the latency value.

Definition at line 109 of file PlayerLatency.h.

SetRegionIdentifier() [2/3]

void Aws::GameLift::Model::PlayerLatency::SetRegionIdentifier ( Aws::String &&  value )

inline

Name of the region that is associated with the latency value.

Definition at line 114 of file PlayerLatency.h.

SetRegionIdentifier() [3/3]

void Aws::GameLift::Model::PlayerLatency::SetRegionIdentifier ( const char *  value )

inline

Name of the region that is associated with the latency value.

Definition at line 119 of file PlayerLatency.h.

WithLatencyInMilliseconds()

PlayerLatency& Aws::GameLift::Model::PlayerLatency::WithLatencyInMilliseconds ( double  value )

inline

Amount of time that represents the time lag experienced by the player when connected to the specified region.

Definition at line 159 of file PlayerLatency.h.

WithPlayerId() [1/3]

PlayerLatency& Aws::GameLift::Model::PlayerLatency::WithPlayerId ( const Aws::String &  value )

inline

Unique identifier for a player associated with the latency data.

Definition at line 83 of file PlayerLatency.h.

WithPlayerId() [2/3]

PlayerLatency& Aws::GameLift::Model::PlayerLatency::WithPlayerId ( Aws::String &&  value )

inline

Unique identifier for a player associated with the latency data.

Definition at line 88 of file PlayerLatency.h.

WithPlayerId() [3/3]

PlayerLatency& Aws::GameLift::Model::PlayerLatency::WithPlayerId ( const char *  value )

inline

Unique identifier for a player associated with the latency data.

Definition at line 93 of file PlayerLatency.h.

WithRegionIdentifier() [1/3]

PlayerLatency& Aws::GameLift::Model::PlayerLatency::WithRegionIdentifier ( const Aws::String &  value )

inline

Name of the region that is associated with the latency value.

Definition at line 124 of file PlayerLatency.h.

WithRegionIdentifier() [2/3]

PlayerLatency& Aws::GameLift::Model::PlayerLatency::WithRegionIdentifier ( Aws::String &&  value )

inline

Name of the region that is associated with the latency value.

Definition at line 129 of file PlayerLatency.h.

WithRegionIdentifier() [3/3]

PlayerLatency& Aws::GameLift::Model::PlayerLatency::WithRegionIdentifier ( const char *  value )

inline

Name of the region that is associated with the latency value.

Definition at line 134 of file PlayerLatency.h.

---

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

• aws-cpp-sdk-gamelift/include/aws/gamelift/model/PlayerLatency.h