Amazon GameLift Server SDK 5.x for C++:動作 - Amazon GameLift

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

Amazon GameLift Server SDK 5.x for C++:動作

使用 Amazon GameLift C++ 伺服器 SDK 5.x 參考,整合您的多人遊戲以與 Amazon 託管 GameLift。如需整合程序的指引,請參閱 將 Amazon GameLift 新增至您的遊戲伺服器

注意

本主題說明API使用 GameLift C++ 標準程式庫 () 建置時可以使用的 Amazon C++std。具體而言,本文件適用於您使用 -DDGAMELIFT_USE_STD=1選項編譯的程式碼。

Amazon GameLift Server SDK 5.x for C++:資料類型

GetSdkVersion()

傳回伺服器程序中SDK內建 的目前版本編號。

語法

Aws::GameLift::AwsStringOutcome Server::GetSdkVersion();

傳回值

如果成功, 會傳回目前SDK版本作為AwsStringOutcome物件。傳回的物件包含版本號碼 (範例 5.0.0)。如果不成功,則會傳回錯誤訊息。

範例

Aws::GameLift::AwsStringOutcome SdkVersionOutcome = Aws::GameLift::Server::GetSdkVersion();

Init SDK()

初始化 Amazon GameLift SDK。在與 Amazon 相關的任何其他初始化步驟啟動之前,請先呼叫此方法 GameLift。此動作會從主機環境讀取伺服器參數,以設定遊戲伺服器程序和 Amazon GameLift 服務之間的通訊。

如果在沒有 Amazon GameLift Agent 的情況下將遊戲伺服器建置部署到 Amazon GameLift Anywhere 機群或容器機群,呼叫Init SDK()並指定一組伺服器參數。

語法

Server::InitSDKOutcome Server::initSdkOutcome = InitSDK();

傳回值

傳回我nitSDKOutcome物件,指出伺服器程序是否已準備好呼叫 ProcessReady()

範例

//Call InitSDK to establish a local connection with the GameLift agent to enable further communication. Aws::GameLift::Server::InitSDKOutcome initSdkOutcome = Aws::GameLift::Server::InitSDK();

Init SDK()

初始化 Amazon GameLift SDK。在與 Amazon 相關的任何其他初始化步驟啟動之前,請先呼叫此方法 GameLift。此動作需要一組伺服器參數,才能設定遊戲伺服器程序和 Amazon GameLift 服務之間的通訊。

如果遊戲伺服器建置將部署到 Amazon GameLift 受管EC2機群或 Amazon GameLift Anywhere 使用 Amazon GameLift Agent 的機群或容器機群,呼叫Init SDK()時不含伺服器參數。

語法

Server::InitSDKOutcome Server::initSdkOutcome = InitSDK(serverParameters);

參數

ServerParameters

在 Amazon 上初始化遊戲伺服器 GameLift Anywhere 機群,使用下列資訊建構ServerParameters物件:

  • URL WebSocket 用於連線至遊戲伺服器的 。

  • 用於託管遊戲伺服器的程序 ID。

  • 託管遊戲伺服器程序的運算 ID。

  • 包含 Amazon 的 Amazon GameLift 機群 ID GameLift Anywhere 運算。

  • Amazon GameLift 操作產生的授權權杖。

傳回值

傳回我nitSDKOutcome物件,指出伺服器程序是否已準備好呼叫 ProcessReady()

注意

如果針對部署到 Anywhere 機群的遊戲組建呼叫呼叫InitSDK()失敗,請檢查建立組建資源時使用的ServerSdkVersion參數。您必須明確地將此值設定為正在使用的伺服器SDK版本。此參數的預設值為 4.x,不相容。若要解決此問題,請建立新的建置,並將其部署到新的機群。

範例

Amazon GameLift Anywhere example

