Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

SDK de serveur C++ pour GameLift Serveurs Amazon 4.x -- Actions

Utilisez la référence du SDK du serveur pour intégrer votre jeu multijoueur à héberger. Amazon GameLift Servers Pour obtenir des conseils sur le processus d'intégration, consultezAddition GameLift Serveurs Amazon sur votre serveur de jeu à l'aide du SDK du serveur.

SDK du serveur C++ pour Amazon GameLift Servers 4.x -- Types de données

AcceptPlayerSession()

Informe le Amazon GameLift Servers service qu'un joueur avec l'ID de session de joueur spécifié s'est connecté au processus serveur et doit être validé. Amazon GameLift Serversvérifie que l'identifiant de session du joueur est valide, c'est-à-dire qu'il a réservé une place de joueur pendant la session de jeu. Une fois la validation effectuée, Amazon GameLift Servers fait passer l'emplacement de joueur de l'état RESERVED à ACTIVE.

Syntaxe

GenericOutcome AcceptPlayerSession(const std::string& playerSessionId);

Parameters

Valeur renvoyée

Renvoie un résultat générique composé d'un succès ou d'un échec avec un message d'erreur.

Exemple

Cet exemple illustre une fonction pour le traitement d'une demande de connexion, y compris la validation et le rejet des ID de session joueur non valides.

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

ActivateGameSession()

Informe le service Amazon GameLift Servers que le processus serveur a démarré une session de jeu et est maintenant prêt à recevoir les connexions de joueurs. Cette action doit être appelée dans le cadre de la fonction de rappel onStartGameSession(), une fois que l'initialisation de toutes les sessions de jeu est terminée.

Syntaxe

GenericOutcome ActivateGameSession();

Parameters

Cette action n'a aucun paramètre.

Valeur renvoyée

Renvoie un résultat générique composé d'un succès ou d'un échec avec un message d'erreur.

Exemple

Cet exemple illustre l'appel de ActivateGameSession() dans le cadre de la fonction de rappel 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();
}

DescribePlayerSessions()

Récupère les données de session de joueur, y compris les paramètres, les métadonnées de session et les données de joueur. Utilisez cette action pour obtenir des informations pour une seule session de joueur, pour toutes les sessions de joueur d'une session de jeu ou pour toutes les sessions de joueur associées à un seul ID de joueur.

Syntaxe

DescribePlayerSessionsOutcome DescribePlayerSessions ( 
    const Aws::GameLift::Server::Model::DescribePlayerSessionsRequest &describePlayerSessionsRequest);

Parameters

Valeur renvoyée

En cas de réussite, renvoie un objet DescribePlayerSessionsOutcome qui contient un ensemble d'objets de session de joueur correspondant aux paramètres de la demande. Les objets de session du joueur ont une structure identique au type de PlayerSession données de Amazon GameLift Servers l'API du AWS SDK.

Exemple

Cet exemple illustre une demande de toutes les sessions de joueur activement connectées à une session de jeu spécifiée. Si vous omettez NextToken et définissez la valeur de Limit sur 10, Amazon GameLift Servers renvoie les 10 premiers enregistrements de sessions de joueur qui correspondent à la demande.

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

GetGameSessionId()

Extrait un identifiant unique pour la session de jeu actuellement hébergée par le processus serveur, si ce dernier est actif. L'identifiant est retourné dans un format ARN : arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>.

Pour les processus inactifs qui n'ont pas encore été activés lors d'une session de jeu, l'appel renvoie Success GameSessionId = True et = "" (une chaîne vide).

Syntaxe

AwsStringOutcome GetGameSessionId();

Parameters

Cette action n'a aucun paramètre.

Valeur renvoyée

En cas de réussite, renvoie l'ID de session de jeu en tant qu'objet AwsStringOutcome. En cas d'échec, renvoie un message d'erreur.

Exemple

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

GetInstanceCertificate()

