Class PlayerLatencyPolicy

(experimental) The queue setting that determines the highest latency allowed for individual players when placing a game session.

Inheritance

object

PlayerLatencyPolicy

Implements

IPlayerLatencyPolicy

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.GameLift.Alpha

Assembly: Amazon.CDK.AWS.GameLift.Alpha.dll

Syntax (csharp)

public class PlayerLatencyPolicy : IPlayerLatencyPolicy

Syntax (vb)

Public Class PlayerLatencyPolicy Implements IPlayerLatencyPolicy

Remarks

When a latency policy is in force, a game session cannot be placed with any fleet in a Region where a player reports latency higher than the cap.

Latency policies are only enforced when the placement request contains player latency information.

Stability: Experimental

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.GameLift.Alpha;
             using Amazon.CDK;

             var playerLatencyPolicy = new PlayerLatencyPolicy {
                 MaximumIndividualPlayerLatency = Duration.Minutes(30),

                 // the properties below are optional
                 PolicyDuration = Duration.Minutes(30)
             };

Synopsis

Constructors

PlayerLatencyPolicy()

(experimental) The queue setting that determines the highest latency allowed for individual players when placing a game session.

Properties

MaximumIndividualPlayerLatency	(experimental) The maximum latency value that is allowed for any player, in milliseconds.
PolicyDuration	(experimental) The length of time, in seconds, that the policy is enforced while placing a new game session.

Constructors

PlayerLatencyPolicy()

(experimental) The queue setting that determines the highest latency allowed for individual players when placing a game session.

public PlayerLatencyPolicy()

Remarks

When a latency policy is in force, a game session cannot be placed with any fleet in a Region where a player reports latency higher than the cap.

Latency policies are only enforced when the placement request contains player latency information.

Stability: Experimental

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.GameLift.Alpha;
             using Amazon.CDK;

             var playerLatencyPolicy = new PlayerLatencyPolicy {
                 MaximumIndividualPlayerLatency = Duration.Minutes(30),

                 // the properties below are optional
                 PolicyDuration = Duration.Minutes(30)
             };

Properties

MaximumIndividualPlayerLatency

(experimental) The maximum latency value that is allowed for any player, in milliseconds.

public Duration MaximumIndividualPlayerLatency { get; set; }

Property Value

Duration

Remarks

All policies must have a value set for this property.

Stability: Experimental

PolicyDuration

(experimental) The length of time, in seconds, that the policy is enforced while placing a new game session.

public Duration? PolicyDuration { get; set; }

Property Value

Duration

Remarks

Default: the policy is enforced until the queue times out.

Stability: Experimental

Implements

IPlayerLatencyPolicy