PlayerSession

public struct PlayerSession : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let creationTime: TimeStamp?

  • DNS identifier assigned to the instance that is running the game session. Values have the following format: TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com. Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.) When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

    Declaration

    Swift

    public let dnsName: String?

  • The Amazon Resource Name (ARN) associated with the GameLift fleet that the player’s game session is running on.

    Declaration

    Swift

    public let fleetArn: String?

  • A unique identifier for a fleet that the player’s game session is running on.

    Declaration

    Swift

    public let fleetId: String?

  • A unique identifier for the game session that the player session is connected to.

    Declaration

    Swift

    public let gameSessionId: String?

  • IP address of the instance that is running the game session. When connecting to a Amazon GameLift game server, a client needs to reference an IP address (or DNS name) and port number.

    Declaration

    Swift

    public let ipAddress: String?

  • 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.

    Declaration

    Swift

    public let playerData: String?

  • A unique identifier for a player that is associated with this player session.

    Declaration

    Swift

    public let playerId: String?

  • A unique identifier for a player session.

    Declaration

    Swift

    public let playerSessionId: String?

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

    Declaration

    Swift

    public let port: Int?

  • 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).

    Declaration

    Swift

    public let status: PlayerSessionStatus?

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

    Declaration

    Swift

    public let terminationTime: TimeStamp?

  • Undocumented

    Declaration

    Swift

    public init(creationTime: TimeStamp? = nil, dnsName: String? = nil, fleetArn: String? = nil, fleetId: String? = nil, gameSessionId: String? = nil, ipAddress: String? = nil, playerData: String? = nil, playerId: String? = nil, playerSessionId: String? = nil, port: Int? = nil, status: PlayerSessionStatus? = nil, terminationTime: TimeStamp? = nil)