/AWS1/CL_GMLPLAYERCONNDETAIL¶
Connection information for a game client to connect to a game session. This object contains the IP address(es), port(s), and authentication details your game client needs to establish a connection.
With player gateway enabled: Contains relay endpoints and a player gateway token. Your game client must prepend player gateway token to each payload for validation and connection through relay endpoints.
With player gateway disabled: Contains game server endpoint. Player gateway token and expiration fields are empty.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_playerid TYPE /AWS1/GMLPLAYERID /AWS1/GMLPLAYERID¶
A unique identifier for a player associated with this connection.
it_endpoints TYPE /AWS1/CL_GMLPLAYERCONNENDPOINT=>TT_PLAYERCONNENDPOINTLIST TT_PLAYERCONNENDPOINTLIST¶
List of connection endpoints for the game client. Your game client uses these IP address(es) and port(s) to connect to the game session.
When player gateway is enabled, these are relay endpoints with benefits such as DDoS protection. When disabled, this is the game server endpoint.
iv_playergatewaytoken TYPE /AWS1/GMLMAXSTRING /AWS1/GMLMAXSTRING¶
Access token that your game client must prepend to all traffic sent through player gateway. Player gateway verifies identity and authorizes connection based on this token.
This value is empty when player gateway is disabled.
iv_expiration TYPE /AWS1/GMLTIMESTAMP /AWS1/GMLTIMESTAMP¶
When player gateway is enabled, this is the timestamp indicating when player gateway token expires. Your game backend should call GetPlayerConnectionDetails to retrieve fresh connection information for your game clients before this time. Format is a number expressed in Unix time as milliseconds (for example
"1469498468.057").This value is empty when player gateway is disabled.
Queryable Attributes¶
PlayerId¶
A unique identifier for a player associated with this connection.
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 |
Endpoints¶
List of connection endpoints for the game client. Your game client uses these IP address(es) and port(s) to connect to the game session.
When player gateway is enabled, these are relay endpoints with benefits such as DDoS protection. When disabled, this is the game server endpoint.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENDPOINTS() |
Getter for ENDPOINTS, with configurable default |
ASK_ENDPOINTS() |
Getter for ENDPOINTS w/ exceptions if field has no value |
HAS_ENDPOINTS() |
Determine if ENDPOINTS has a value |
PlayerGatewayToken¶
Access token that your game client must prepend to all traffic sent through player gateway. Player gateway verifies identity and authorizes connection based on this token.
This value is empty when player gateway is disabled.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PLAYERGATEWAYTOKEN() |
Getter for PLAYERGATEWAYTOKEN, with configurable default |
ASK_PLAYERGATEWAYTOKEN() |
Getter for PLAYERGATEWAYTOKEN w/ exceptions if field has no |
HAS_PLAYERGATEWAYTOKEN() |
Determine if PLAYERGATEWAYTOKEN has a value |
Expiration¶
When player gateway is enabled, this is the timestamp indicating when player gateway token expires. Your game backend should call GetPlayerConnectionDetails to retrieve fresh connection information for your game clients before this time. Format is a number expressed in Unix time as milliseconds (for example
"1469498468.057").This value is empty when player gateway is disabled.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXPIRATION() |
Getter for EXPIRATION, with configurable default |
ASK_EXPIRATION() |
Getter for EXPIRATION w/ exceptions if field has no value |
HAS_EXPIRATION() |
Determine if EXPIRATION 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_PLAYERCONNECTIONDETAILLIST¶
TYPES TT_PLAYERCONNECTIONDETAILLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_GMLPLAYERCONNDETAIL WITH DEFAULT KEY
.