//Define the server parameters std::string websocketUrl = "wss://us-west-1.api.amazongamelift.com"; std::string processId = "PID1234"; std::string fleetId = "arn:aws:gamelift:us-west-1:111122223333:fleet/fleet-9999ffff-88ee-77dd-66cc-5555bbbb44aa"; std::string hostId = "HardwareAnywhere"; std::string authToken = "1111aaaa-22bb-33cc-44dd-5555eeee66ff"; Aws::GameLift::Server::Model::ServerParameters serverParameters = Aws::GameLift::Server::Model::ServerParameters(webSocketUrl, authToken, fleetId, hostId, processId); //Call InitSDK to establish a local connection with the GameLift agent to enable further communication. Aws::GameLift::Server::InitSDKOutcome initSdkOutcome = Aws::GameLift::Server::InitSDK(serverParameters);

ProcessReady()

通知 Amazon GameLift 伺服器程序已準備好託管遊戲工作階段。叫用 後呼叫此方法Init SDK()。此方法每個程序只能呼叫一次。

語法

GenericOutcome ProcessReady(const Aws::GameLift::Server::ProcessParameters &processParameters);

參數

processParameters

ProcessParameters 物件會傳達以下有關伺服器程序的資訊:

  • 在 Amazon GameLift 服務叫用以與伺服器程序通訊的遊戲伺服器程式碼中實作的回呼方法名稱。

  • 伺服器程序正在接聽的埠號。

  • 您希望 Amazon GameLift 擷取和儲存的任何遊戲工作階段特定檔案路徑。

傳回值

傳回一般結果,其中包含成功或失敗以及錯誤訊息。

範例

此範例會說明 ProcessReady() 呼叫和委派函數的實作。

// Set parameters and call ProcessReady std::string serverLog("serverOut.log"); // Example of a log file written by the game server std::vector<std::string> logPaths; logPaths.push_back(serverLog); int listenPort = 9339; Aws::GameLift::Server::ProcessParameters processReadyParameter = Aws::GameLift::Server::ProcessParameters( std::bind(&Server::onStartGameSession, this, std::placeholders::_1), std::bind(&Server::onProcessTerminate, this), std::bind(&Server::OnHealthCheck, this), std::bind(&Server::OnUpdateGameSession, this), listenPort, Aws::GameLift::Server::LogParameters(logPaths) ); Aws::GameLift::GenericOutcome outcome = Aws::GameLift::Server::ProcessReady(processReadyParameter); // Implement callback functions void Server::onStartGameSession(Aws::GameLift::Model::GameSession myGameSession) { // game-specific tasks when starting a new game session, such as loading map GenericOutcome outcome = Aws::GameLift::Server::ActivateGameSession (maxPlayers); } void Server::onProcessTerminate() { // game-specific tasks required to gracefully shut down a game session, // such as notifying players, preserving game state data, and other cleanup GenericOutcome outcome = Aws::GameLift::Server::ProcessEnding(); } bool Server::onHealthCheck() { bool health; // complete health evaluation within 60 seconds and set health return health; }

ProcessReadyAsync()

通知 Amazon GameLift 服務伺服器程序已準備好託管遊戲工作階段。在伺服器程序準備好託管遊戲工作階段之後,應呼叫此方法。參數會指定 Amazon 在特定情況下 GameLift 呼叫的回呼函數名稱。遊戲伺服器代碼必須實作上述函數。

此為非同步呼叫。若要進行同步呼叫,請使用 ProcessReady()。如需詳細資訊,請參閱初始化伺服器程序

語法

GenericOutcomeCallable ProcessReadyAsync( const Aws::GameLift::Server::ProcessParameters &processParameters);

參數

processParameters

ProcessParameters 物件會傳達以下有關伺服器程序的資訊:

  • 在 Amazon GameLift 服務叫用以與伺服器程序通訊的遊戲伺服器程式碼中實作的回呼方法名稱。

  • 伺服器程序正在接聽的埠號。

  • 您希望 Amazon GameLift 擷取和儲存的任何遊戲工作階段特定檔案路徑。

必要:是

傳回值

傳回一般結果,其中包含成功或失敗以及錯誤訊息。

範例