Récupère l'emplacement du fichier d'un certificat TLS codé PEM associé à la flotte et à ses instances. AWS Certificate Manager génère ce certificat lorsque vous créez une nouvelle flotte avec la configuration du certificat définie sur GENERATED. Utilisez ce certificat pour établir une connexion sécurisée avec un client de jeu et pour crypter les client/server communications.

Syntaxe

GetInstanceCertificateOutcome GetInstanceCertificate();

Parameters

Cette action n'a aucun paramètre.

Valeur renvoyée

En cas de succès, renvoie un GetInstanceCertificateOutcome objet contenant l'emplacement du fichier de certificat TLS et de la chaîne de certificats de la flotte, qui sont stockés sur l'instance. Un fichier de certificat racine, extrait de la chaîne de certificats, est également stocké sur l'instance. En cas d'échec, renvoie un message d'erreur.

Pour plus d'informations sur le certificat et les données de la chaîne de certificats, consultez la section Éléments de GetCertificate réponse dans la référence de l' AWS Certificate Manager API.

Exemple

Aws::GameLift::GetInstanceCertificateOutcome certificateOutcome = 
    Aws::GameLift::Server::GetInstanceCertificate();

GetSdkVersion()

Renvoie numéro de version actuel du kit SDK en cours d'utilisation.

Syntaxe

AwsStringOutcome GetSdkVersion();

Parameters

Cette action n'a aucun paramètre.

Valeur renvoyée

En cas de réussite, renvoie la version actuelle du kit SDK en tant qu'objet AwsStringOutcome. La chaîne renvoyée inclut uniquement le numéro de version (par exemple « 3.1.5 »). En cas d'échec, renvoie un message d'erreur.

Exemple

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

GetTerminationTime()

Renvoie l'heure d'arrêt planifiée pour un processus serveur, si une heure de résiliation est disponible. Un processus serveur effectue cette action après avoir reçu un onProcessTerminate() rappel du Amazon GameLift Servers service. Amazon GameLift Serverspeut appeler onProcessTerminate() pour les raisons suivantes : (1) lorsque le processus du serveur a signalé un mauvais état de santé ou n'a pas réponduAmazon GameLift Servers, (2) lors de la fermeture de l'instance lors d'un événement de réduction d'échelle, ou (3) lorsqu'une instance est arrêtée en raison d'une interruption ponctuelle.

Si le processus a reçu un onProcessTerminate() rappel, la valeur renvoyée est le temps de fin estimé. Si le processus n'a pas reçu de onProcessTerminate() rappel, un message d'erreur est renvoyé. En savoir plus sur l'arrêt d'un processus serveur.

Syntaxe

AwsLongOutcome GetTerminationTime();

Parameters

Cette action n'a aucun paramètre.

Valeur renvoyée

En cas de succès, renvoie l'heure de fin en tant qu'AwsLongOutcomeobjet. La valeur est le temps de fin, exprimé en ticks écoulés depuis 0001 00:00:00. Par exemple, la valeur de la date et de l'heure 2020-09-13 12:26:40 -000Z est égale à 637355968000000000 ticks. Si aucun délai de résiliation n'est disponible, renvoie un message d'erreur.

Exemple

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

InitSDK()

Initialise le kit SDK Amazon GameLift Servers. Cette méthode doit être appelée au lancement, avant l'exécution de toute autre initialisation liée à Amazon GameLift Servers.

Syntaxe

InitSDKOutcome InitSDK();

Parameters

Cette action n'a aucun paramètre.

Valeur renvoyée

En cas de succès, renvoie un InitSdkOutcome objet indiquant que le processus serveur est prêt à être appeléProcessReady().

Exemple

Aws::GameLift::Server::InitSDKOutcome initOutcome = 
    Aws::GameLift::Server::InitSDK(); 

ProcessEnding()

Informe le service Amazon GameLift Servers que le processus serveur est en cours d'arrêt. Cette méthode doit être appelée après toutes les autres tâches de nettoyage, y compris l'arrêt de toutes les sessions de jeu actives. Cette méthode doit quitter avec un code de sortie 0 ; un code de sortie différent de 0 génère un message d'événement indiquant que le processus ne s'est pas fermé correctement.

