Skip to content

/AWS1/CL_GMLPLAYERLATENCY

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 location (an Amazon Web Services Region or a custom location for Amazon GameLift Servers Anywhere fleets). The relative difference between a player's latency values for multiple locations are used to determine which fleets are best suited to place a new game session for the player.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_playerid TYPE /AWS1/GMLPLAYERID /AWS1/GMLPLAYERID

A unique identifier for a player associated with the latency data.

iv_regionidentifier TYPE /AWS1/GMLNONZEROANDMAXSTRING /AWS1/GMLNONZEROANDMAXSTRING

Name of the Region or custom location that is associated with the latency value. For Amazon GameLift Servers Anywhere fleets, use the custom location name.

iv_latencyinmilliseconds TYPE /AWS1/RT_FLOAT_AS_STRING /AWS1/RT_FLOAT_AS_STRING

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


Queryable Attributes

PlayerId

A unique identifier for a player associated with the latency data.

Accessible with the following methods

Method Description
GET_PLAYERID() Getter for PLAYERID, with configurable default
ASK_PLAYERID() Getter for PLAYERID w/ exceptions if field has no value
HAS_PLAYERID() Determine if PLAYERID has a value

RegionIdentifier

Name of the Region or custom location that is associated with the latency value. For Amazon GameLift Servers Anywhere fleets, use the custom location name.

Accessible with the following methods

Method Description
GET_REGIONIDENTIFIER() Getter for REGIONIDENTIFIER, with configurable default
ASK_REGIONIDENTIFIER() Getter for REGIONIDENTIFIER w/ exceptions if field has no va
HAS_REGIONIDENTIFIER() Determine if REGIONIDENTIFIER has a value

LatencyInMilliseconds

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

Accessible with the following methods

Method Description
GET_LATENCYINMILLISECONDS() Getter for LATENCYINMILLISECONDS, with configurable default
ASK_LATENCYINMILLISECONDS() Getter for LATENCYINMILLISECONDS w/ exceptions if field has
STR_LATENCYINMILLISECONDS() String format for LATENCYINMILLISECONDS, with configurable d
HAS_LATENCYINMILLISECONDS() Determine if LATENCYINMILLISECONDS has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_PLAYERLATENCYLIST

TYPES TT_PLAYERLATENCYLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_GMLPLAYERLATENCY WITH DEFAULT KEY
.