// Set parameters and call ProcessReady std::string serverLog("serverOut.log"); // This is an example of a log file written by the game server std::vector<std::string> logPaths; logPaths.push_back(serverLog); int listenPort = 9339; Aws::GameLift::Server::ProcessParameters processReadyParameter = Aws::GameLift::Server::ProcessParameters(std::bind(&Server::onStartGameSession, this, std::placeholders::_1), std::bind(&Server::onProcessTerminate, this), std::bind(&Server::OnHealthCheck, this), std::bind(&Server::OnUpdateGameSession, this), listenPort, Aws::GameLift::Server::LogParameters(logPaths)); Aws::GameLift::GenericOutcomeCallable outcome = Aws::GameLift::Server::ProcessReadyAsync(processReadyParameter); // Implement callback functions void onStartGameSession(Aws::GameLift::Model::GameSession myGameSession) { // game-specific tasks when starting a new game session, such as loading map GenericOutcome outcome = Aws::GameLift::Server::ActivateGameSession (maxPlayers); } void onProcessTerminate() { // game-specific tasks required to gracefully shut down a game session, // such as notifying players, preserving game state data, and other cleanup GenericOutcome outcome = Aws::GameLift::Server::ProcessEnding(); } bool onHealthCheck() { // perform health evaluation and complete within 60 seconds return health; }

ProcessEnding()

通知 Amazon GameLift 伺服器程序正在終止。在所有其他清除任務 (包括關閉作用中的遊戲工作階段) 之後,以及在終止程序之前呼叫此方法。根據 的結果ProcessEnding(),程序會成功 (0) 或錯誤 (-1) 結束並產生機群事件。如果程序因錯誤終止,產生的機群事件為 SERVER_PROCESS_TERMINATED_UNHEALTHY

語法

Aws::GameLift::GenericOutcome processEndingOutcome = Aws::GameLift::Server::ProcessEnding();

傳回值

傳回一般結果,其中包含成功或失敗以及錯誤訊息。

範例

此範例會呼叫 ProcessEnding()和 ,Destroy()然後以成功或錯誤結束碼終止伺服器程序。

Aws::GameLift::GenericOutcome processEndingOutcome = Aws::GameLift::Server::ProcessEnding(); Aws::GameLift::Server::Destroy(); // Exit the process with success or failure if (processEndingOutcome.IsSuccess()) { exit(0); } else { cout << "ProcessEnding() failed. Error: " << processEndingOutcome.GetError().GetErrorMessage(); exit(-1); }

ActivateGameSession()

通知 Amazon GameLift 伺服器程序已啟用遊戲工作階段,現在已準備好接收玩家連線。在所有遊戲工作階段初始化後,此動作應稱為回onStartGameSession()呼函數的一部分。

語法

Aws::GameLift::GenericOutcome activateGameSessionOutcome = Aws::GameLift::Server::ActivateGameSession();

傳回值

傳回一般結果,其中包含成功或失敗以及錯誤訊息。

範例

此範例顯示ActivateGameSession()稱為onStartGameSession()委派函數的一部分。

