|
virtual Aws::GameLift::GenericOutcome | AcceptPlayerSession (const std::string &playerSessionId) |
|
virtual Aws::GameLift::GenericOutcome | ActivateGameSession () |
|
virtual Aws::GameLift::DescribePlayerSessionsOutcome | DescribePlayerSessions (const Aws::GameLift::Server::Model::DescribePlayerSessionsRequest &describePlayerSessionsRequest) |
|
virtual Aws::GameLift::GetComputeCertificateOutcome | GetComputeCertificate () |
|
virtual Aws::GameLift::GetFleetRoleCredentialsOutcome | GetFleetRoleCredentials (Aws::GameLift::Server::Model::GetFleetRoleCredentialsRequest request) |
|
virtual Aws::GameLift::Server::InitSDKOutcome | InitSDK (Aws::GameLift::Server::Model::ServerParameters serverParameters) |
|
virtual Aws::GameLift::GenericOutcome | ProcessReady (const Aws::GameLift::Server::ProcessParameters &processParameters) |
|
virtual Aws::GameLift::GenericOutcome | ProcessEnding () |
|
virtual AZStd::string | GetTerminationTime () |
|
virtual Aws::GameLift::GenericOutcome | RemovePlayerSession (const AZStd::string &playerSessionId) |
|
virtual Aws::GameLift::StartMatchBackfillOutcome | StartMatchBackfill (const Aws::GameLift::Server::Model::StartMatchBackfillRequest &startMatchBackfillRequest) |
|
virtual Aws::GameLift::GenericOutcome | StopMatchBackfill (const Aws::GameLift::Server::Model::StopMatchBackfillRequest &stopMatchBackfillRequest) |
|
◆ AcceptPlayerSession()
virtual Aws::GameLift::GenericOutcome AWSGameLift::GameLiftServerSDKWrapper::AcceptPlayerSession |
( |
const std::string & |
playerSessionId | ) |
|
|
virtual |
Processes and validates a player session connection. This method should be called when a client requests a connection to the server.
- Parameters
-
playerSessionId | the ID of the joining player's session. |
- Returns
- Returns a generic outcome consisting of success or failure with an error message.
◆ ActivateGameSession()
virtual Aws::GameLift::GenericOutcome AWSGameLift::GameLiftServerSDKWrapper::ActivateGameSession |
( |
| ) |
|
|
virtual |
Reports to GameLift that the server process is now ready to receive player sessions. Should be called once all GameSession initialization has finished.
- Returns
- Returns a generic outcome consisting of success or failure with an error message.
◆ DescribePlayerSessions()
virtual Aws::GameLift::DescribePlayerSessionsOutcome AWSGameLift::GameLiftServerSDKWrapper::DescribePlayerSessions |
( |
const Aws::GameLift::Server::Model::DescribePlayerSessionsRequest & |
describePlayerSessionsRequest | ) |
|
|
virtual |
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.
- Parameters
-
describePlayerSessionsRequest | The request object describing which player sessions to retrieve. |
- Returns
- If successful, returns a DescribePlayerSessionsOutcome object containing a set of player session objects that fit the request parameters.
◆ GetComputeCertificate()
virtual Aws::GameLift::GetComputeCertificateOutcome AWSGameLift::GameLiftServerSDKWrapper::GetComputeCertificate |
( |
| ) |
|
|
virtual |
Retrieves the path to the TLS certificate used to encrypt the network connection between your Amazon GameLift Anywhere compute resource and Amazon GameLift. You can use the certificate path when you register your compute device to a Amazon GameLift Anywhere fleet.
- Returns
- If successful, returns a GetComputeCertificateOutcome object containing the location of the fleet's TLS certificate file, which is stored on the instance. If not successful, returns an error message.
◆ GetFleetRoleCredentials()
virtual Aws::GameLift::GetFleetRoleCredentialsOutcome AWSGameLift::GameLiftServerSDKWrapper::GetFleetRoleCredentials |
( |
Aws::GameLift::Server::Model::GetFleetRoleCredentialsRequest |
request | ) |
|
|
virtual |
Retrieves the service role credentials that you create to extend permissions to your other AWS services to Amazon GameLift. These credentials allow your game server to use your AWS resources.
- Returns
- If successful, returns a GetFleetRoleCredentialsOutcome object containing the service role credentials. If not successful, returns an error message.
◆ GetTerminationTime()
virtual AZStd::string AWSGameLift::GameLiftServerSDKWrapper::GetTerminationTime |
( |
| ) |
|
|
virtual |
Returns the time that a server process is scheduled to be shut down.
- Returns
- Timestamp using the UTC ISO8601 format.
◆ InitSDK()
virtual Aws::GameLift::Server::InitSDKOutcome AWSGameLift::GameLiftServerSDKWrapper::InitSDK |
( |
Aws::GameLift::Server::Model::ServerParameters |
serverParameters | ) |
|
|
virtual |
Initializes the GameLift SDK. Should be called when the server starts, before any GameLift-dependent initialization happens.
- Returns
- If successful, returns an InitSdkOutcome object indicating that the server process is ready to call ProcessReady().
◆ ProcessEnding()
virtual Aws::GameLift::GenericOutcome AWSGameLift::GameLiftServerSDKWrapper::ProcessEnding |
( |
| ) |
|
|
virtual |
Notifies the GameLift service that the server process is shutting down.
- Returns
- Returns a generic outcome consisting of success or failure with an error message.
◆ ProcessReady()
virtual Aws::GameLift::GenericOutcome AWSGameLift::GameLiftServerSDKWrapper::ProcessReady |
( |
const Aws::GameLift::Server::ProcessParameters & |
processParameters | ) |
|
|
virtual |
Notifies the GameLift service that the server process is ready to host game sessions.
- Parameters
-
processParameters | A ProcessParameters object communicating the names of callback methods, port number and game session-specific log files about the server process. |
- Returns
- Returns a generic outcome consisting of success or failure with an error message.
◆ RemovePlayerSession()
virtual Aws::GameLift::GenericOutcome AWSGameLift::GameLiftServerSDKWrapper::RemovePlayerSession |
( |
const AZStd::string & |
playerSessionId | ) |
|
|
virtual |
Notifies the GameLift service that a player with the specified player session ID has disconnected from the server process.
- Parameters
-
playerSessionId | Unique ID issued by the Amazon GameLift service in response to a call to the AWS SDK Amazon GameLift API action CreatePlayerSession. |
- Returns
- Returns a generic outcome consisting of success or failure with an error message.
◆ StartMatchBackfill()
virtual Aws::GameLift::StartMatchBackfillOutcome AWSGameLift::GameLiftServerSDKWrapper::StartMatchBackfill |
( |
const Aws::GameLift::Server::Model::StartMatchBackfillRequest & |
startMatchBackfillRequest | ) |
|
|
virtual |
Sends a request to find new players for open slots in a game session created with FlexMatch. When the match has been successfully, backfilled updated matchmaker data will be sent to the OnUpdateGameSession callback.
- Parameters
-
startMatchBackfillRequest | This data type is used to send a matchmaking backfill request. |
- Returns
- Returns a StartMatchBackfillOutcome object with the match backfill ticket or failure with an error message.
◆ StopMatchBackfill()
virtual Aws::GameLift::GenericOutcome AWSGameLift::GameLiftServerSDKWrapper::StopMatchBackfill |
( |
const Aws::GameLift::Server::Model::StopMatchBackfillRequest & |
stopMatchBackfillRequest | ) |
|
|
virtual |
Cancels an active match backfill request that was created with StartMatchBackfill
- Parameters
-
stopMatchBackfillRequest | This data type is used to cancel a matchmaking backfill request. |
- Returns
- Returns a generic outcome consisting of success or failure with an error message.
The documentation for this class was generated from the following file:
- Gems/AWSGameLift/Code/AWSGameLiftServer/Source/GameLiftServerSDKWrapper.h