Unique ID issued by the Amazon GameLift service in response to a call to the AWS SDK Amazon GameLift API action CreatePlayerSession. The game client references this ID when connecting to the server process.
Notify the GameLift service that the server process has started a game session and is now ready to receive player connections.
This action should be called as part of the onStartGameSession() callback function, after all game session initialization has been completed.
Retrieves player session data, including settings, session metadata, and player data.
Use this action to get information for a single player session, for all player sessions in a game session, or for all player sessions associated with a single player ID.
Request that details what results to query on.
Response object from the GameLift service.
Retrieves a unique identifier for the game session currently being hosted by the server process, if the server process is active.
The identifier is returned in ARN format:
arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>.
Current game session ID.
Retrieves the file location of a pem-encoded TLS certificate that is associated with the fleet and its instances.
This certificate is generated when a new fleet is created with the certificate configuration set to GENERATED. Use this certificate to establish a secure connection with a game client and to encrypt client/server communication.
Object with the properties for setting up a TLS secured server.
Returns the current version number of the SDK in use.
Returns the time that a server process is scheduled to be shut down, if a termination time is available.
A server process takes this action after receiving an
onProcessTerminate()
callback from the GameLift service. A server process may be shut down for
several reasons: (1) process poor health, (2) when an instance is being
terminated during a scale-down event, or (3) when an instance is being
terminated due to a spot instance interruption.
Initializes the GameLift SDK.
This method should be called on launch, before any other GameLift-related logic occurs.
Notifies the GameLift service that the server process is shutting down.
The application should exit with a 0 error code.
Notifies the GameLift service that the server process is ready to host game sessions.
This method should be called after successfully invoking initSdk() and
completing any setup tasks required before the server process can host a game
session.
Port number & function callbacks in response to GameLift events communicated to the application from the GameLift service.
Notifies the GameLift service that a player with the specified player session ID has disconnected from the server process.
In response, GameLift changes the player slot to available, which allows it to be assigned to a new player.
Identifier of the player session to remove/disassociate from the current game session.
Sends a request to find new players for open slots in a game session created with FlexMatch.
See also the AWS SDK action StartMatchBackfill(). With this action, match backfill requests can be initiated by a game server process that is hosting the game session. Learn more about the FlexMatch backfill feature in Backfill Existing Games with FlexMatch.
This action is asynchronous. If new players are successfully matched, the
GameLift service delivers updated matchmaker data using the callback
function
onUpdateGameSession().
BackfillMatchmakingRequest
message that determines how/what gets backfilled with players. The message
communicates the following information:
getGameSessionId().BackfillMatchmakingResponse
message with the ticket ID of the request. This ticket ID can be used in a call to
DescribeMatchmaking()
or to stop the backfill matchmaking request.Cancels an active match backfill request that was created with
startMatchBackfill().
See also the AWS SDK action [StopMatchmaking()]. Learn more about the
FlexMatch backfill feature in [Backfill Existing Games with FlexMatch].
StopMatchmakingRequest message that identifies the matchmaking
request to stop. See also StopMatchBackfillRequest from the AWS GameLift SDK.
Notifies the GameLift service that the server process has shut down the game session.
Since each server process hosts only one game session at a time, there's no need to specify which session. This action should be called at the end of the game session shutdown process.
After calling this action, the server process can call
processReady() to signal its availability to host a new
game session. Alternatively, it can call processEnding()
to shut down the server process and terminate the instance.
Updates the current game session's ability to accept new player sessions. A game session can be set to either accept or deny all new player sessions. See also the AWS SDK action [UpdateGameSession()].
String value indicating whether the game session accepts new players.
Generated using TypeDoc
Notify the GameLift service that a player with the specified player session ID has connected to the server process and needs validation.
GameLift verifies that the player session ID is valid—that is, that the player ID has reserved a player slot in the game session. Once validated, GameLift changes the status of the player slot from RESERVED to ACTIVE.