Class: Aws::GameLift::Types::PlayerLatencyPolicy

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

Overview

Sets a latency cap for individual players when placing a game session. With a latency policy in force, a game session cannot be placed in a fleet location where a player reports latency higher than the cap. Latency policies are used only with placement request that provide player latency information. Player latency policies can be stacked to gradually relax latency requirements over time.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#maximum_individual_player_latency_millisecondsInteger

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

Returns:

  • (Integer)


6841
6842
6843
6844
6845
6846
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6841

class PlayerLatencyPolicy < Struct.new(
  :maximum_individual_player_latency_milliseconds,
  :policy_duration_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#policy_duration_secondsInteger

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.

Returns:

  • (Integer)


6841
6842
6843
6844
6845
6846
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6841

class PlayerLatencyPolicy < Struct.new(
  :maximum_individual_player_latency_milliseconds,
  :policy_duration_seconds)
  SENSITIVE = []
  include Aws::Structure
end