Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Amazon GameLift server SDK 5.x per C++: azioni

Usa il riferimento al server Amazon GameLift C++ SDK 5.x per integrare il tuo gioco multiplayer per l'hosting con Amazon. GameLift Per indicazioni sul processo di integrazione, consulta. Aggiungi Amazon GameLift al tuo server di gioco

Amazon GameLift server SDK 5.x per C++: tipi di dati

GetSdkVersion()

Restituisce il numero di versione corrente del processo SDK integrato nel server.

Sintassi

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

Valore restituito

In caso di successo, restituisce la SDK versione corrente come AwsStringOutcome oggetto. L'oggetto restituito include il numero di versione (esempio5.0.0). Se l'esito è negativo, verrà restituito un messaggio di errore.

Esempio

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

Init SDK ()

Inizializza Amazon. GameLift SDK Chiama questo metodo all'avvio prima di qualsiasi altra fase di inizializzazione relativa ad Amazon GameLift. Questa azione legge i parametri del server dall'ambiente host per configurare la comunicazione tra il processo del server di gioco e il GameLift servizio Amazon.

Se la build del server di gioco verrà distribuita senza Amazon GameLift Agent su Amazon GameLift Anywhere flotta o flotta di container, chiama Init SDK () e specifica una serie di parametri del server.

Sintassi

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

Valore restituito

Restituisce un I nitSDKOutcome oggetto che indica se il processo del server è pronto per la chiamata. ProcessReady()

Esempio

//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 ()

Inizializza Amazon. GameLift SDK Chiama questo metodo all'avvio prima di qualsiasi altra fase di inizializzazione relativa ad Amazon GameLift. Questa azione richiede una serie di parametri del server per configurare la comunicazione tra il processo del server di gioco e il GameLift servizio Amazon.

Se la build del server di gioco verrà distribuita su una EC2 flotta GameLift gestita da Amazon o su un Amazon GameLift Anywhere flotta o flotta di container con Amazon GameLift Agent, chiamata Init SDK () senza parametri del server.

Sintassi

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

Parametri

Valore restituito

Restituisce un I nitSDKOutcome oggetto che indica se il processo del server è pronto per la chiamata. ProcessReady()

Esempio

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

Notifica ad Amazon GameLift che il processo del server è pronto per ospitare sessioni di gioco. Chiama questo metodo dopo averlo Init SDK () invocato. Questo metodo deve essere chiamato solo una volta per processo.

Sintassi

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

Parametri

Valore restituito

Restituisce un risultato generico composto da successo o fallimento con un messaggio di errore.

Esempio

Questo esempio illustra la chiamata ProcessReady() e le implementazioni della funzione delegata.

// 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()

Notifica al GameLift servizio Amazon che il processo del server è pronto per ospitare sessioni di gioco. Questo metodo deve essere chiamato dopo che il processo del server è pronto per ospitare una sessione di gioco. I parametri specificano i nomi delle funzioni di callback che Amazon GameLift può chiamare in determinate circostanze. Il codice del server di gioco deve implementare queste funzioni.

Questa chiamata è asincrona. Per effettuare una chiamata sincrona, utilizza ProcessReady(). Per ulteriori dettagli, consulta Inizializza il processo del server.

Sintassi

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

Parametri

Valore restituito

Restituisce un risultato generico composto da successo o fallimento con un messaggio di errore.

Esempio

// 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()

Notifica ad Amazon GameLift che il processo del server sta terminando. Richiama questo metodo dopo tutte le altre attività di pulizia (inclusa la chiusura della sessione di gioco attiva) e prima di terminare il processo. A seconda del risultato diProcessEnding(), il processo termina con successo (0) o errore (-1) e genera un evento relativo alla flotta. Se il processo termina con un errore, l'evento fleet generato è. SERVER_PROCESS_TERMINATED_UNHEALTHY

Sintassi

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

Valore restituito

Restituisce un risultato generico costituito da successo o fallimento con un messaggio di errore.

Esempio

Questo esempio chiama ProcessEnding() e Destroy() prima di terminare il processo del server con un codice di uscita riuscito o di errore.

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

