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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

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:

  • CreatePlayerSession

  • CreatePlayerSessions

  • DescribePlayerSessions

  • Game session placements

    • StartGameSessionPlacement

    • DescribeGameSessionPlacement

    • StopGameSessionPlacement

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)


4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4440

class PlayerSession < Struct.new(
  :player_session_id,
  :player_id,
  :game_session_id,
  :fleet_id,
  :creation_time,
  :termination_time,
  :status,
  :ip_address,
  :port,
  :player_data)
  include Aws::Structure
end

#fleet_idString

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

Returns:

  • (String)


4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4440

class PlayerSession < Struct.new(
  :player_session_id,
  :player_id,
  :game_session_id,
  :fleet_id,
  :creation_time,
  :termination_time,
  :status,
  :ip_address,
  :port,
  :player_data)
  include Aws::Structure
end

#game_session_idString

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

Returns:

  • (String)


4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4440

class PlayerSession < Struct.new(
  :player_session_id,
  :player_id,
  :game_session_id,
  :fleet_id,
  :creation_time,
  :termination_time,
  :status,
  :ip_address,
  :port,
  :player_data)
  include Aws::Structure
end

#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)


4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4440

class PlayerSession < Struct.new(
  :player_session_id,
  :player_id,
  :game_session_id,
  :fleet_id,
  :creation_time,
  :termination_time,
  :status,
  :ip_address,
  :port,
  :player_data)
  include Aws::Structure
end

#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)


4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4440

class PlayerSession < Struct.new(
  :player_session_id,
  :player_id,
  :game_session_id,
  :fleet_id,
  :creation_time,
  :termination_time,
  :status,
  :ip_address,
  :port,
  :player_data)
  include Aws::Structure
end

#player_idString

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

Returns:

  • (String)


4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4440

class PlayerSession < Struct.new(
  :player_session_id,
  :player_id,
  :game_session_id,
  :fleet_id,
  :creation_time,
  :termination_time,
  :status,
  :ip_address,
  :port,
  :player_data)
  include Aws::Structure
end

#player_session_idString

Unique identifier for a player session.

Returns:

  • (String)


4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4440

class PlayerSession < Struct.new(
  :player_session_id,
  :player_id,
  :game_session_id,
  :fleet_id,
  :creation_time,
  :termination_time,
  :status,
  :ip_address,
  :port,
  :player_data)
  include Aws::Structure
end

#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)


4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4440

class PlayerSession < Struct.new(
  :player_session_id,
  :player_id,
  :game_session_id,
  :fleet_id,
  :creation_time,
  :termination_time,
  :status,
  :ip_address,
  :port,
  :player_data)
  include Aws::Structure
end

#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 time-out limit (60 seconds).

Returns:

  • (String)


4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4440

class PlayerSession < Struct.new(
  :player_session_id,
  :player_id,
  :game_session_id,
  :fleet_id,
  :creation_time,
  :termination_time,
  :status,
  :ip_address,
  :port,
  :player_data)
  include Aws::Structure
end

#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)


4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4440

class PlayerSession < Struct.new(
  :player_session_id,
  :player_id,
  :game_session_id,
  :fleet_id,
  :creation_time,
  :termination_time,
  :status,
  :ip_address,
  :port,
  :player_data)
  include Aws::Structure
end