PlayerLatency.hs

{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.GameLift.Types.PlayerLatency
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.GameLift.Types.PlayerLatency where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude

-- | Regional latency information for a player, used when requesting a new
-- game session. 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:/ 'newPlayerLatency' smart constructor.
data PlayerLatency = PlayerLatency'
  { -- | Amount of time that represents the time lag experienced by the player
    -- when connected to the specified Region.
    latencyInMilliseconds :: Prelude.Maybe Prelude.Double,
    -- | A unique identifier for a player associated with the latency data.
    playerId :: Prelude.Maybe Prelude.Text,
    -- | Name of the Region that is associated with the latency value.
    regionIdentifier :: Prelude.Maybe Prelude.Text
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'PlayerLatency' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'latencyInMilliseconds', 'playerLatency_latencyInMilliseconds' - Amount of time that represents the time lag experienced by the player
-- when connected to the specified Region.
--
-- 'playerId', 'playerLatency_playerId' - A unique identifier for a player associated with the latency data.
--
-- 'regionIdentifier', 'playerLatency_regionIdentifier' - Name of the Region that is associated with the latency value.
newPlayerLatency ::
  PlayerLatency
newPlayerLatency =
  PlayerLatency'
    { latencyInMilliseconds =
        Prelude.Nothing,
      playerId = Prelude.Nothing,
      regionIdentifier = Prelude.Nothing
    }

-- | Amount of time that represents the time lag experienced by the player
-- when connected to the specified Region.
playerLatency_latencyInMilliseconds :: Lens.Lens' PlayerLatency (Prelude.Maybe Prelude.Double)
playerLatency_latencyInMilliseconds = Lens.lens (\PlayerLatency' {latencyInMilliseconds} -> latencyInMilliseconds) (\s@PlayerLatency' {} a -> s {latencyInMilliseconds = a} :: PlayerLatency)

-- | A unique identifier for a player associated with the latency data.
playerLatency_playerId :: Lens.Lens' PlayerLatency (Prelude.Maybe Prelude.Text)
playerLatency_playerId = Lens.lens (\PlayerLatency' {playerId} -> playerId) (\s@PlayerLatency' {} a -> s {playerId = a} :: PlayerLatency)

-- | Name of the Region that is associated with the latency value.
playerLatency_regionIdentifier :: Lens.Lens' PlayerLatency (Prelude.Maybe Prelude.Text)
playerLatency_regionIdentifier = Lens.lens (\PlayerLatency' {regionIdentifier} -> regionIdentifier) (\s@PlayerLatency' {} a -> s {regionIdentifier = a} :: PlayerLatency)

instance Data.FromJSON PlayerLatency where
  parseJSON =
    Data.withObject
      "PlayerLatency"
      ( \x ->
          PlayerLatency'
            Prelude.<$> (x Data..:? "LatencyInMilliseconds")
            Prelude.<*> (x Data..:? "PlayerId")
            Prelude.<*> (x Data..:? "RegionIdentifier")
      )

instance Prelude.Hashable PlayerLatency where
  hashWithSalt _salt PlayerLatency' {..} =
    _salt
      `Prelude.hashWithSalt` latencyInMilliseconds
      `Prelude.hashWithSalt` playerId
      `Prelude.hashWithSalt` regionIdentifier

instance Prelude.NFData PlayerLatency where
  rnf PlayerLatency' {..} =
    Prelude.rnf latencyInMilliseconds
      `Prelude.seq` Prelude.rnf playerId
      `Prelude.seq` Prelude.rnf regionIdentifier

instance Data.ToJSON PlayerLatency where
  toJSON PlayerLatency' {..} =
    Data.object
      ( Prelude.catMaybes
          [ ("LatencyInMilliseconds" Data..=)
              Prelude.<$> latencyInMilliseconds,
            ("PlayerId" Data..=) Prelude.<$> playerId,
            ("RegionIdentifier" Data..=)
              Prelude.<$> regionIdentifier
          ]
      )