You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::GameLift::Types::PlayerLatency

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PlayerLatency as input to an Aws::Client method, you can use a vanilla Hash:

{
  player_id: "NonZeroAndMaxString",
  region_identifier: "NonZeroAndMaxString",
  latency_in_milliseconds: 1.0,
}

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.

Instance Attribute Summary collapse

Instance Attribute Details

#latency_in_millisecondsFloat

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

Returns:

  • (Float)

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

#player_idString

Unique identifier for a player associated with the latency data.

Returns:

  • (String)

    Unique identifier for a player associated with the latency data.

#region_identifierString

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

Returns:

  • (String)

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