Notifica ad Amazon GameLift che il processo del server ha attivato una sessione di gioco ed è ora pronto per ricevere le connessioni dei giocatori. Questa azione deve essere richiamata come parte della funzione di onStartGameSession() callback, dopo l'inizializzazione di tutta la sessione di gioco.

Sintassi

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

Valore restituito

Restituisce un risultato generico composto da successo o fallimento con un messaggio di errore.

Esempio

Questo esempio mostra le ActivateGameSession() chiamate come parte della funzione onStartGameSession() delegata.

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

Aggiorna la capacità della sessione di gioco corrente di accettare nuove sessioni giocatore. Una sessione di gioco può essere configurata per accettare o rifiutare tutte le nuove sessioni giocatore.

Sintassi

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

Parametri

Valore restituito

Restituisce un risultato generico costituito da successo o fallimento con un messaggio di errore.

Esempio

Questo esempio definisce la policy di partecipazione alla sessione di gioco corrente per accettare tutti i giocatori.

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

GetGameSessionId()

Recupera l'ID della sessione di gioco ospitata dal processo del server attivo.

Per i processi inattivi che non vengono attivati con una sessione di gioco, la chiamata restituisce un. GameLiftError

Sintassi

AwsStringOutcome GetGameSessionId()

Parametri

Questa operazione non prevede parametri.

Valore restituito

Se l'esito è positivo, l'ID della sessione di gioco verrà restituito come oggetto AwsStringOutcome. Se l'esito è negativo, verrà restituito un messaggio di errore.

Per i processi inattivi che non vengono attivati con una sessione di gioco, la chiamata restituisce Success = True e GameSessionId =. ""

Esempio

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

GetTerminationTime()

Restituisce il tempo di arresto pianificato di un processo del server, se è disponibile un tempo di chiusura. Un processo server interviene dopo aver ricevuto una onProcessTerminate() richiamata da Amazon GameLift. Amazon GameLift chiama onProcessTerminate() per i seguenti motivi:

Sintassi

AwsDateTimeOutcome GetTerminationTime()

Valore restituito

In caso di successo, restituisce l'ora di terminazione come oggetto. AwsDateTimeOutcome Il valore è il tempo di terminazione, espresso in segni di spunta trascorsi da allora. 0001 00:00:00 Ad esempio, il valore della data e dell'ora è uguale ai segni di 2020-09-13 12:26:40 -000Z spunta. 637355968000000000 Se non è disponibile alcun orario di terminazione, restituisce un messaggio di errore.

Se il processo non ha ricevuto un ProcessParameters. OnProcessTerminate() callback, viene restituito un messaggio di errore. Per ulteriori informazioni sulla chiusura di un processo server, vedere. Rispondi a una notifica di chiusura del processo del server

Esempio

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

AcceptPlayerSession()

Notifica ad Amazon GameLift che un giocatore con l'ID di sessione del giocatore specificato si è connesso al processo del server e deve essere convalidato. Amazon GameLift verifica che l'ID di sessione del giocatore sia valido. Dopo la convalida della sessione del giocatore, Amazon GameLift modifica lo stato dello slot del giocatore da RESERVED aACTIVE.

Sintassi

GenericOutcome AcceptPlayerSession(String playerSessionId)

Parametri

Valore restituito

Restituisce un risultato generico composto da successo o fallimento con un messaggio di errore.

Esempio

Questo esempio gestisce una richiesta di connessione che include la convalida e il rifiuto di una sessione giocatore non valida. 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()

Notifica ad Amazon GameLift che un giocatore si è disconnesso dal processo del server. In risposta, Amazon GameLift cambia lo slot del giocatore rendendolo disponibile.

Sintassi

GenericOutcome RemovePlayerSession(String playerSessionId)

Parametri

Valore restituito

Restituisce un risultato generico composto da successo o fallimento con un messaggio di errore.

Esempio

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

DescribePlayerSessions()

Recupera i dati della sessione del giocatore che includono impostazioni, metadati della sessione e dati del giocatore. Utilizzate questo metodo per ottenere informazioni su quanto segue:

Sintassi

DescribePlayerSessionsOutcome DescribePlayerSessions(DescribePlayerSessionsRequest describePlayerSessionsRequest)

Parametri

Valore restituito

Se l'esito è positivo, restituisce un oggetto DescribePlayerSessionsOutcome contenente un set di oggetti di sessione giocatore corrispondente ai parametri della richiesta.

Esempio

Questo esempio richiede che tutte le sessioni dei giocatori siano connesse attivamente a una sessione di gioco specificata. Omettendo NextTokene impostando il valore Limite su 10, Amazon GameLift restituisce i primi 10 record delle sessioni di gioco corrispondenti alla richiesta.

// 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()

Invia una richiesta per trovare nuovi giocatori per le slot aperte in una sessione di gioco creata con FlexMatch. Per ulteriori informazioni, consulta la funzione di FlexMatch riempimento.

Questa operazione è asincrona. Se vengono abbinati nuovi giocatori, Amazon GameLift fornisce dati aggiornati sui matchmaker utilizzando la funzione di callback. OnUpdateGameSession()

Un processo del server può avere un solo backfill degli abbinamenti attivo alla volta. Per inviare una nuova richiesta, chiama prima StopMatchBackfill() per annullare la richiesta originale.

Sintassi

StartMatchBackfillOutcome StartMatchBackfill (StartMatchBackfillRequest startBackfillRequest);

Parametri

Valore restituito

Restituisce un StartMatchBackfillOutcome oggetto con l'ID del ticket match backfill, oppure restituisce un errore con un messaggio di errore.

Esempio

// 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()

Annulla una richiesta di match backfill attiva. Per ulteriori informazioni, consulta la funzione di FlexMatchriempimento.

Sintassi

GenericOutcome StopMatchBackfill (StopMatchBackfillRequest stopBackfillRequest);

Parametri

Valore restituito

Restituisce un risultato generico composto da successo o fallimento con un messaggio di errore.

Esempio

// 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()

Recupera il percorso del TLS certificato utilizzato per crittografare la connessione di rete tra Amazon GameLift Anywhere risorsa di calcolo e Amazon GameLift. Puoi utilizzare il percorso del certificato quando registri il tuo dispositivo di elaborazione su Amazon GameLift Anywhere flotta. Per ulteriori informazioni, vedere, RegisterCompute.

Sintassi

GetComputeCertificateOutcome Server::GetComputeCertificate()

Valore restituito

Restituisce una GetComputeCertificateOutcome.

Esempio

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

GetFleetRoleCredentials()

Recupera le credenziali del IAM ruolo che autorizzano GameLift Amazon a interagire con altri. Servizi AWS Per ulteriori informazioni, consulta Comunica con altre AWS risorse delle tue flotte.

Sintassi

GetFleetRoleCredentialsOutcome GetFleetRoleCredentials(GetFleetRoleCredentialsRequest request);

Parametri

GetFleetRoleCredentialsRequest

Valore restituito

Restituisce un oggetto GetFleetRoleCredentialsOutcome.

Esempio

// 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);

Questo esempio mostra l'uso del RoleSessionName valore opzionale per assegnare un nome alla sessione di credenziali a fini di controllo. Se non si fornisce un nome per la sessione di ruolo, il valore predefinito»[fleet-id]-[host-id]«viene utilizzato.

// 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);

Distruggi ()

Libera il server di GameLift gioco Amazon SDK dalla memoria. È consigliabile chiamare questo metodo dopo ProcessEnding() e prima di terminare il processo. Se utilizzi una flotta Anywhere e non interrompi i processi del server dopo ogni sessione di gioco, chiama Destroy() e poi reinizializza prima di notificare InitSDK() ad Amazon GameLift che il processo è pronto per ospitare una sessione di gioco con. ProcessReady()

Sintassi

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

Parametri

Non ci sono parametri.

Valore restituito

Restituisce un risultato generico costituito da successo o fallimento con un messaggio di errore.

Esempio

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);
}