void onStartGameSession(Aws::GameLift::Model::GameSession myGameSession) { // game-specific tasks when starting a new game session, such as loading map GenericOutcome outcome = Aws::GameLift::Server::ActivateGameSession(); }

UpdatePlayerSessionCreationPolicy()

更新目前遊戲工作階段的能力,以接受新的玩家工作階段。遊戲工作階段可設定為接受或拒絕所有新的玩家工作階段。

語法

GenericOutcome UpdatePlayerSessionCreationPolicy(Aws::GameLift::Model::PlayerSessionCreationPolicy newPlayerSessionPolicy);

參數

playerCreationSession政策

類型:PlayerSessionCreationPolicy列舉值。

必要:是

傳回值

傳回一般結果,其中包含成功或失敗以及錯誤訊息。

範例

此範例設定目前遊戲工作階段的加入政策為可接受所有玩家。

Aws::GameLift::GenericOutcome outcome = Aws::GameLift::Server::UpdatePlayerSessionCreationPolicy(Aws::GameLift::Model::PlayerSessionCreationPolicy::ACCEPT_ALL);

GetGameSessionId()

擷取作用中伺服器程序託管的遊戲工作階段 ID。

對於未透過遊戲工作階段啟用的閒置程序,呼叫會傳回 GameLiftError

語法

AwsStringOutcome GetGameSessionId()

參數

此動作沒有參數。

傳回值

如果成功,則會把遊戲工作階段 ID 當成 AwsStringOutcome 物件傳回。如果不成功,則會傳回錯誤訊息。

對於未透過遊戲工作階段啟用的閒置程序,呼叫會傳回 Success=TrueGameSessionId=""

範例

Aws::GameLift::AwsStringOutcome sessionIdOutcome = Aws::GameLift::Server::GetGameSessionId();

GetTerminationTime()

若設有終止時間,即傳回伺服器程序排定關閉的時間。伺服器程序在收到來自 Amazon 的回onProcessTerminate()呼後會採取動作 GameLift。Amazon GameLift 呼叫onProcessTerminate()原因如下:

  • 當伺服器程序回報運作狀態不佳或尚未回應 Amazon 時 GameLift。

  • 在縮減規模事件期間終止執行個體時。

  • 當執行個體因 Spot-instance 中斷而終止時

語法

AwsDateTimeOutcome GetTerminationTime()

傳回值

如果成功, 會將終止時間傳回為AwsDateTimeOutcome物件。此值是終止時間,以 以來的已過勾號表示0001 00:00:00。例如,日期時間值2020-09-13 12:26:40 -000Z等於637355968000000000勾號。如果沒有可用的終止時間, 會傳回錯誤訊息。

如果程序尚未收到 ProcessParameters.OnProcessTerminate() 回呼,則會傳回錯誤訊息。如需關閉伺服器程序的詳細資訊,請參閱 回應伺服器程序關閉通知

範例

Aws::GameLift::AwsLongOutcome TermTimeOutcome = Aws::GameLift::Server::GetTerminationTime();

AcceptPlayerSession()

通知 Amazon GameLift 具有指定播放器工作階段 ID 的播放器已連線至伺服器程序,且需要驗證。Amazon 會 GameLift 驗證播放器工作階段 ID 是否有效。驗證播放器工作階段後,Amazon 會將播放器插槽的狀態從 GameLift 變更為 RESERVED ACTIVE。

語法

GenericOutcome AcceptPlayerSession(String playerSessionId)

參數

playerSessionId

建立新的播放器工作階段 GameLift 時,Amazon 發行的唯一 ID。

傳回值

傳回一般結果,其中包含成功或失敗以及錯誤訊息。

範例

此範例會處理連線請求,其中包含驗證和拒絕無效的播放器工作階段 IDs。

void ReceiveConnectingPlayerSessionID (Connection& connection, const std::string& playerSessionId) { Aws::GameLift::GenericOutcome connectOutcome = Aws::GameLift::Server::AcceptPlayerSession(playerSessionId); if(connectOutcome.IsSuccess()) { connectionToSessionMap.emplace(connection, playerSessionId); connection.Accept(); } else { connection.Reject(connectOutcome.GetError().GetMessage(); } }

RemovePlayerSession()

通知 Amazon GameLift 播放器已中斷與伺服器程序的連線。為了回應,Amazon 會將播放器插槽 GameLift 變更為可用。

語法

GenericOutcome RemovePlayerSession(String playerSessionId)

參數

playerSessionId

建立新的播放器工作階段 GameLift 時,Amazon 發行的唯一 ID。

傳回值

傳回一般結果,其中包含成功或失敗以及錯誤訊息。

範例

Aws::GameLift::GenericOutcome disconnectOutcome = Aws::GameLift::Server::RemovePlayerSession(playerSessionId);

DescribePlayerSessions()

擷取播放器工作階段資料,包括設定、工作階段中繼資料和播放器資料。使用此方法取得下列相關資訊:

  • 單一播放器工作階段

  • 遊戲工作階段中的所有玩家工作階段

  • 與單一玩家 ID 相關聯的所有玩家工作階段

語法

DescribePlayerSessionsOutcome DescribePlayerSessions(DescribePlayerSessionsRequest describePlayerSessionsRequest)

參數

DescribePlayerSessionsRequest

描述要擷取哪些播放器工作階段的DescribePlayerSessionsRequest物件。

傳回值

如果成功,會傳回 DescribePlayerSessionsOutcome 物件,內含一組與請求參數相符的玩家工作階段物件。

範例

此範例會請求主動連線到指定遊戲工作階段的所有玩家工作階段。透過省略限制NextToken並將其設定為 10,Amazon 會 GameLift 傳回符合請求的前 10 個玩家工作階段記錄。

// Set request parameters Aws::GameLift::Server::Model::DescribePlayerSessionsRequest request; request.SetPlayerSessionStatusFilter(Aws::GameLift::Server::Model::PlayerSessionStatusMapper::GetNameForPlayerSessionStatus(Aws::GameLift::Server::Model::PlayerSessionStatus::Active)); request.SetLimit(10); request.SetGameSessionId("the game session ID"); // can use GetGameSessionId() // Call DescribePlayerSessions Aws::GameLift::DescribePlayerSessionsOutcome playerSessionsOutcome = Aws::GameLift::Server::DescribePlayerSessions(request);

StartMatchBackfill()

傳送請求,以尋找使用 建立的遊戲工作階段中開放插槽的新玩家 FlexMatch。如需詳細資訊,請參閱FlexMatch 回填功能

此為非同步動作。如果新的玩家相符,Amazon 會使用回呼函數 GameLift 提供更新的相符者資料OnUpdateGameSession()

一個伺服器程序一次僅能有一個使用中的配對回填請求。若要發送新請求,請先呼叫 StopMatchBackfill() 取消原始請求。

語法

StartMatchBackfillOutcome StartMatchBackfill (StartMatchBackfillRequest startBackfillRequest);

參數

StartMatchBackfillRequest

物件 StartMatchBackfillRequest 可通訊下列資訊:

  • 指派給回填請求的票證 ID。此資訊為選用;如果未提供 ID,Amazon GameLift 將產生一個 ID。

  • 傳送請求對象的配對建構器。ARN 需要完整組態。此值位於遊戲工作階段的相符者資料中。

  • 要回填的遊戲工作階段 ID。

  • 遊戲工作階段目前玩家的可用配對資料。

傳回值

傳回具有相符回填票證 ID 的StartMatchBackfillOutcome物件,或具有錯誤訊息的失敗。

範例

// Build a backfill request std::vector<Player> players; Aws::GameLift::Server::Model::StartMatchBackfillRequest startBackfillRequest; startBackfillRequest.SetTicketId("1111aaaa-22bb-33cc-44dd-5555eeee66ff"); // optional, autogenerated if not provided startBackfillRequest.SetMatchmakingConfigurationArn("arn:aws:gamelift:us-west-2:111122223333:matchmakingconfiguration/MyMatchmakerConfig"); //from the game session matchmaker data startBackfillRequest.SetGameSessionArn("the game session ARN"); // can use GetGameSessionId() startBackfillRequest.SetPlayers(players); // from the game session matchmaker data // Send backfill request Aws::GameLift::StartMatchBackfillOutcome backfillOutcome = Aws::GameLift::Server::StartMatchBackfill(startBackfillRequest); // Implement callback function for backfill void Server::OnUpdateGameSession(Aws::GameLift::Server::Model::GameSession gameSession, Aws::GameLift::Server::Model::UpdateReason updateReason, std::string backfillTicketId) { // handle status messages // perform game-specific tasks to prep for newly matched players }

StopMatchBackfill()

取消作用中相符回填請求。如需詳細資訊,請參閱FlexMatch回填功能

語法

GenericOutcome StopMatchBackfill (StopMatchBackfillRequest stopBackfillRequest);

參數

StopMatchBackfillRequest

識別要取消之比對票證的 StopMatchBackfillRequest 物件:

  • 指派給回填請求的票證 ID。

  • 回填請求已傳送至的相符者。

  • 與回填請求相關聯的遊戲工作階段。

傳回值

傳回一般結果,其中包含成功或失敗以及錯誤訊息。

範例

// Set backfill stop request parameters Aws::GameLift::Server::Model::StopMatchBackfillRequest stopBackfillRequest; stopBackfillRequest.SetTicketId("1111aaaa-22bb-33cc-44dd-5555eeee66ff"); stopBackfillRequest.SetGameSessionArn("the game session ARN"); // can use GetGameSessionId() stopBackfillRequest.SetMatchmakingConfigurationArn("arn:aws:gamelift:us-west-2:111122223333:matchmakingconfiguration/MyMatchmakerConfig"); // from the game session matchmaker data Aws::GameLift::GenericOutcome stopBackfillOutcome = Aws::GameLift::Server::StopMatchBackfill(stopBackfillRequest);

GetComputeCertificate()

擷取用於加密 Amazon 之間網路連線之TLS憑證的路徑 GameLift Anywhere 運算資源和 Amazon GameLift。您可以在向 Amazon 註冊運算裝置時使用憑證路徑 GameLift Anywhere 機群。如需詳細資訊,請參閱 RegisterCompute

語法

GetComputeCertificateOutcome Server::GetComputeCertificate()

傳回值

傳回 GetComputeCertificateOutcome

範例

Aws::GameLift::GetComputeCertificateOutcome certificate = Aws::GameLift::Server::GetComputeCertificate();

GetFleetRoleCredentials()

擷取授權 Amazon 與其他 GameLift 互動IAM的角色憑證 AWS 服務。如需詳細資訊,請參閱與機群中的其他 AWS 資源通訊

語法

GetFleetRoleCredentialsOutcome GetFleetRoleCredentials(GetFleetRoleCredentialsRequest request);

參數

GetFleetRoleCredentialsRequest

傳回值

其會傳回 GetFleetRoleCredentialsOutcome 物件。

範例

// form the fleet credentials request Aws::GameLift::Server::Model::GetFleetRoleCredentialsRequest getFleetRoleCredentialsRequest; getFleetRoleCredentialsRequest.SetRoleArn("arn:aws:iam::123456789012:role/service-role/exampleGameLiftAction"); Aws::GameLift::GetFleetRoleCredentialsOutcome credentials = Aws::GameLift::Server::GetFleetRoleCredentials(getFleetRoleCredentialsRequest);

此範例顯示使用選用RoleSessionName值,將名稱指派給憑證工作階段以供稽核。如果您沒有提供角色工作階段名稱,預設值為 "[fleet-id]-[host-id]使用 "。

// form the fleet credentials request Aws::GameLift::Server::Model::GetFleetRoleCredentialsRequest getFleetRoleCredentialsRequest; getFleetRoleCredentialsRequest.SetRoleArn("arn:aws:iam::123456789012:role/service-role/exampleGameLiftAction"); getFleetRoleCredentialsRequest.SetRoleSessionName("MyFleetRoleSession"); Aws::GameLift::GetFleetRoleCredentialsOutcome credentials = Aws::GameLift::Server::GetFleetRoleCredentials(getFleetRoleCredentialsRequest);

Destroy()

從記憶體中SDK釋放 Amazon GameLift 遊戲伺服器。最佳實務是在終止程序之後ProcessEnding()和之前呼叫此方法。如果您使用的是 Anywhere 機群,而且沒有在每次遊戲工作階段後終止伺服器程序,請呼叫 Destroy(),然後在通知 Amazon GameLift 程序已準備好使用 託管遊戲工作階段之前InitSDK()重新初始化ProcessReady()

語法

GenericOutcome Aws::GameLift::Server::Destroy();

參數

沒有參數。

傳回值

傳回一般結果,其中包含成功或失敗以及錯誤訊息。

範例

Aws::GameLift::GenericOutcome processEndingOutcome = Aws::GameLift::Server::ProcessEnding(); Aws::GameLift::Server::Destroy(); // Exit the process with success or failure if (processEndingOutcome.IsSuccess()) { exit(0); } else { cout << "ProcessEnding() failed. Error: " << processEndingOutcome.GetError().GetErrorMessage(); exit(-1); }