Une fois que la méthode se termine avec un code de 0, vous pouvez terminer le processus avec un code de sortie réussi. Vous pouvez également quitter le processus à l'aide d'un code d'erreur. Si vous quittez la session avec un code d'erreur, l'événement de flotte indiquera que le processus s'est terminé de manière anormale (SERVER_PROCESS_TERMINATED_UNHEALTHY).

Syntaxe

GenericOutcome ProcessEnding();

Parameters

Cette action n'a aucun paramètre.

Valeur renvoyée

Renvoie un résultat générique composé d'un succès ou d'un échec avec un message d'erreur.

Exemple

Aws::GameLift::GenericOutcome outcome = Aws::GameLift::Server::ProcessEnding();
if (outcome.Success)
    exit(0);  // exit with success
// otherwise, exit with error code
exit(errorCode);
            

ProcessReady()

Informe le service Amazon GameLift Servers que le processus serveur est prêt à héberger des sessions de jeu. Appelez cette méthode après avoir invoqué InitSDK() et terminé avec succès les tâches de configuration requises pour que le processus serveur puisse héberger une session de jeu. Cette méthode ne doit être appelée qu'une seule fois par processus.

Cet appel est synchrone. Pour effectuer un appel asynchrone, utilisez ProcessReadyAsync(). Pour plus d’informations, consultez Initialiser le processus du serveur.

Syntaxe

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

Parameters

Valeur renvoyée

Renvoie un résultat générique composé d'un succès ou d'un échec avec un message d'erreur.

Exemple

Cet exemple illustre les implémentations de la fonction d'appel et de rappel 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()

Informe le service Amazon GameLift Servers que le processus serveur est prêt à héberger des sessions de jeu. Cette méthode doit être appelée une fois que le processus serveur est prêt à héberger une session de jeu. Les paramètres spécifient les noms des fonctions de rappel qu'Amazon GameLift Servers doit appeler dans certaines circonstances. Le code du serveur de jeux doit implémenter ces fonctions.

Cet appel est asynchrone. Pour effectuer un appel synchrone, utilisez ProcessReady(). Pour plus d’informations, consultez Initialiser le processus du serveur.

Syntaxe

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

Parameters

Valeur renvoyée

Renvoie un résultat générique composé d'un succès ou d'un échec avec un message d'erreur.

Exemple

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

RemovePlayerSession()

Informe le service Amazon GameLift Servers qu'un joueur avec l'ID de session de joueur spécifié s'est déconnecté du processus serveur. En réponse, Amazon GameLift Servers fait passer l'emplacement de joueur à l'état disponible, ce qui lui permet d'être attribué à un nouveau joueur.

Syntaxe

GenericOutcome RemovePlayerSession(
    const std::string& playerSessionId);

Parameters

Valeur renvoyée

Renvoie un résultat générique composé d'un succès ou d'un échec avec un message d'erreur.

Exemple

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

StartMatchBackfill()

Envoie une demande de recherche de nouveaux joueurs pour des emplacements ouverts dans une session de jeu créée avec FlexMatch. Consultez également l'action du AWS SDK StartMatchBackfill (). Avec cette action, les requêtes de renvoi de correspondance peuvent être initiées par processus de serveur de jeu qui héberge la session de jeu. En savoir plus sur la fonction de FlexMatch remblayage.

Cette action est asynchrone. Si de nouveaux joueurs sont mis en correspondance avec succès, le Amazon GameLift Servers service fournit des données de matchmaking mises à jour en invoquant la fonction de rappel. OnUpdateGameSession()

Un processus de serveur ne peut comporter qu'une seule requête de renvoi de correspondance à la fois. Pour envoyer une nouvelle requête, appelez d'abord StopMatchBackfill() pour annuler la requête d'origine.

Syntaxe

StartMatchBackfillOutcome StartMatchBackfill ( 
    const Aws::GameLift::Server::Model::StartMatchBackfillRequest &startBackfillRequest);

Parameters

Valeur renvoyée

