Struct PlayerLatencyPolicy 

#[non_exhaustive]
pub struct PlayerLatencyPolicy {
    pub maximum_individual_player_latency_milliseconds: Option<i32>,
    pub policy_duration_seconds: Option<i32>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

maximum_individual_player_latency_milliseconds: Option<i32>

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

policy_duration_seconds: Option<i32>

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.

Implementations

impl PlayerLatencyPolicy

pub fn maximum_individual_player_latency_milliseconds(&self) -> Option<i32>

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

pub fn policy_duration_seconds(&self) -> Option<i32>

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.

impl PlayerLatencyPolicy

pub fn builder() -> PlayerLatencyPolicyBuilder

Creates a new builder-style object to manufacture PlayerLatencyPolicy.

Trait Implementations

impl Clone for PlayerLatencyPolicy

fn clone(&self) -> PlayerLatencyPolicy

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PlayerLatencyPolicy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for PlayerLatencyPolicy

fn eq(&self, other: &PlayerLatencyPolicy) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PlayerLatencyPolicy