You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::GameLift::Types::PlayerSession

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Properties describing a player session. Player session objects are created either by creating a player session for a specific game session, or as part of a game session placement. A player session represents either a player reservation for a game session (status RESERVED) or actual player activity in a game session (status ACTIVE). A player session object (including player data) is automatically passed to a game session when the player connects to the game session and is validated.

When a player disconnects, the player session status changes to COMPLETED. Once the session ends, the player session object is retained for 30 days and then removed.

Player-session-related operations include:

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#creation_timeTime

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

Returns:

  • (Time)

    Time stamp indicating when this data object was created.

#fleet_idString

Unique identifier for a fleet that the player\'s game session is running on.

Returns:

  • (String)

    Unique identifier for a fleet that the player\'s game session is running on.

#game_session_idString

Unique identifier for the game session that the player session is connected to.

Returns:

  • (String)

    Unique identifier for the game session that the player session is connected to.

#ip_addressString

IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

Returns:

  • (String)

    IP address of the game session.

#player_dataString

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

Returns:

  • (String)

    Developer-defined information related to a player.

#player_idString

Unique identifier for a player that is associated with this player session.

Returns:

  • (String)

    Unique identifier for a player that is associated with this player session.

#player_session_idString

Unique identifier for a player session.

Returns:

  • (String)

    Unique identifier for a player session.

#portInteger

Port number for the game session. To connect to a Amazon GameLift server process, an app needs both the IP address and port number.

Returns:

  • (Integer)

    Port number for the game session.

#statusString

Current status of the player session.

Possible player session statuses include the following:

  • RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.

  • ACTIVE -- The player has been validated by the server process and is currently connected.

  • COMPLETED -- The player connection has been dropped.

  • TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

    Possible values:

    • RESERVED
    • ACTIVE
    • COMPLETED
    • TIMEDOUT

Returns:

  • (String)

    Current status of the player session.

#termination_timeTime

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

Returns:

  • (Time)

    Time stamp indicating when this data object was terminated.