Renvoie un StartMatchBackfillOutcome objet avec le ticket de remplissage correspondant ou un échec avec un message d'erreur. L'état du ticket peut être suivi à l'aide de l'action AWS SDK DescribeMatchmaking ().

Exemple

// Build a backfill request
std::vector<Player> players;
Aws::GameLift::Server::Model::StartMatchBackfillRequest startBackfillRequest;
startBackfillRequest.SetTicketId("a ticket ID");                                         //optional, autogenerated if not provided
startBackfillRequest.SetMatchmakingConfigurationArn("the matchmaker configuration ARN"); //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()

Annule une requête de renvoi de correspondance active qui a été créée avec StartMatchBackfill(). Consultez également l'action du AWS SDK StopMatchmaking (). En savoir plus sur la fonction de FlexMatch remblayage.

Syntaxe

GenericOutcome StopMatchBackfill ( 
    const Aws::GameLift::Server::Model::StopMatchBackfillRequest &stopBackfillRequest);

Parameters

Valeur renvoyée

Renvoie un résultat générique composé d'un succès ou d'un échec avec un message d'erreur.

Exemple

// Set backfill stop request parameters

Aws::GameLift::Server::Model::StopMatchBackfillRequest stopBackfillRequest;
stopBackfillRequest.SetTicketId("the ticket ID");
stopBackfillRequest.SetGameSessionArn("the game session ARN");                           // can use GetGameSessionId()
stopBackfillRequest.SetMatchmakingConfigurationArn("the matchmaker configuration ARN");  // from the game session matchmaker data

Aws::GameLift::GenericOutcome stopBackfillOutcome = 
    Aws::GameLift::Server::StopMatchBackfillRequest(stopBackfillRequest);

TerminateGameSession()

Cette méthode est obsolète depuis la version 4.0.1. Au lieu de cela, le processus serveur doit appeler ProcessEnding() après la fin d'une session de jeu.

Indique au Amazon GameLift Servers service que le processus serveur a mis fin à la session de jeu en cours. Cette action est appelée lorsque le processus serveur reste actif et prêt à héberger une nouvelle session de jeu. Il ne doit être appelé qu'une fois la procédure de résiliation de votre session de jeu terminée, car il indique Amazon GameLift Servers que le processus du serveur est immédiatement disponible pour héberger une nouvelle session de jeu.

Cette action n'est pas appelée si le processus du serveur doit être arrêté après l'arrêt de la session de jeu. Appelez plutôt ProcessEnding() pour signaler que la session de jeu et le processus du serveur se terminent.

Syntaxe

GenericOutcome TerminateGameSession();

Parameters

Cette action n'a aucun paramètre.

Valeur renvoyée

Renvoie un résultat générique composé d'un succès ou d'un échec avec un message d'erreur.

UpdatePlayerSessionCreationPolicy()

Met à jour la capacité de la session de jeu à accepter de nouvelles sessions de joueur. Une session de jeu peut être définie pour accepter ou refuser toutes les nouvelles sessions joueur. Consultez également l'action du AWS SDK UpdateGameSession ().

Syntaxe

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

Parameters

Valeur renvoyée

Renvoie un résultat générique composé d'un succès ou d'un échec avec un message d'erreur.

Exemple

Cet exemple définit la stratégie de participation de la session de jeu actuelle de manière à ce que tous les joueurs soient acceptés.

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

Détruire ()

Nettoie la mémoire allouée par initSDK () lors de l'initialisation du serveur de jeu. Utilisez cette méthode après avoir terminé le processus d'un serveur de jeu pour éviter de gaspiller la mémoire du serveur.

Syntaxe

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

Parameters

Il n'y a aucun paramètre.

Valeur renvoyée

Renvoie un résultat générique composé d'un succès ou d'un échec avec un message d'erreur.

Exemple

Cet exemple nettoie la mémoire allouée par InitSDK après la fin d'un processus sur un serveur de jeu.

if (Aws::GameLift::Server::ProcessEnding().IsSuccess()) {
  Aws::GameLift::Server::Destroy();
  exit(0);
}