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 5.x pour Amazon GameLift Servers
<a name="reference-serversdk"></a>

Cette section fournit une documentation de référence pour le SDK 5.x du serveur pour. Amazon GameLift Servers Le SDK du serveur fournit les fonctionnalités de base que votre serveur de jeu utilise pour interagir avec le Amazon GameLift Servers service. Par exemple, votre serveur de jeu reçoit des instructions du service pour démarrer et arrêter des sessions de jeu et fournit régulièrement des mises à jour de l'état des sessions de jeu au service. Intégrez vos serveurs de jeu au SDK du serveur avant de les déployer pour l'hébergement.

Utilisez cette référence au SDK de serveur pour intégrer vos serveurs de jeux multijoueurs personnalisés à des fins d'Amazon GameLift Servershébergement. Pour obtenir des conseils sur le processus d'intégration, consultez[Ajoutez Amazon GameLift Servers à votre serveur de jeu avec le SDK du serveur](gamelift-sdk-server-api.md).

La dernière version majeure du SDK du serveur pour Amazon GameLift Servers est la version 5.x. Les fonctionnalités d'hébergement suivantes nécessitent l'utilisation de la version 5.x : 
+ Amazon GameLift ServersN'importe où
+ Amazon GameLift Serversplugin pour Unreal Engine et Unity

**Note**  
Si vous devez utiliser la version 4.x ou antérieure du SDK du serveur, consultez la documentation et [SDK du serveur pour les Amazon GameLift Servers versions 4 et antérieures](reference-serversdk4.md) les informations de téléchargement.

**Topics**
+ [Mises à jour du SDK 5 du serveur pour Amazon GameLift Servers](#reference-serversdk5-about)
+ [Migrer vers le SDK 5.x du serveur pour Amazon GameLift Servers](reference-serversdk5-migration.md)
+ [SDK 5.x du serveur C\$1\$1 pour Amazon GameLift Servers -- Actions](integration-server-sdk5-cpp-actions.md)
+ [SDK 5.x du serveur C\$1 pour -- Actions Amazon GameLift Servers](integration-server-sdk5-csharp-actions.md)
+ [SDK du serveur Go pour Amazon GameLift Servers -- Actions](integration-server-sdk-go-actions.md)
+ [SDK 5.x du serveur C\$1\$1 (Unreal) pour Amazon GameLift Servers -- Actions](integration-server-sdk5-unreal-actions.md)

## Mises à jour du SDK 5 du serveur pour Amazon GameLift Servers
<a name="reference-serversdk5-about"></a>

Vos serveurs de jeu hébergés utilisent le SDK du serveur pour communiquer avec le Amazon GameLift Servers service Amazon GameLift Servers afin de démarrer et de gérer les sessions de jeu pour les joueurs. La dernière version, le SDK 5 pour Amazon GameLift Servers serveurs, propose un certain nombre d'améliorations et prend en charge de nouvelles Amazon GameLift Servers fonctionnalités. Si la version de votre serveur de jeu utilise Amazon GameLift Servers actuellement le SDK 4 ou une version antérieure, suivez les instructions de cette rubrique pour mettre à jour vos jeux. 

Amazon GameLift ServersLes versions 5.0.0 et supérieures du SDK du serveur incluent les mises à jour suivantes :
+ Langages étendus — Les bibliothèques sont disponibles dans les langages suivants : C\$1\$1, C\$1, Go. Vous pouvez créer les bibliothèques C\$1\$1 à utiliser avec Unreal Engine.
+ Support des plugins pour moteurs de jeu — Les plugins Amazon GameLift Servers autonomes pour Unreal Engine et Unity nécessitent des bibliothèques Amazon GameLift Servers du SDK 5 pour le serveur. Ces plugins proposent des flux de travail guidés pour intégrer, tester et déployer vos jeux à des Amazon GameLift Servers fins d'hébergement. Voir [Amazon GameLift Serversplugin pour Unity (SDK serveur 5.x)](unity-plug-in.md) et [Amazon GameLift Serversplugin pour Unreal Engine](unreal-plugin.md) documentation.
+ Amazon GameLift ServersAssistance partout — Avec les flottes Anywhere, vous pouvez configurer vos propres ressources d'hébergement pour utiliser les Amazon GameLift Servers fonctionnalités (y compris le matchmaking). Ajoutez l'Amazon GameLift Serversagent pour automatiser la gestion du cycle de vie des sessions de jeu. Utilisez les flottes Anywhere pour l'hébergement de production avec du matériel sur site, ou configurez des environnements de test pour un développement itératif rapide de jeux. Voir [Hébergement n'importe où](gamelift-intro-flavors.md#gamelift-intro-flavors-hosting-anywhere) et l'[Amazon GameLift Serversagent](https://github.com/aws/amazon-gamelift-agent).
+ Outils de test mis à jour — La fonctionnalité Amazon GameLift Servers Anywhere vous permet de configurer des environnements de test locaux ou basés sur le cloud pour vos jeux. Configurez les tests avec ou sans l'Amazon GameLift Serversagent. Ces outils remplacent Amazon GameLift Servers Local. Consultez [Configurez des tests locaux avec Amazon GameLift Servers Anywhere](integration-testing.md).
+ Solution .NET consolidée pour C\$1 — Le SDK 5.1\$1 du serveur C\$1 prend en charge .NET Framework 4.6.2 (mis à niveau depuis 4.6.1) et .NET 6.0 dans une seule solution. .NET Standard 2.1 est disponible avec les bibliothèques créées par Unity.
+ Nouvelle `Compute` ressource — Cette nouvelle ressource combine différents types de ressources d'hébergement. Il inclut des ressources d'hébergement basées sur le cloud (flottes gérées EC2 ou de conteneurs) et des ressources d'hébergement contrôlées par le client (flottes Anywhere). Il inclut les mises à jour suivantes : 
  + Les nouveaux appels d'API pour la `Compute` ressource incluent : [ListCompute()](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_ListCompute.html), [DescribeCompute()](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_DescribeCompute.html) et [GetComputeAccess()](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_GetComputeAccess.html). Ces actions renvoient des informations sur les ressources d'hébergement pour tout type de Amazon GameLift Servers flotte. En général, pour les flottes dotées de serveurs de jeux utilisant le SDK 5.x du serveur, utilisez les actions spécifiques au calcul pour remplacer les actions spécifiques à l'instance. En outre, ces actions sont destinées à être utilisées dans les flottes Anywhere sans l'Amazon GameLift Serversagent : [RegisterCompute()](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html), [DeregisterCompute()](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_DeregisterCompute.html) et [GetComputeAuthToken()](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_GetComputeAuthToken.html).
  + Nouvelle métrique `ActiveCompute` avec CloudWatch dimensions`FleetId`,`Location`, et`ComputeType`. Cette métrique remplace la métrique précédente`ActiveInstances`.
+ Amazon EC2 Systems Manager (SSM) pour l'accès à distance : pour plus de sécurité, utilisez SSM au lieu de SSH lorsque vous vous connectez à des instances de flottes gérées. Amazon GameLift Servers Consultez [Connect aux instances de flotte](fleets-remote-access.md).

# Migrer vers le SDK 5.x du serveur pour Amazon GameLift Servers
<a name="reference-serversdk5-migration"></a>

Pour mettre à jour un projet de jeu afin d'utiliser la version 5.x du SDK du serveur, apportez les modifications suivantes :

**Note**  
Si vous devez continuer à utiliser la version 4.x ou antérieure du SDK du serveur, consultez la documentation et [SDK du serveur pour les Amazon GameLift Servers versions 4 et antérieures](reference-serversdk4.md) les informations de téléchargement. Pour la version 4.0.2 du SDK en particulier, vous pouvez le télécharger depuis les versions [officielles GitHub ](https://github.com/amazon-gamelift/amazon-gamelift-servers-csharp-server-sdk/releases).

1. Procurez-vous le dernier SDK de serveur pour le Amazon GameLift Servers package pour votre environnement de développement **[[Site de téléchargement](https://aws.amazon.com/gamelift/servers/getting-started-sdks/)]**. Suivez les instructions d'installation figurant dans le `Readme` fichier correspondant au package et à la version que vous avez téléchargés. Consultez ces instructions pour utiliser le serveur SDKs avec votre projet de jeu.
   + [Pour les environnements de développement utilisant C\$1\$1, C\$1 ou Go](gamelift-sdk-server-api.md)
   + [Pour les projets Unreal Engine (SDK du serveur C\$1\$1 pour les bibliothèques Unreal uniquement)](integration-engines-setup-unreal.md)
   + [Pour les projets Unity (SDK du serveur C\$1 pour les bibliothèques Unity uniquement)](integration-engines-unity-using.md)
   + [À utiliser avec le Amazon GameLift Servers plugin pour Unreal Engine](unreal-plugin.md)
   + [À utiliser avec le Amazon GameLift Servers plugin pour Unity](unity-plug-in.md)

1. Mettez à jour le code de votre serveur comme suit :
   + Remplacez la fonction de rappel du code du serveur par`onCreateGameSession()`. `onStartGameSession()`
   + Mettez à jour les `InitSDK()` entrées comme il convient : 
     + Si vous prévoyez de déployer la version du serveur de jeu sur une flotte EC2 Amazon GameLift Servers gérée ou sur une flotte Anywhere avec l'Amazon GameLift Serversagent : 

       Appel `InitSDK()` sans paramètres ([C\$1\$1](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-initsdk)) ([C\$1](integration-server-sdk5-csharp-actions.md#integration-server-sdk5-csharp-initsdk)) ([Unreal](integration-server-sdk5-unreal-actions.md#integration-server-sdk5-unreal-initsdk)). Cet appel définit l'environnement informatique et une WebSocket connexion au Amazon GameLift Servers service. 
     + Si vous envisagez de déployer la version du serveur de jeu sur une flotte Anywhere sans l'Amazon GameLift Serversagent :

       Appel `InitSDK()` avec les paramètres du serveur ([C\$1\$1](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-initsdk-anywhere)) ([C\$1](integration-server-sdk5-csharp-actions.md#integration-server-sdk5-csharp-initsdk-anywhere)) ([Unreal](integration-server-sdk5-unreal-actions.md#integration-server-sdk5-unreal-initsdk-anywhere)). Un processus de serveur de jeu utilise ces paramètres pour établir une connexion avec le Amazon GameLift Servers service.

1. Si la version de votre serveur de jeu ou d'autres applications hébergées communiquent avec d'autres AWS ressources en cours d'exécution, vous devez modifier la manière dont l'application accède à ces ressources. Remplacez l'utilisation de `AssumeRoleCredentials` par l'action du nouveau SDK du serveur `GetFleetRoleCredentials()` (pour les serveurs de jeux) ou utilisez des informations d'identification partagées (pour les autres applications). Pour en savoir plus sur la mise en œuvre de cette modification, consultez[Connectez votre serveur de jeu Amazon GameLift Servers hébergé à d'autres AWS ressources](gamelift-sdk-server-resources.md).

1. Si votre projet a appelé l'action du SDK du serveur `GetInstanceCertificate()` pour récupérer un certificat TLS, modifiez votre code pour utiliser le nouveau `GetComputeCertificate()` ([C\$1\$1](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-getcomputecertificate)) ([C\$1](integration-server-sdk5-csharp-actions.md#integration-server-sdk5-csharp-getcomputecertificate)) ([Unreal](integration-server-sdk5-unreal-actions.md#integration-server-sdk5-unreal-getcomputecertificate)) à la place.

1. Lorsque vous téléchargez la version de votre jeu vers Amazon GameLift Servers (par exemple avec [upload-build](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/upload-build.html) ou [CreateBuild())](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_CreateBuild.html), définissez le `ServerSdkVersion` paramètre sur la version 5.x que vous utilisez (ce paramètre est actuellement 4.0.2 par défaut). Ce paramètre doit correspondre aux bibliothèques du SDK du serveur présentes dans la version du serveur de jeu. Si vous spécifiez une version incorrecte pour une version de serveur de jeu téléchargée, toutes les flottes que vous créerez avec cette version échoueront. Consultez [Créez un serveur de jeu conçu pour Amazon GameLift Servers](gamelift-build-cli-uploading.md).

   L'exemple suivant montre comment spécifier la version du SDK du serveur : 

   ```
   aws gamelift upload-build \
       --operating-system AMAZON_LINUX_2023 \
       --server-sdk-version "5.0.0" \
       --build-root "~/mygame" \
       --name "My Game Nightly Build" \
       --build-version "build 255" \
       --region us-west-2
   ```

1. Si vous utilisez des scripts pour vous connecter à distance à des flottes gérées, mettez-les à jour pour utiliser le nouveau processus, comme décrit dans[Connect aux instances de flotte](fleets-remote-access.md).

# SDK 5.x du serveur C\$1\$1 pour Amazon GameLift Servers -- Actions
<a name="integration-server-sdk5-cpp-actions"></a>

Utilisez la référence du SDK 5.x du serveur pour intégrer votre jeu multijoueur à des fins d'hébergement. Amazon GameLift Servers Pour obtenir des conseils sur le processus d'intégration, consultez[Ajoutez Amazon GameLift Servers à votre serveur de jeu avec le SDK du serveur](gamelift-sdk-server-api.md).

**Note**  
Cette rubrique décrit l'API Amazon GameLift Servers C\$1\$1 que vous pouvez utiliser lorsque vous créez avec la bibliothèque standard C\$1\$1 (`std`). Plus précisément, cette documentation s'applique au code que vous compilez avec l'`-DDGAMELIFT_USE_STD=1`option. 

# SDK 5.x du serveur C\$1\$1 pour Amazon GameLift Servers -- Types de données
<a name="integration-server-sdk5-cpp-datatypes"></a>

Utilisez la référence du SDK 5.x du serveur Amazon GameLift Servers C\$1\$1 pour intégrer votre jeu multijoueur à des fins d'hébergement. Amazon GameLift Servers Pour obtenir des conseils sur le processus d'intégration, consultez[Ajoutez Amazon GameLift Servers à votre serveur de jeu avec le SDK du serveur](gamelift-sdk-server-api.md).

**Note**  
Cette rubrique décrit l'API Amazon GameLift Servers C\$1\$1 que vous pouvez utiliser lorsque vous créez avec la bibliothèque standard C\$1\$1 (`std`). Plus précisément, cette documentation s'applique au code que vous compilez avec l'`-DDGAMELIFT_USE_STD=1`option. 

[SDK 5.x du serveur C\$1\$1 pour Amazon GameLift Servers -- Actions](integration-server-sdk5-cpp-actions.md)

**Topics**
+ [LogParameters](#integration-server-sdk5-cpp-dataypes-log)
+ [MetricsParameters](#integration-server-sdk5-cpp-datatypes-metricsparameters)
+ [ProcessParameters](#integration-server-sdk5-cpp-dataypes-process)
+ [UpdateGameSession](#integration-server-sdk5-cpp-dataypes-updategamesession)
+ [GameSession](#integration-server-sdk5-cpp-dataypes-gamesession)
+ [ServerParameters](#integration-server-sdk5-cpp-dataypes-serverparameters)
+ [StartMatchBackfillRequest](#integration-server-sdk5-cpp-dataypes-startmatchbackfillrequest)
+ [Joueur](#integration-server-sdk5-cpp-dataypes-player)
+ [DescribePlayerSessionsRequest](#integration-server-sdk5-cpp-dataypes-playersessions)
+ [StopMatchBackfillRequest](#integration-server-sdk5-cpp-dataypes-stopmatchbackfillrequest)
+ [AttributeValue](#integration-server-sdk5-cpp-dataypes-attributevalue)
+ [GetFleetRoleCredentialsRequest](#integration-server-sdk5-cpp-dataypes-getfleetrolecredentialsrequest)
+ [AwsLongOutcome](#integration-server-sdk5-cpp-datatypes-awslongoutcome)
+ [AwsStringOutcome](#integration-server-sdk5-cpp-datatypes-awsstringoutcome)
+ [DescribePlayerSessionsOutcome](#integration-server-sdk5-cpp-datatypes-describeplayersessionsoutcome)
+ [DescribePlayerSessionsResult](#integration-server-sdk5-cpp-datatypes-describeplayersessionsresult)
+ [GenericOutcome](#integration-server-sdk5-cpp-datatypes-genericoutcome)
+ [GenericOutcomeCallable](#integration-server-sdk5-cpp-datatypes-genericoutcomecallable)
+ [PlayerSession](#integration-server-sdk5-cpp-datatypes-playersession)
+ [StartMatchBackfillOutcome](#integration-server-sdk5-cpp-datatypes-startmatchbackfilloutcome)
+ [StartMatchBackfillResult](#integration-server-sdk5-cpp-datatypes-startmatchbackfillresult)
+ [GetComputeCertificateOutcome](#integration-server-sdk5-cpp-datatypes-getcomputecertificateoutcome)
+ [GetComputeCertificateResult](#integration-server-sdk5-cpp-datatypes-getcomputecertificateresult)
+ [GetFleetRoleCredentialsOutcome](#integration-server-sdk5-cpp-datatypes-getfleetrolecredentialsoutcome)
+ [GetFleetRoleCredentialsResult](#integration-server-sdk5-cpp-datatypes-getfleetrolecredentialsresult)
+ [Initialiser SDKOutcome](#integration-server-sdk5-cpp-datatypes-initsdkoutcome)
+ [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror)
+ [Enums](#integration-server-sdk5-cpp-dataypes-enums)

## LogParameters
<a name="integration-server-sdk5-cpp-dataypes-log"></a>

Objet identifiant les fichiers générés au cours d'une session de jeu que vous Amazon GameLift Servers souhaitez télécharger et stocker à la fin de la session de jeu. Le serveur de jeu fournit `LogParameters` to dans Amazon GameLift Servers le cadre d'un `ProcessParameters` objet lors d'un [ProcessReady()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-processready) appel.


|  |  | 
| --- |--- |
|  **Propriétés**  | Description | 
| LogPaths |  La liste des chemins de répertoire vers les fichiers journaux du serveur de jeu que vous Amazon GameLift Servers souhaitez stocker pour un accès futur. Le processus du serveur génère ces fichiers lors de chaque session de jeu. Vous définissez les chemins et les noms des fichiers sur votre serveur de jeu et vous les stockez dans le répertoire racine du jeu.  Les chemins du journal doivent être absolus. Par exemple, si votre build de jeu stocke les journaux de session de jeu dans un chemin tel que`MyGame\sessionLogs\`, le chemin se `c:\game\MyGame\sessionLogs` trouve sur une instance Windows. **Type :** `std:vector<std::string>` **Obligatoire** : non  | 

## MetricsParameters
<a name="integration-server-sdk5-cpp-datatypes-metricsparameters"></a>

Utilisez ce type de données pour configurer la collecte de métriques et le signalement des pannes pour le serveur de jeu. Le serveur de jeu communique avec `MetricsParameters` Amazon GameLift Servers lors d'un [InitMetrics()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-initmetrics) appel.


|  |  | 
| --- |--- |
|  **Propriétés**  | Description | 
| StatsdHost |  Le nom d'hôte ou l'adresse IP du serveur StatsD pour la collecte des métriques. **Type :** `std::string` **Obligatoire** : non  | 
| StatsdPort |  Numéro de port du serveur StatsD pour la collecte des métriques. **Type :** `int` **Obligatoire** : non  | 
| CrashReporterHost |  Le nom d'hôte ou l'adresse IP du serveur de signalement des incidents. **Type :** `std::string` **Obligatoire** : non  | 
| CrashReporterPort |  Numéro de port du serveur Crash Reporter. **Type :** `int` **Obligatoire** : non  | 
| FlushIntervalMs |  Intervalle en millisecondes pour le transfert des données de métriques vers le serveur. **Type :** `int` **Obligatoire** : non  | 
| MaxPacketSize |  Taille maximale en octets des paquets de métriques envoyés au serveur. **Type :** `int` **Obligatoire** : non  | 

## ProcessParameters
<a name="integration-server-sdk5-cpp-dataypes-process"></a>

Ce type de données contient l'ensemble des paramètres envoyés à Amazon GameLift Servers dans un[ProcessReady()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-processready).


|  |  | 
| --- |--- |
|  **Propriétés**  | Description | 
| LogParameters | Objet avec des chemins de répertoire vers des fichiers générés au cours d'une session de jeu. Amazon GameLift Serverscopie et stocke les fichiers pour un accès futur.**Type :** `Aws::GameLift::Server::LogParameters`**Obligatoire** : non | 
| OnHealthCheck | La fonction de rappel qui Amazon GameLift Servers appelle le processus du serveur pour demander un rapport d'état de santé. Amazon GameLift Serversappelle cette fonction toutes les 60 secondes et attend une réponse pendant 60 secondes. Le processus du serveur revient TRUE s'il est sain, FALSE sinon sain. Si aucune réponse n'est renvoyée, Amazon GameLift Servers enregistre le processus du serveur comme non sain.**Type :** `std::function<bool()> onHealthCheck`**Obligatoire** : non | 
| OnProcessTerminate | La fonction de rappel qui Amazon GameLift Servers invoque pour forcer l'arrêt du processus du serveur. Après avoir appelé cette fonction, Amazon GameLift Servers attendez 5 minutes que le processus serveur s'arrête et répondez par un [ProcessEnding()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-processending) appel avant de l'arrêter.**Type :** `std::function<void()> onProcessTerminate`**Obligatoire** : oui | 
| OnStartGameSession | La fonction de rappel qui Amazon GameLift Servers invoque une nouvelle session de jeu pour activer une nouvelle session de jeu. Amazon GameLift Serversappelle cette fonction en réponse à une demande du client [CreateGameSession](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_CreateGameSession.html). La fonction de rappel transmet un [GameSession](#integration-server-sdk5-cpp-dataypes-gamesession) objet.**Type :** `const std::function<void(Aws::GameLift::Model::GameSession)> onStartGameSession`**Obligatoire** : oui | 
| OnUpdateGameSession | La fonction de rappel qui Amazon GameLift Servers appelle pour transmettre un objet de session de jeu mis à jour au processus du serveur. Amazon GameLift Serversappelle cette fonction lorsqu'une demande de remplissage de correspondance a été traitée pour fournir des données de matchmaking mises à jour. Il transmet un [GameSession](#integration-server-sdk5-cpp-dataypes-gamesession) objet, une mise à jour de statut (updateReason) et l'identifiant du ticket de remplacement des matchs.**Type :** `std::function<void(Aws::GameLift::Server::Model::UpdateGameSession)> onUpdateGameSession`**Obligatoire** : non | 
|  Port | Numéro de port sur lequel le processus serveur écoute les connexions des nouveaux joueurs. La valeur doit être comprise dans la plage de ports configurée pour toutes les flottes déployant cette version de génération du serveur de jeux. Ce numéro de port est inclus dans les objets de session de jeu et de session de joueur, que les sessions de jeu utilisent pour se connecter à un processus serveur.**Type :** `Integer`**Obligatoire** : oui | 

## UpdateGameSession
<a name="integration-server-sdk5-cpp-dataypes-updategamesession"></a>

Ce type de données est mis à jour vers un objet de session de jeu, qui inclut la raison pour laquelle la session de jeu a été mise à jour et l'identifiant du ticket de remplissage associé si le remplissage est utilisé pour remplir les sessions des joueurs pendant la session de jeu.


| Propriétés | **Description** | 
| --- | --- | 
| GameSession | Un objet [GameSession](#integration-server-sdk5-cpp-dataypes-gamesession). L'GameSessionobjet contient des propriétés décrivant une session de jeu. **Type :** `Aws::GameLift::Server::GameSession`**Obligatoire** : oui | 
| UpdateReason | La raison pour laquelle la session de jeu est mise à jour.**Type :** `Aws::GameLift::Server::UpdateReason`**Obligatoire** : oui | 
| BackfillTicketId | L'identifiant du ticket de remplacement qui tente de mettre à jour la session de jeu.**Type :** `std::string`**Obligatoire** : non | 

## GameSession
<a name="integration-server-sdk5-cpp-dataypes-gamesession"></a>

Ce type de données fournit les détails d'une session de jeu. 


| Propriétés | **Description** | 
| --- | --- | 
| GameSessionId |  Identifiant unique pour la session de jeu. L'ARN d'une session de jeu a le format suivant :`arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>`. **Type :** `std::string` **Obligatoire** : non  | 
| Nom |  Libellé descriptif de la session de jeu.  **Type :** `std::string` **Obligatoire** : non  | 
| FleetId |  Identifiant unique de la flotte sur laquelle s'exécute la session de jeu. **Type :** `std::string` **Obligatoire** : non  | 
| MaximumPlayerSessionCount |  Le nombre maximum de connexions de joueurs à la session de jeu. **Type :** `int` **Obligatoire** : non  | 
|  Port |  Le numéro de port de la session de jeu. Pour se connecter à un serveur de Amazon GameLift Servers jeu, une application a besoin à la fois de l'adresse IP et du numéro de port. **Type :** `in` **Obligatoire** : non  | 
| IpAddress |  Adresse IP de la session de jeu. Pour se connecter à un serveur de Amazon GameLift Servers jeu, une application a besoin à la fois de l'adresse IP et du numéro de port. **Type :** `std::string` **Obligatoire** : non  | 
| GameSessionData |  Ensemble de propriétés de session de jeu personnalisées, mises en forme en tant que valeur de chaîne unique.  **Type :** `std::string` **Obligatoire** : non  | 
| MatchmakerData |  Informations sur le processus de matchmaking utilisé pour créer la session de jeu, en syntaxe JSON, formatée sous forme de chaîne. En plus de la configuration de matchmaking utilisée, il contient des données sur tous les joueurs affectés au match, y compris les attributs des joueurs et les affectations des équipes. **Type :** `std::string` **Obligatoire** : non  | 
| GameProperties |  Ensemble de propriétés personnalisées pour une session de jeu, formatées sous forme de paires clé:valeur. Ces propriétés sont transmises avec une demande de démarrage d'une nouvelle session de jeu. **Type :** `std :: vector < GameProperty >` **Obligatoire** : non  | 
| DnsName |  Identifiant DNS attribué à l'instance qui exécute la session de jeu. Les valeurs ont le format suivant : [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/gameliftservers/latest/developerguide/integration-server-sdk5-cpp-datatypes.html) Lorsque vous vous connectez à une session de jeu exécutée sur une flotte compatible TLS, vous devez utiliser le nom DNS et non l'adresse IP. **Type :** `std::string` **Obligatoire** : non  | 

## ServerParameters
<a name="integration-server-sdk5-cpp-dataypes-serverparameters"></a>

Informations utilisées par un serveur de jeu pour établir une connexion avec le Amazon GameLift Servers service. N'incluez ces paramètres lors de l'appel [InitSDK()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-initsdk-anywhere) que si la version du serveur de jeu doit être déployée sur une flotte Anywhere ou une flotte de conteneurs sans l'Amazon GameLift Serversagent. Pour tous les autres scénarios de déploiement, appelez [InitSDK()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-initsdk) sans paramètres.


| Propriétés | **Description** | 
| --- | --- | 
| webSocketUrl |  Les `GameLiftServerSdkEndpoint` Amazon GameLift Servers retours lorsque vous [https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html)recherchez une ressource de calcul Amazon GameLift Servers Anywhere. **Type :** `std::string` **Obligatoire** : oui   | 
| ID du processus |  Un identifiant unique enregistré auprès du processus serveur hébergeant votre jeu. **Type :** `std::string` **Obligatoire** : oui  | 
| hostId | Le HostID est celui ComputeName utilisé lorsque vous avez enregistré votre ordinateur. Pour plus d'informations, voir, [RegisterCompute](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html).**Type :** `std::string`**Obligatoire** : oui | 
| ID de flotte | Identifiant unique de la flotte dans laquelle le calcul est enregistré. Pour plus d'informations, voir, [RegisterCompute](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html).**Type :** `std::string`**Obligatoire** : oui | 
| Jeton d'authentification | Le jeton d'authentification généré par Amazon GameLift Servers celui-ci authentifie votre serveur auprès deAmazon GameLift Servers. Pour plus d'informations, voir, [GetComputeAuthToken](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_GetComputeAuthToken.html).**Type :** `std::string`**Obligatoire** : oui | 

## StartMatchBackfillRequest
<a name="integration-server-sdk5-cpp-dataypes-startmatchbackfillrequest"></a>

Informations utilisées pour créer une demande de remplissage par matchmaking. Le serveur de jeu communique ces informations Amazon GameLift Servers lors d'un [StartMatchBackfill()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-startmatchbackfill) appel.


| Propriétés | **Description** | 
| --- | --- | 
| GameSessionArn |  Un identifiant de session de jeu unique. L'opération API `[GetGameSessionId](https://docs.aws.amazon.com/gameliftservers/latest/developerguide/integration-server-sdk5-cpp-actions.html#integration-server-sdk5-cpp-getgamesessionid)` renvoie l'identifiant au format ARN. **Type :** `std::string` **Obligatoire** : oui  | 
| MatchmakingConfigurationArn |  Un identifiant unique, sous la forme d'un ARN, que le système de jumelage doit utiliser pour cette demande. L'ARN de matchmaking pour la session de jeu d'origine se trouve dans l'objet de session de jeu dans la propriété de données du matchmaker. Pour en savoir plus sur les données du système de jumelage, consultez la section [Travailler avec les données du système de jumelage.](https://docs.aws.amazon.com/gameliftservers/latest/flexmatchguide/match-server.html#match-server-data.html) **Type :** `std::string` **Obligatoire** : oui  | 
| Joueurs |  Un ensemble de données représentant tous les joueurs participant à la session de jeu. Le matchmaker utilise ces informations pour rechercher de nouveaux joueurs qui constituent de bonnes correspondances pour les joueurs actuels. **Type :** `std::vector<Player>` **Obligatoire** : oui  | 
| TicketId |  Un identifiant unique pour un ticket de demande de matchmaking ou de remplacement de match. Si vous ne fournissez aucune valeur, il en Amazon GameLift Servers génère une. Utilisez cet identifiant pour suivre l'état du ticket de renvoi de correspondance ou annuler la requête si nécessaire.  **Type :** `std::string` **Obligatoire** : non  | 

## Joueur
<a name="integration-server-sdk5-cpp-dataypes-player"></a>

Ce type de données représente un joueur dans le matchmaking. Lors du lancement d'une demande de matchmaking, un joueur dispose d'un identifiant de joueur, d'attributs et éventuellement de données de latence. Amazon GameLift Serversajoute des informations sur l'équipe après la fin d'un match.


| Propriétés | **Description** | 
| --- | --- | 
| LatencyInMS |  Ensemble de valeurs exprimées en millisecondes qui indiquent le niveau de latence ressenti par un joueur lorsqu'il est connecté à un lieu.  Si cette propriété est utilisée, le joueur n'est jumelé qu'aux emplacements répertoriés. Si un matchmaker dispose d'une règle qui évalue la latence, les joueurs doivent indiquer la latence pour être mis en relation. **Type :** `Dictionary<string,int>` **Obligatoire** : non  | 
| PlayerAttributes |  Une collection de paires clé:valeur contenant des informations sur les joueurs à utiliser dans le matchmaking. Les clés d'attribut du joueur doivent correspondre à PlayerAttributes celles utilisées dans un ensemble de règles de matchmaking. Pour plus d'informations sur les attributs des joueurs, consultez [AttributeValue](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_AttributeValue.html). **Type :** `std::map<std::string,AttributeValue>` **Obligatoire** : non  | 
| PlayerId |  Identifiant unique pour un joueur. **Type :** `std::string` **Obligatoire** : non  | 
| Team |  Le nom de l'équipe à laquelle le joueur est affecté lors d'un match. Vous définissez le nom de l'équipe dans le jeu de règles de matchmaking. **Type :** `std::string` **Obligatoire** : non  | 

## DescribePlayerSessionsRequest
<a name="integration-server-sdk5-cpp-dataypes-playersessions"></a>

Objet qui indique les sessions de joueur à récupérer. Le processus du serveur fournit ces informations en [DescribePlayerSessions()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-describeplayersessions) appelantAmazon GameLift Servers.


| Propriétés | **Description** | 
| --- | --- | 
| GameSessionId |  Un identifiant de session de jeu unique. Utilisez ce paramètre pour demander toutes les sessions de joueur pour la session de jeu spécifiée.  Le format de l'identifiant de session de jeu est`arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>`. `GameSessionID`Il s'agit d'une chaîne d'identification personnalisée ou d'un **Type :** `std::string` **Obligatoire** : non  | 
| PlayerSessionId |  Identifiant unique d'une session de joueur. Utilisez ce paramètre pour demander une session de joueur spécifique. **Type :** `std::string` **Obligatoire** : non  | 
| PlayerId |  L'identifiant unique d'un joueur. Utilisez ce paramètre pour demander toutes les sessions de joueur pour un joueur spécifique. Consultez [Générer un joueur IDs](player-sessions-player-identifiers.md). **Type :** `std::string` **Obligatoire** : non  | 
| PlayerSessionStatusFilter |  État de la session du joueur sur lequel filtrer les résultats. Les statuts possibles des sessions de joueur sont les suivants : [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/gameliftservers/latest/developerguide/integration-server-sdk5-cpp-datatypes.html) **Type :** `std::string` **Obligatoire** : non  | 
| NextToken |  Le jeton indiquant le début de la page de résultats suivante. Pour spécifier le début du jeu de résultats, ne fournissez aucune valeur. Si vous fournissez un identifiant de session de joueur, ce paramètre est ignoré. **Type :** `std::string` **Obligatoire** : non  | 
| Limite |  Nombre maximal de résultats à renvoyer. Si vous fournissez un identifiant de session de joueur, ce paramètre est ignoré. **Type :** `int` **Obligatoire** : non  | 

## StopMatchBackfillRequest
<a name="integration-server-sdk5-cpp-dataypes-stopmatchbackfillrequest"></a>

Informations utilisées pour annuler une demande de remplissage par matchmaking. Le serveur de jeu communique ces informations au Amazon GameLift Servers service lors d'un [StopMatchBackfill()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-stopmatchbackfill) appel.


| Propriétés | **Description** | 
| --- | --- | 
| GameSessionArn |  Identifiant de session de jeu unique de la demande annulée. **Type :** `char[]` **Obligatoire** : non  | 
| MatchmakingConfigurationArn |  Un identifiant unique du matchmaker auquel cette demande a été envoyée. **Type :** `char[]` **Obligatoire** : non  | 
| TicketId |  Identifiant unique du ticket de demande de remblayage à annuler. **Type :** `char[]` **Obligatoire** : non  | 

## AttributeValue
<a name="integration-server-sdk5-cpp-dataypes-attributevalue"></a>

Utilisez ces valeurs dans les paires [Joueur](#integration-server-sdk5-cpp-dataypes-player) clé-valeur d'attribut. Cet objet vous permet de spécifier une valeur d'attribut à l'aide de n'importe quel type de données valide : chaîne, nombre, tableau de chaînes ou mappage de données. Chaque `AttributeValue` objet doit utiliser exactement l'une des propriétés disponibles : `S``N`,`SL`, ou`SDM`.


| Propriétés | Description | 
| --- | --- | 
| AttrType |  Spécifie le type de valeur d'attribut. Les types de valeurs d'attributs possibles sont les suivants :  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/gameliftservers/latest/developerguide/integration-server-sdk5-cpp-datatypes.html) **Obligatoire** : non  | 
|  S |  Représente une valeur d'attribut de chaîne. **Type :** `std::string` **Obligatoire** : non  | 
| N |  Représente une valeur d'attribut numérique. **Type :** `double` **Obligatoire** : non  | 
| SL |  Représente un tableau de valeurs d'attributs de chaîne. **Type :** `std::vector<std::string>` **Obligatoire** : non  | 
| SDM |  Représente un dictionnaire de chaînes de caractères, de clés et de valeurs doubles. **Type :** `std::map<std::string, double>` **Obligatoire** : non  | 

## GetFleetRoleCredentialsRequest
<a name="integration-server-sdk5-cpp-dataypes-getfleetrolecredentialsrequest"></a>

Ce type de données donne au serveur de jeu un accès limité à vos autres AWS ressources. Pour plus d'informations, voir,[Configurer un rôle de service IAM pour Amazon GameLift Servers](setting-up-role.md).


| Propriétés | **Description** | 
| --- | --- | 
| RoleArn | Le nom de ressource Amazon (ARN) du rôle de service qui étend un accès limité à vos AWS ressources.**Type :** `std::string`**Obligatoire** : non | 
| RoleSessionName | Nom de session de rôle que vous pouvez utiliser pour identifier une AWS Security Token Service [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)session de manière unique. Ce nom est exposé dans les journaux d'audit tels que ceux contenus dans CloudTrail. **Type :** `std::string`  **Obligatoire** : non  | 

## AwsLongOutcome
<a name="integration-server-sdk5-cpp-datatypes-awslongoutcome"></a>

Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :


| Propriétés | Description | 
| --- | --- | 
| Résultat |  Le résultat de l'action. **Type :** `long` **Obligatoire** : non  | 
| ResultWithOwnership |   Le résultat de l'action, converti en valeur rvalue, afin que le code appelant puisse s'approprier l'objet.  **Type :** `long&&` **Obligatoire** : non  | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  L'erreur qui s'est produite en cas d'échec de l'action. **Type :** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obligatoire** : non  | 

## AwsStringOutcome
<a name="integration-server-sdk5-cpp-datatypes-awsstringoutcome"></a>

Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :


| Propriétés | Description | 
| --- | --- | 
| Résultat |  Le résultat de l'action. **Type :** `std::string` **Obligatoire** : non  | 
| ResultWithOwnership |   Le résultat de l'action, converti en valeur rvalue, afin que le code appelant puisse s'approprier l'objet.  **Type :** `long&&` **Obligatoire** : non  | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  L'erreur qui s'est produite en cas d'échec de l'action. **Type :** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obligatoire** : non  | 

## DescribePlayerSessionsOutcome
<a name="integration-server-sdk5-cpp-datatypes-describeplayersessionsoutcome"></a>

Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :


| Propriétés | Description | 
| --- | --- | 
| Résultat |  Le résultat de l'action. **Type :** [DescribePlayerSessionsResult](#integration-server-sdk5-cpp-datatypes-describeplayersessionsresult) **Obligatoire** : non   | 
| ResultWithOwnership |   Le résultat de l'action, converti en valeur rvalue, afin que le code appelant puisse s'approprier l'objet.  **Type :** `Aws::GameLift::Server::Model::DescribePlayerSessionsResult&&` **Obligatoire** : non  | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  L'erreur qui s'est produite en cas d'échec de l'action. **Type :** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obligatoire** : non  | 

## DescribePlayerSessionsResult
<a name="integration-server-sdk5-cpp-datatypes-describeplayersessionsresult"></a>

Collection d'objets contenant les propriétés de chaque session de joueur correspondant à la demande. 


| Propriétés | Description | 
| --- | --- | 
| NextToken |  Un jeton qui indique le début de la prochaine page séquentielle de résultats. Utilisez le jeton renvoyé lors d'un appel précédent à cette opération. Pour commencer au début du jeu de résultats, ne spécifiez aucune valeur. Si un ID de session de joueur est spécifié, ce paramètre est ignoré.  **Type :** `std::string` **Obligatoire** : oui  | 
| PlayerSessions |  **Type :** `IList<PlayerSession>` **Obligatoire** :   | 
| ResultWithOwnership |   Le résultat de l'action, converti en valeur rvalue, afin que le code appelant puisse s'approprier l'objet.  **Type :** `std::string&&` **Obligatoire** : non  | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  L'erreur qui s'est produite en cas d'échec de l'action. **Type :** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obligatoire** : non  | 

## GenericOutcome
<a name="integration-server-sdk5-cpp-datatypes-genericoutcome"></a>

Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :


| Propriétés | Description | 
| --- | --- | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  L'erreur qui s'est produite en cas d'échec de l'action. **Type :** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obligatoire** : non  | 

## GenericOutcomeCallable
<a name="integration-server-sdk5-cpp-datatypes-genericoutcomecallable"></a>

Ce type de données est un résultat générique asynchrone. Il comprend les propriétés suivantes : 


| Propriétés | Description | 
| --- | --- | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  L'erreur qui s'est produite en cas d'échec de l'action. **Type :** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obligatoire** : non  | 

## PlayerSession
<a name="integration-server-sdk5-cpp-datatypes-playersession"></a>

Ce type de données représente une session de joueur Amazon GameLift Servers transmise au serveur de jeu. Pour de plus amples informations, veuillez consulter [PlayerSession](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_PlayerSession.html). 


| Propriétés | Description | 
| --- | --- | 
| CreationTime |  **Type :** `long` **Obligatoire** : non  | 
| FleetId |  **Type :** `std::string` **Obligatoire** : non  | 
| GameSessionId |  **Type :** `std::string` **Obligatoire** : non  | 
| IpAddress |  **Type :** `std::string` **Obligatoire** : non  | 
| PlayerData |  **Type :** `std::string` **Obligatoire** : non  | 
| PlayerId |  **Type :** `std::string` **Obligatoire** : non  | 
| PlayerSessionId |  **Type :** `std::string` **Obligatoire** : non  | 
|  Port |  **Type :** `int` **Obligatoire** : non  | 
| Statut |  État de session de joueur pour filtrer les résultats. Lorsqu'un PlayerSessionId ou PlayerId est fourni, cela n' PlayerSessionStatusFilter a aucun effet sur la réponse.  **Type :** Une `PlayerSessionStatus` énumération. Les valeurs possibles sont notamment les suivantes :  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/gameliftservers/latest/developerguide/integration-server-sdk5-cpp-datatypes.html) **Obligatoire** : non  | 
| TerminationTime |  **Type :** `long` **Obligatoire** : non  | 
| DnsName |  **Type :** `std::string` **Obligatoire** : non  | 

## StartMatchBackfillOutcome
<a name="integration-server-sdk5-cpp-datatypes-startmatchbackfilloutcome"></a>

Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :


| Propriétés | Description | 
| --- | --- | 
| Résultat |  Le résultat de l'action. **Type :** [StartMatchBackfillResult](#integration-server-sdk5-cpp-datatypes-startmatchbackfillresult) **Obligatoire** : non  | 
| ResultWithOwnership |   Le résultat de l'action, converti en valeur rvalue, afin que le code appelant puisse s'approprier l'objet.  **Type :** `StartMatchBackfillResult&&` **Obligatoire** : non  | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  L'erreur qui s'est produite en cas d'échec de l'action. **Type :** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obligatoire** : non  | 

## StartMatchBackfillResult
<a name="integration-server-sdk5-cpp-datatypes-startmatchbackfillresult"></a>

Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :


| Propriétés | Description | 
| --- | --- | 
| TicketId |  Un identifiant unique pour un ticket de matchmaking. Si aucun identifiant de ticket n'est spécifié ici, il en Amazon GameLift Servers générera un sous la forme d'un UUID. Utilisez cet identifiant pour suivre l'état du ticket de remplacement des matchs et récupérer les résultats des matchs.  **Type :** `std::string` **Obligatoire** : non  | 

## GetComputeCertificateOutcome
<a name="integration-server-sdk5-cpp-datatypes-getcomputecertificateoutcome"></a>

Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :


| Propriétés | Description | 
| --- | --- | 
| Résultat |  Le résultat de l'action. **Type :** [GetComputeCertificateResult](#integration-server-sdk5-cpp-datatypes-getcomputecertificateresult) **Obligatoire** : non   | 
| ResultWithOwnership |   Le résultat de l'action, converti en valeur rvalue, afin que le code appelant puisse s'approprier l'objet.  **Type :** `Aws::GameLift::Server::Model::GetComputeCertificateResult&&` **Obligatoire** : non  | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  L'erreur qui s'est produite en cas d'échec de l'action. **Type :** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obligatoire** : non  | 

## GetComputeCertificateResult
<a name="integration-server-sdk5-cpp-datatypes-getcomputecertificateresult"></a>

Le chemin d'accès au certificat TLS sur votre ordinateur et le nom d'hôte du calcul.


| Propriétés | Description | 
| --- | --- | 
| CertificatePath |  Le chemin d'accès au certificat TLS sur votre ressource de calcul. Lorsque vous utilisez une flotte Amazon GameLift Servers gérée, ce chemin contient :  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/gameliftservers/latest/developerguide/integration-server-sdk5-cpp-datatypes.html) **Type :** `std::string` **Obligatoire** : non  | 
| ComputeName |  Le nom de votre ressource de calcul. **Type :** `std::string` **Obligatoire** : non  | 

## GetFleetRoleCredentialsOutcome
<a name="integration-server-sdk5-cpp-datatypes-getfleetrolecredentialsoutcome"></a>

Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :


| Propriétés | Description | 
| --- | --- | 
| Résultat |  Le résultat de l'action. **Type :** [GetFleetRoleCredentialsResult](#integration-server-sdk5-cpp-datatypes-getfleetrolecredentialsresult) **Obligatoire** : non   | 
| ResultWithOwnership |   Le résultat de l'action, converti en valeur rvalue, afin que le code appelant puisse s'approprier l'objet.  **Type :** `Aws::GameLift::Server::Model::GetFleetRoleCredentialsResult` **Obligatoire** : non  | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  L'erreur qui s'est produite en cas d'échec de l'action. **Type :** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obligatoire** : non  | 

## GetFleetRoleCredentialsResult
<a name="integration-server-sdk5-cpp-datatypes-getfleetrolecredentialsresult"></a>


| Propriétés | Description | 
| --- | --- | 
| AccessKeyId |  ID de clé d'accès permettant d'authentifier et de fournir un accès à vos AWS ressources. **Type :** `string` **Obligatoire** : non  | 
| AssumedRoleId |  ID de l'utilisateur auquel appartient le rôle de service. **Type :** `string` **Obligatoire** : non  | 
| AssumedRoleUserArn |  Le nom de ressource Amazon (ARN) de l'utilisateur auquel appartient le rôle de service. **Type :** `string` **Obligatoire** : non  | 
| Expiration |  Durée avant l'expiration de vos informations d'identification de session. **Type :** `DateTime` **Obligatoire** : non  | 
| SecretAccessKey |  ID de clé d'accès secrète pour l'authentification. **Type :** `string` **Obligatoire** : non  | 
| SessionToken |  Un jeton permettant d'identifier la session active en cours qui interagit avec vos AWS ressources. **Type :** `string` **Obligatoire** : non  | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  L'erreur qui s'est produite en cas d'échec de l'action. **Type :** [GameLiftError](integration-server-sdk5-csharp-datatypes.md#integration-server-sdk5-csharp-datatypes-gamelifterror) **Obligatoire** : non  | 

## Initialiser SDKOutcome
<a name="integration-server-sdk5-cpp-datatypes-initsdkoutcome"></a>

**Note**  
`InitSDKOutcome`n'est renvoyé que lorsque vous créez le SDK avec l'`std`indicateur. Si vous construisez avec le `nostd` drapeau, il [GenericOutcome](#integration-server-sdk5-cpp-datatypes-genericoutcome) est renvoyé à la place.


| Propriétés | Description | 
| --- | --- | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  L'erreur qui s'est produite en cas d'échec de l'action. **Type :** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obligatoire** : non  | 

## GameLiftError
<a name="integration-server-sdk5-cpp-datatypes-gamelifterror"></a>


| Propriétés | Description | 
| --- | --- | 
| ErrorType |  Type d'erreur. **Type :** Une `GameLiftErrorType` [énumération.](#integration-server-sdk5-cpp-dataypes-enums) **Obligatoire** : non   | 
| ErrorName |  Nom de l'erreur.  **Type :** `std::string`  **Obligatoire** : non   | 
| ErrorMessage |  Message d’erreur.  **Type :** `std::string`  **Obligatoire** : non   | 

## Enums
<a name="integration-server-sdk5-cpp-dataypes-enums"></a>

Les énumérations définies pour le SDK du serveur pour Amazon GameLift Servers (C\$1\$1) sont définies comme suit : 

**GameLiftErrorType**  
Valeur de chaîne indiquant le type d'erreur. Les valeurs valides sont les suivantes :  
+ **MAUVAISE DEMANDE D'EXCEPTION** 
+ **GAMESESSION\$1ID\$1NOT\$1SET — L'ID de session de jeu n'a pas été défini**. 
+ **EXCEPTION DE SERVICE INTERNE** 
+ **LOCAL\$1CONNECTION\$1FAILED — La connexion locale a échoué**. Amazon GameLift Servers 
+ **NETWORK\$1NOT\$1INITIALIZED — Le réseau n'a pas été initialisé**. 
+ **SERVICE\$1CALL\$1FAILED** — Un appel à un AWS service a échoué. 
+ **DÉFAILLANCE DE CONNEXION AU SOCKET WEB** 
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1FORBIDDEN** 
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1INVALID\$1URL** 
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1TIMEOUT** 
+ **ALREADY\$1INITIALIZED** — Le Amazon GameLift Servers serveur ou le client a déjà été initialisé avec Initialize (). 
+ **FLEET\$1MISMATCH** — La flotte cible ne correspond pas à la flotte d'une GameSession ou d'une PlayerSession. 
+ **GAMELIFT\$1CLIENT\$1NOT\$1INITIALIZED — Le client n'a pas été initialisé**. Amazon GameLift Servers 
+ **GAMELIFT\$1SERVER\$1NOT\$1INITIALIZED — Le serveur n'a pas été initialisé**. Amazon GameLift Servers 
+ **GAME\$1SESSION\$1ENDED\$1FAILED : le SDK du serveur n'a pas** Amazon GameLift Servers pu contacter le service pour signaler la fin de la session de jeu. 
+ **GAME\$1SESSION\$1NOT\$1READY** — La Amazon GameLift Servers session de jeu sur le serveur n'a pas été activée. 
+ **GAME\$1SESSION\$1READY\$1FAILED : le SDK du serveur n'a pas Amazon GameLift Servers pu contacter le service pour signaler que la session de jeu est prête**. 
+ **INITIALIZATION\$1MISMATCH** — Une méthode client a été appelée après Server : :Initialize (), ou vice versa. 
+ **NOT\$1INITIALIZED** — Le Amazon GameLift Servers serveur ou le client n'a pas été initialisé avec Initialize (). 
+ **NO\$1TARGET\$1ALIASID\$1SET — Aucun AliasID cible n'a été défini**. 
+ **NO\$1TARGET\$1FLEET\$1SET — Aucune flotte cible n'a été définie**. 
+ **PROCESS\$1ENDING\$1FAILED** : le SDK du serveur n'a pas Amazon GameLift Servers pu contacter le service pour signaler la fin du processus. 
+ **PROCESS\$1NOT\$1ACTIVE** — Le processus du serveur n'est pas encore actif, n'est pas lié à un et ne peut ni GameSession accepter ni traiter. PlayerSessions 
+ **PROCESS\$1NOT\$1READY** — Le processus du serveur n'est pas encore prêt à être activé. 
+ **PROCESS\$1READY\$1FAILED : le SDK du serveur n'a pas Amazon GameLift Servers pu contacter le service pour signaler que le processus est prêt**. 
+ **SDK\$1VERSION\$1DETECTION\$1FAILED — La détection de la version** du SDK a échoué. 
+ **STX\$1CALL\$1FAILED — Un appel au composant principal du XStx serveur a échoué**. 
+ **STX\$1INITIALIZATION\$1FAILED — Le composant principal du XStx serveur n'a pas pu** être initialisé. 
+ **UNEXPECTED\$1PLAYER\$1SESSION** — Le serveur a détecté une session de joueur non enregistrée. 
+ **DÉFAILLANCE DE CONNEXION AU SOCKET WEB** 
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1FORBIDDEN** 
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1INVALID\$1URL** 
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1TIMEOUT** 
+ **WEBSOCKET\$1RETRIABLE\$1SEND\$1MESSAGE\$1FAILURE — Impossible de récupérer un message** au service. GameLift WebSocket 
+ **WEBSOCKET\$1SEND\$1MESSAGE\$1FAILURE — Impossible d'envoyer un message au service**. GameLift WebSocket 
+ **MATCH\$1BACKFILL\$1REQUEST\$1VALIDATION — La validation de la demande a échoué**. 
+ **PLAYER\$1SESSION\$1REQUEST\$1VALIDATION — La validation de la demande** a échoué. 

**PlayerSessionCreationPolicy**  
Valeur de chaîne indiquant si la session de jeu accepte ou non de nouveaux joueurs. Les valeurs valides sont les suivantes :   
+ **ACCEPT\$1ALL — Accepte toutes les** sessions de nouveaux joueurs. 
+ **DENY\$1ALL — Refuse toutes les** sessions de nouveaux joueurs. 
+ **NOT\$1SET** — La session de jeu n'est pas configurée pour accepter ou refuser les sessions de nouveaux joueurs. 

[SDK 5.x du serveur C\$1\$1 pour Amazon GameLift Servers -- Types de données](integration-server-sdk5-cpp-datatypes.md)

**Topics**
+ [SDK 5.x du serveur C\$1\$1 pour Amazon GameLift Servers -- Types de données](integration-server-sdk5-cpp-datatypes.md)
+ [GetSdkVersion()](#integration-server-sdk5-cpp-getsdkversion)
+ [InitMetrics()](#integration-server-sdk5-cpp-initmetrics)
+ [InitSDK()](#integration-server-sdk5-cpp-initsdk)
+ [InitSDK()](#integration-server-sdk5-cpp-initsdk-anywhere)
+ [ProcessReady()](#integration-server-sdk5-cpp-processready)
+ [ProcessReadyAsync()](#integration-server-sdk5-cpp-processreadyasync)
+ [ProcessEnding()](#integration-server-sdk5-cpp-processending)
+ [ActivateGameSession()](#integration-server-sdk5-cpp-activategamesession)
+ [UpdatePlayerSessionCreationPolicy()](#integration-server-sdk5-cpp-updateplayersessioncreationpolicy)
+ [GetGameSessionId()](#integration-server-sdk5-cpp-getgamesessionid)
+ [GetTerminationTime()](#integration-server-sdk5-cpp-getterm)
+ [AcceptPlayerSession()](#integration-server-sdk5-cpp-acceptplayersession)
+ [RemovePlayerSession()](#integration-server-sdk5-cpp-removeplayersession)
+ [DescribePlayerSessions()](#integration-server-sdk5-cpp-describeplayersessions)
+ [StartMatchBackfill()](#integration-server-sdk5-cpp-startmatchbackfill)
+ [StopMatchBackfill()](#integration-server-sdk5-cpp-stopmatchbackfill)
+ [GetComputeCertificate()](#integration-server-sdk5-cpp-getcomputecertificate)
+ [GetFleetRoleCredentials()](#integration-server-sdk5-cpp-getfleetrolecredentials)
+ [Détruire ()](#integration-server-sdk5-cpp-ref-destroy)

## GetSdkVersion()
<a name="integration-server-sdk5-cpp-getsdkversion"></a>

Renvoie le numéro de version actuel du kit SDK intégré dans le processus serveur.

### Syntaxe
<a name="integration-server-sdk5-cpp-getsdkversion-syntax"></a>

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

### Valeur renvoyée
<a name="integration-server-sdk5-cpp-getsdkversion-return"></a>

En cas de réussite, renvoie la version actuelle du kit SDK en tant qu'objet [AwsStringOutcome](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-awsstringoutcome). L'objet renvoyé inclut le numéro de version (exemple`5.0.0`). En cas d'échec, renvoie un message d'erreur.

### Exemple
<a name="integration-server-sdk5-cpp-getsdkversion-example"></a>

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

## InitMetrics()
<a name="integration-server-sdk5-cpp-initmetrics"></a>

Initialise le système de métriques pour la collecte et le reporting des données de performance du serveur. Pour de meilleurs résultats, appelez cette méthode avant [InitSDK()](#integration-server-sdk5-cpp-initsdk) pour activer la collecte de métriques lors de l'initialisation du SDK.

### Syntaxe
<a name="integration-server-sdk5-cpp-initmetrics-syntax"></a>

```
Aws::GameLift::GenericOutcome InitMetrics();
Aws::GameLift::GenericOutcome InitMetrics(const Aws::GameLift::Server::MetricsParameters &metricsParameters);
```

### Parameters
<a name="integration-server-sdk5-cpp-initmetrics-parameter"></a>

[MetricsParameters](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-metricsparameters) (facultatif)  
Paramètres de configuration pour la collecte de métriques. Si ce n'est pas le cas, utilise des valeurs par défaut qui peuvent être remplacées par des variables d'environnement.

### Valeur renvoyée
<a name="integration-server-sdk5-cpp-initmetrics-return"></a>

En cas de succès, renvoie un [GenericOutcome](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-genericoutcome) objet indiquant le succès. En cas d'échec, renvoie un message d'erreur.

### Exemple
<a name="integration-server-sdk5-cpp-initmetrics-example"></a>

```
// Initialize with default parameters (uses environment variables if available)
// Defaults: localhost:8125 for StatsD, localhost:8126 for crash reporter
// FlushInterval: 10000ms, MaxPacketSize: 512 bytes
Aws::GameLift::GenericOutcome outcome = Aws::GameLift::Server::InitMetrics();
if (outcome.IsSuccess()) {
    // Metrics system initialized successfully
}

// Initialize with custom parameters
Aws::GameLift::Server::MetricsParameters metricsParams("localhost", 8125, "crash-host", 8126, 5000, 1024);
Aws::GameLift::GenericOutcome customOutcome = Aws::GameLift::Server::InitMetrics(metricsParams);
if (customOutcome.IsSuccess()) {
    // Metrics system initialized with custom parameters
}
```

## InitSDK()
<a name="integration-server-sdk5-cpp-initsdk"></a>

Initialise le kit SDK Amazon GameLift Servers. Appelez cette méthode au lancement avant toute autre étape d'initialisation liée àAmazon GameLift Servers. Cette action lit les paramètres du serveur depuis l'environnement hôte pour établir la communication entre le processus du serveur de jeu et le Amazon GameLift Servers service. Il utilise un jeton d'idempotencie, de sorte que vous pouvez réessayer cet appel en toute sécurité en cas d'échec.

Si la version du serveur de jeu doit être déployée sans l'Amazon GameLift Serversagent sur une flotte ou une flotte de conteneurs Amazon GameLift Servers Anywhere, appelez [InitSDK()](#integration-server-sdk5-cpp-initsdk-anywhere) et spécifiez un ensemble de paramètres de serveur.

### Syntaxe
<a name="integration-server-sdk5-cpp-initsdk-syntax"></a>

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

### Valeur renvoyée
<a name="integration-server-sdk5-cpp-initsdk-return"></a>

Renvoie un [Initialiser SDKOutcome](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-initsdkoutcome) objet qui indique si le processus serveur est prêt à être appelé[ProcessReady()](#integration-server-sdk5-cpp-processready). 

### Exemple
<a name="integration-server-sdk5-cpp-initsdk-example"></a>

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

## InitSDK()
<a name="integration-server-sdk5-cpp-initsdk-anywhere"></a>

Initialise le kit SDK Amazon GameLift Servers. Appelez cette méthode au lancement avant toute autre étape d'initialisation liée àAmazon GameLift Servers. Cette action nécessite un ensemble de paramètres de serveur pour établir la communication entre le processus du serveur de jeu et le Amazon GameLift Servers service. Il utilise un jeton d'idempotencie, de sorte que vous pouvez réessayer cet appel en toute sécurité en cas d'échec.

Si la version du serveur de jeu doit être déployée sur une flotte EC2 Amazon GameLift Servers gérée ou sur une flotte Amazon GameLift Servers Anywhere ou une flotte de conteneurs avec l'Amazon GameLift Serversagent, appelez [InitSDK()](#integration-server-sdk5-cpp-initsdk) sans paramètres de serveur.

### Syntaxe
<a name="integration-server-sdk5-cpp-initsdk-anywhere-syntax"></a>

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

### Parameters
<a name="integration-server-sdk5-cpp-initsdk-anywhere-parameter"></a>

[ServerParameters](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-dataypes-serverparameters)  
Pour initialiser un serveur de jeu sur une flotte Amazon GameLift Servers Anywhere, créez un `ServerParameters` objet avec les informations suivantes :  
+ URL WebSocket utilisée pour vous connecter à votre serveur de jeu. 
+ ID du processus utilisé pour héberger votre serveur de jeu. 
+ L'ID de l'ordinateur hébergeant les processus de votre serveur de jeu. 
+ L'ID du Amazon GameLift Servers parc contenant votre ordinateur Amazon GameLift Servers Anywhere.
+ Le jeton d'autorisation généré par l'Amazon GameLift Serversopération. 

### Valeur renvoyée
<a name="integration-server-sdk5-cpp-initsdk-anywhere-return"></a>

Renvoie un [Initialiser SDKOutcome](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-initsdkoutcome) objet qui indique si le processus serveur est prêt à être appelé[ProcessReady()](#integration-server-sdk5-cpp-processready). 

**Note**  
Si les appels à échouent pour `InitSDK()` les builds de jeu déployés sur des flottes Anywhere, vérifiez le `ServerSdkVersion` paramètre utilisé lors de la création de la ressource de build. Vous devez définir explicitement cette valeur en fonction de la version du SDK du serveur utilisée. La valeur par défaut de ce paramètre est 4.x, ce qui n'est pas compatible. Pour résoudre ce problème, créez une nouvelle version et déployez-la sur une nouvelle flotte.

### Exemple
<a name="integration-server-sdk5-cpp-initsdk-anywhere-example"></a>

Amazon GameLift ServersExemple n'importe où

```
//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 Amazon GameLift Servers Agent to enable further communication.
Aws::GameLift::Server::InitSDKOutcome initSdkOutcome = Aws::GameLift::Server::InitSDK(serverParameters);
```

## ProcessReady()
<a name="integration-server-sdk5-cpp-processready"></a>

Amazon GameLift ServersIndique que le processus du serveur est prêt à héberger des sessions de jeu. Appelez cette méthode après l'avoir invoquée. [InitSDK()](#integration-server-sdk5-cpp-initsdk) Cette méthode ne doit être appelée qu'une seule fois par processus.

### Syntaxe
<a name="integration-server-sdk5-cpp-processready-syntax"></a>

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

### Parameters
<a name="integration-server-sdk5-cpp-processready-parameter"></a>

**processParameters**  
Objet [ProcessParameters](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-dataypes-process) communiquant les informations suivantes relatives au processus serveur :  
+ Noms des méthodes de rappel implémentées dans le code du serveur de jeu que le Amazon GameLift Servers service invoque pour communiquer avec le processus du serveur.
+ Numéro de port sur lequel le processus serveur écoute.
+ Chemin vers les fichiers spécifiques à une session de jeu que vous voulez qu'Amazon GameLift Servers capture et stocke.

### Valeur renvoyée
<a name="integration-server-sdk5-cpp-processready-return"></a>

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

### Exemple
<a name="integration-server-sdk5-cpp-processready-example"></a>

Cet exemple illustre les implémentations de l'appel [ProcessReady()](#integration-server-sdk5-cpp-processready) et de la fonction déléguée.

```
// 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()
<a name="integration-server-sdk5-cpp-processreadyasync"></a>

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 Amazon GameLift Servers à 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()](#integration-server-sdk5-cpp-processready). Pour plus d’informations, consultez [Initialiser le processus du serveur](gamelift-sdk-server-api.md#gamelift-sdk-server-initialize).

### Syntaxe
<a name="integration-server-sdk5-cpp-processreadyasync-syntax"></a>

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

### Parameters
<a name="integration-server-sdk5-cpp-processreadyasync-parameter"></a>

**processParameters**  
Objet [ProcessParameters](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-dataypes-process) communiquant les informations suivantes relatives au processus serveur :  
+ Noms des méthodes de rappel implémentées dans le code du serveur de jeu que le Amazon GameLift Servers service invoque pour communiquer avec le processus du serveur.
+ Numéro de port sur lequel le processus serveur écoute.
+ Chemin vers les fichiers spécifiques à une session de jeu que vous voulez qu'Amazon GameLift Servers capture et stocke.
Obligatoire : oui

### Valeur renvoyée
<a name="integration-server-sdk5-cpp-processreadyasync-return"></a>

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

### Exemple
<a name="integration-server-sdk5-cpp-processreadyasync-example"></a>

```
// 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()
<a name="integration-server-sdk5-cpp-processending"></a>

Amazon GameLift ServersIndique que le processus du serveur est en train de se terminer. Appelez cette méthode après toutes les autres tâches de nettoyage (y compris la fermeture de la session de jeu active) et avant de terminer le processus. En fonction du résultat de`ProcessEnding()`, le processus se termine avec succès (0) ou erreur (-1) et génère un événement de flotte. Si le processus se termine par une erreur, l'événement de flotte généré est`SERVER_PROCESS_TERMINATED_UNHEALTHY`.

### Syntaxe
<a name="integration-server-sdk5-cpp-processending-syntax"></a>

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

### Valeur renvoyée
<a name="integration-server-sdk5-cpp-processending-return"></a>

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

### Exemple
<a name="integration-server-sdk5-cpp-processending-example"></a>

Cet exemple appelle `ProcessEnding()` et `Destroy()` avant de terminer le processus du serveur avec un code de sortie de réussite ou d'erreur.

```
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()
<a name="integration-server-sdk5-cpp-activategamesession"></a>

Amazon GameLift ServersIndique que le processus du serveur a activé une session de jeu et qu'il est maintenant prêt à recevoir les connexions des joueurs. Cette action doit être appelée dans le cadre de la fonction de `onStartGameSession()` rappel, après toute initialisation de session de jeu.

### Syntaxe
<a name="integration-server-sdk5-cpp-activategamesession-syntax"></a>

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

### Valeur renvoyée
<a name="integration-server-sdk5-cpp-activategamesession-return"></a>

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

### Exemple
<a name="integration-server-sdk5-cpp-activategamesession-example"></a>

Cet exemple montre l'`ActivateGameSession()`appel dans le cadre de la fonction de `onStartGameSession()` délégation. 

```
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()
<a name="integration-server-sdk5-cpp-updateplayersessioncreationpolicy"></a>

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.

### Syntaxe
<a name="integration-server-sdk5-cpp-updateplayersessioncreationpolicy-syntax"></a>

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

### Parameters
<a name="integration-server-sdk5-cpp-updateplayersessioncreationpolicy-parameter"></a>

**playerCreationSessionPolitique**  
Type : valeur `PlayerSessionCreationPolicy` [enum](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-dataypes-enums).  
Obligatoire : oui

### Valeur renvoyée
<a name="integration-server-sdk5-cpp-updateplayersessioncreationpolicy-return"></a>

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

### Exemple
<a name="integration-server-sdk5-cpp-updateplayersessioncreationpolicy-example"></a>

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

## GetGameSessionId()
<a name="integration-server-sdk5-cpp-getgamesessionid"></a>

Récupère l'ID de la session de jeu hébergée par le processus serveur actif. 

Pour les processus inactifs qui ne sont pas activés lors d'une session de jeu, l'appel renvoie un[GameLiftError](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-gamelifterror).

### Syntaxe
<a name="integration-server-sdk5-cpp-getgamesessionid-syntax"></a>

```
AwsStringOutcome GetGameSessionId()
```

### Parameters
<a name="integration-server-sdk5-cpp-getgamesessionid-parameter"></a>

Cette action n'a aucun paramètre.

### Valeur renvoyée
<a name="integration-server-sdk5-cpp-getgamesessionid-return"></a>

En cas de réussite, renvoie l'ID de session de jeu en tant qu'objet [AwsStringOutcome](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-awsstringoutcome). En cas d'échec, renvoie un message d'erreur.

Pour les processus inactifs qui ne sont pas activés lors d'une session de jeu, l'appel renvoie `Success` = `True` et `GameSessionId` =`""`.

### Exemple
<a name="integration-server-sdk5-cpp-getgamesessionid-example"></a>

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

## GetTerminationTime()
<a name="integration-server-sdk5-cpp-getterm"></a>

Renvoie l'heure d'arrêt planifiée pour un processus serveur, si une heure de résiliation est disponible. Un processus serveur prend des mesures après avoir reçu un `onProcessTerminate()` rappel deAmazon GameLift Servers. Amazon GameLift Serversappels `onProcessTerminate()` pour les raisons suivantes : 
+ Lorsque le processus du serveur a signalé un mauvais état de santé ou n'a pas réponduAmazon GameLift Servers.
+ Lors de la mise hors service de l'instance lors d'un événement de réduction de la taille.
+ Lorsqu'une instance est interrompue en raison d'une interruption [ponctuelle](spot-tasks.md).

### Syntaxe
<a name="integration-server-sdk5-cpp-getterm-syntax"></a>

```
AwsDateTimeOutcome GetTerminationTime()
```

### Valeur renvoyée
<a name="integration-server-sdk5-cpp-getterm-return"></a>

En cas de succès, renvoie l'heure de fin sous forme d'`AwsDateTimeOutcome`objet. La valeur est le délai de résiliation, 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 à celle `637355968000000000` des ticks. Si aucune heure de résiliation n'est disponible, renvoie un message d'erreur.

Si le processus n'a pas reçu de ProcessParameters. OnProcessTerminate() rappel, un message d'erreur est renvoyé. Pour plus d'informations sur l'arrêt d'un processus serveur, consultez[Répondre à une notification d'arrêt du processus du serveur](gamelift-sdk-server-api.md#gamelift-sdk-server-terminate).

### Exemple
<a name="integration-server-sdk5-cpp-getterm-example"></a>

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

## AcceptPlayerSession()
<a name="integration-server-sdk5-cpp-acceptplayersession"></a>

Amazon GameLift ServersIndique qu'un joueur avec l'identifiant de session de joueur spécifié s'est connecté au processus du serveur et doit être validé. Amazon GameLift Serversvérifie que l'identifiant de session du joueur est valide. Une fois la session du joueur validée, le statut de l'emplacement du joueur Amazon GameLift Servers passe de RÉSERVÉ à ACTIF. 

### Syntaxe
<a name="integration-server-sdk5-cpp-acceptplayersession-syntax"></a>

```
GenericOutcome AcceptPlayerSession(String playerSessionId)
```

### Parameters
<a name="integration-server-sdk5-cpp-acceptplayersession-parameter"></a>

playerSessionId  
Identifiant unique émis Amazon GameLift Servers lors de la création d'une nouvelle session de joueur.

### Valeur renvoyée
<a name="integration-server-sdk5-cpp-acceptplayersession-return"></a>

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

### Exemple
<a name="integration-server-sdk5-cpp-acceptplayersession-example"></a>

Cet exemple traite une demande de connexion qui inclut la validation et le rejet d'une session de joueur non valide. 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()
<a name="integration-server-sdk5-cpp-removeplayersession"></a>

Indique Amazon GameLift Servers qu'un joueur s'est déconnecté du processus serveur. En réponse, Amazon GameLift Servers change l'emplacement du joueur pour le rendre disponible. 

### Syntaxe
<a name="integration-server-sdk5-cpp-removeplayersession-syntax"></a>

```
GenericOutcome RemovePlayerSession(String playerSessionId)
```

### Parameters
<a name="integration-server-sdk5-cpp-removeplayersession-parameter"></a>

**`playerSessionId`**  
Identifiant unique émis Amazon GameLift Servers lors de la création d'une nouvelle session de joueur.

### Valeur renvoyée
<a name="integration-server-sdk5-cpp-removeplayersession-return"></a>

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

### Exemple
<a name="integration-server-sdk5-cpp-removeplayersession-example"></a>

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

## DescribePlayerSessions()
<a name="integration-server-sdk5-cpp-describeplayersessions"></a>

Récupère les données de session du joueur, notamment les paramètres, les métadonnées de session et les données du joueur. Utilisez cette méthode pour obtenir des informations sur les points suivants :
+ Une session solo
+ Toutes les sessions des joueurs au cours d'une session de jeu
+ Toutes les sessions de joueur associées à un identifiant de joueur unique

### Syntaxe
<a name="integration-server-sdk5-cpp-describeplayersessions-syntax"></a>

```
DescribePlayerSessionsOutcome DescribePlayerSessions(DescribePlayerSessionsRequest describePlayerSessionsRequest)
```

### Parameters
<a name="integration-server-sdk5-cpp-describeplayersessions-parameter"></a>

**[DescribePlayerSessionsRequest](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-dataypes-playersessions)**  
[DescribePlayerSessionsRequest](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-dataypes-playersessions)Objet qui décrit les sessions de joueur à récupérer.

### Valeur renvoyée
<a name="integration-server-sdk5-cpp-describeplayersessions-return"></a>

En cas de réussite, renvoie un objet [DescribePlayerSessionsOutcome](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-describeplayersessionsoutcome) qui contient un ensemble d'objets de session de joueur correspondant aux paramètres de la demande.

### Exemple
<a name="integration-server-sdk5-cpp-describeplayersessions-example"></a>

Cet exemple demande toutes les sessions de joueur activement connectées à une session de jeu spécifiée. En omettant *NextToken*et en définissant la valeur *limite* sur 10, Amazon GameLift Servers renvoie les 10 premiers enregistrements de session de joueur correspondant à 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);
```

## StartMatchBackfill()
<a name="integration-server-sdk5-cpp-startmatchbackfill"></a>

Envoie une demande de recherche de nouveaux joueurs pour des emplacements ouverts dans une session de jeu créée avec FlexMatch. Pour plus d'informations, voir la [fonction de FlexMatch remblayage](https://docs.aws.amazon.com/gameliftservers/latest/flexmatchguide/match-backfill.html).

Cette action est asynchrone. Si de nouveaux joueurs sont jumelés, Amazon GameLift Servers fournit des données de matchmaking mises à jour à l'aide de 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()](#integration-server-sdk5-cpp-stopmatchbackfill) pour annuler la requête d'origine.

### Syntaxe
<a name="integration-server-sdk5-cpp-startmatchbackfill-syntax"></a>

```
StartMatchBackfillOutcome StartMatchBackfill (StartMatchBackfillRequest startBackfillRequest);
```

### Parameters
<a name="integration-server-sdk5-cpp-startmatchbackfill-parameter"></a>

**[StartMatchBackfillRequest](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-dataypes-startmatchbackfillrequest)**  
Un StartMatchBackfillRequest objet qui communique les informations suivantes :  
+ ID de ticket à attribuer à la requête de renvoi. Ces informations sont facultatives ; si aucun identifiant n'est fourni, il en Amazon GameLift Servers générera un.
+ Matchmaker auquel envoyer la requête. L'ARN de configuration complet est obligatoire. Cette valeur se trouve dans les données du matchmaker de la session de jeu.
+ ID de la session de jeu à compléter.
+ Les données de matchmaking disponibles pour les joueurs actuels de la session de jeu.

### Valeur renvoyée
<a name="integration-server-sdk5-cpp-startmatchbackfill-return"></a>

Renvoie un [StartMatchBackfillOutcome](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-startmatchbackfilloutcome) objet avec l'identifiant du ticket de remplacement correspondant, ou un échec avec un message d'erreur. 

### Exemple
<a name="integration-server-sdk5-cpp-startmatchbackfill-example"></a>

```
// 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()
<a name="integration-server-sdk5-cpp-stopmatchbackfill"></a>

Annule une demande de remplacement de match active. Pour plus d'informations, voir la [fonction de FlexMatch remblayage](https://docs.aws.amazon.com/gameliftservers/latest/flexmatchguide/match-backfill.html).

### Syntaxe
<a name="integration-server-sdk5-cpp-stopmatchbackfill-syntax"></a>

```
GenericOutcome StopMatchBackfill (StopMatchBackfillRequest stopBackfillRequest);
```

### Parameters
<a name="integration-server-sdk5-cpp-stopmatchbackfill-parameter"></a>

**[StopMatchBackfillRequest](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-dataypes-stopmatchbackfillrequest)**  
Un StopMatchBackfillRequest objet identifiant le ticket de matchmaking à annuler :   
+ L'identifiant du ticket attribué à la demande de remblayage.
+ L'entremetteur à qui la demande de remblayage a été envoyée.
+ La session de jeu associée à la demande de remplacement.

### Valeur renvoyée
<a name="integration-server-sdk5-cpp-stopmatchbackfill-return"></a>

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

### Exemple
<a name="integration-server-sdk5-cpp-stopmatchbackfill-example"></a>

```
// 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()
<a name="integration-server-sdk5-cpp-getcomputecertificate"></a>

Récupère le chemin d'accès au certificat TLS utilisé pour chiffrer la connexion réseau entre votre ressource de calcul Amazon GameLift Servers Anywhere et. Amazon GameLift Servers Vous pouvez utiliser le chemin du certificat lorsque vous enregistrez votre appareil informatique dans un parc Amazon GameLift Servers Anywhere. Pour plus d'informations, voir, [RegisterCompute](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html).

### Syntaxe
<a name="integration-server-sdk5-cpp-getcomputecertificate-syntax"></a>

```
GetComputeCertificateOutcome Server::GetComputeCertificate()
```

### Valeur renvoyée
<a name="integration-server-sdk5-cpp-getcomputecertificate-return"></a>

Retourne un [GetComputeCertificateOutcome](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-getcomputecertificateoutcome).

### Exemple
<a name="integration-server-sdk5-cpp-getcomputecertificate-example"></a>

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

## GetFleetRoleCredentials()
<a name="integration-server-sdk5-cpp-getfleetrolecredentials"></a>

Récupère les informations d'identification du rôle IAM qui autorisent l'interaction avec Amazon GameLift Servers d'autres utilisateurs. Services AWS Pour de plus amples informations, veuillez consulter [Connectez votre serveur de jeu Amazon GameLift Servers hébergé à d'autres AWS ressources](gamelift-sdk-server-resources.md).

### Syntaxe
<a name="integration-server-sdk5-cpp-getfleetrolecredentials-syntax"></a>

```
GetFleetRoleCredentialsOutcome GetFleetRoleCredentials(GetFleetRoleCredentialsRequest request);
```

### Parameters
<a name="integration-server-sdk5-cpp-getfleetrolecredentials-parameters"></a>

[GetFleetRoleCredentialsRequest](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-dataypes-getfleetrolecredentialsrequest)

### Valeur renvoyée
<a name="integration-server-sdk5-cpp-getfleetrolecredentials-return"></a>

Renvoie un objet [GetFleetRoleCredentialsOutcome](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-getfleetrolecredentialsoutcome).

### Exemple
<a name="integration-server-sdk5-cpp-getfleetrolecredentials-example"></a>

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

Cet exemple montre l'utilisation de la `RoleSessionName` valeur facultative pour attribuer un nom à la session d'identification à des fins d'audit. Si vous ne fournissez pas de nom de session de rôle, la valeur par défaut « *[fleet-id]* - *[host-id]* » est utilisée.

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

## Détruire ()
<a name="integration-server-sdk5-cpp-ref-destroy"></a>

Libère de la mémoire le SDK du serveur de Amazon GameLift Servers jeu. Il est recommandé d'appeler cette méthode après `ProcessEnding()` et avant de terminer le processus. Si vous utilisez une flotte Anywhere et que vous n'interrompez pas les processus du serveur après chaque session de jeu, appelez `Destroy()` puis `InitSDK()` réinitialisez avant de signaler Amazon GameLift Servers que le processus est prêt à héberger une session de jeu avec. `ProcessReady()`

### Syntaxe
<a name="integration-server-sdk5-cpp-ref-destroy-syntax"></a>

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

### Parameters
<a name="integration-server-sdk5-cpp-ref-destroy-parameter"></a>

Il n'y a aucun paramètre.

### Valeur renvoyée
<a name="integration-server-sdk5-cpp-ref-destroy-return"></a>

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

### Exemple
<a name="integration-server-sdk5-cpp-ref-destroy-example"></a>

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

# SDK 5.x du serveur C\$1 pour -- Actions Amazon GameLift Servers
<a name="integration-server-sdk5-csharp-actions"></a>

Utilisez la référence du SDK 5.x du serveur pour intégrer votre jeu multijoueur à des fins d'hébergement. Amazon GameLift Servers Pour obtenir des conseils sur le processus d'intégration, consultez[Ajoutez Amazon GameLift Servers à votre serveur de jeu avec le SDK du serveur](gamelift-sdk-server-api.md). Si vous utilisez le Amazon GameLift Servers plugin pour Unity, consultez également[Amazon GameLift Serversplugin pour Unity (SDK serveur 5.x)](unity-plug-in.md).

# SDK 5.x du serveur C\$1 pour Amazon GameLift Servers -- Types de données
<a name="integration-server-sdk5-csharp-datatypes"></a>

Utilisez la référence du SDK 5.x du serveur Amazon GameLift Servers C\$1 pour intégrer votre jeu multijoueur à des fins d'hébergement. Amazon GameLift Servers Pour obtenir des conseils sur le processus d'intégration, consultez[Ajoutez Amazon GameLift Servers à votre serveur de jeu avec le SDK du serveur](gamelift-sdk-server-api.md). Si vous utilisez le Amazon GameLift Servers plugin pour Unity, consultez également[Amazon GameLift Serversplugin pour Unity (SDK serveur 5.x)](unity-plug-in.md).

[SDK 5.x du serveur C\$1 pour -- Actions Amazon GameLift Servers](integration-server-sdk5-csharp-actions.md)

**Topics**
+ [LogParameters](#integration-server-sdk5-csharp-dataypes-log)
+ [MetricsParameters](#integration-server-sdk5-csharp-datatypes-metricsparameters)
+ [ProcessParameters](#integration-server-sdk5-csharp-dataypes-process)
+ [UpdateGameSession](#integration-server-sdk5-csharp-dataypes-updategamesession)
+ [GameSession](#integration-server-sdk5-csharp-dataypes-gamesession)
+ [ServerParameters](#integration-server-sdk5-csharp-dataypes-serverparameters)
+ [StartMatchBackfillRequest](#integration-server-sdk5-csharp-dataypes-startmatchbackfillrequest)
+ [Joueur](#integration-server-sdk5-csharp-dataypes-player)
+ [DescribePlayerSessionsRequest](#integration-server-sdk5-csharp-dataypes-playersessions)
+ [StopMatchBackfillRequest](#integration-server-sdk5-csharp-dataypes-stopmatchbackfillrequest)
+ [GetFleetRoleCredentialsRequest](#integration-server-sdk5-csharp-dataypes-getfleetrolecredentialsrequest)
+ [AttributeValue](#integration-server-sdk5-csharp-datatypes-attributevalue)
+ [AwsStringOutcome](#integration-server-sdk5-csharp-datatypes-awsstringoutcome)
+ [GenericOutcome](#integration-server-sdk5-csharp-datatypes-genericoutcome)
+ [MetricsManagerOutcome](#integration-server-sdk5-csharp-datatypes-metricsmanageroutcome)
+ [DescribePlayerSessionsOutcome](#integration-server-sdk5-csharp-datatypes-describeplayersessionsoutcome)
+ [DescribePlayerSessionsResult](#integration-server-sdk5-csharp-datatypes-describeplayersessionsresult)
+ [PlayerSession](#integration-server-sdk5-csharp-datatypes-playersession)
+ [StartMatchBackfillOutcome](#integration-server-sdk5-csharp-datatypes-startmatchbackfilloutcome)
+ [StartMatchBackfillResult](#integration-server-sdk5-csharp-datatypes-startmatchbackfillresult)
+ [GetComputeCertificateOutcome](#integration-server-sdk5-csharp-datatypes-getcomputecertificateoutcome)
+ [GetComputeCertificateResult](#integration-server-sdk5-csharp-datatypes-getcomputecertificateresult)
+ [GetFleetRoleCredentialsOutcome](#integration-server-sdk5-csharp-datatypes-getfleetrolecredentialsoutcome)
+ [GetFleetRoleCredentialsResult](#integration-server-sdk5-csharp-datatypes-getfleetrolecredentialsresult)
+ [AwsDateTimeOutcome](#integration-server-sdk5-csharp-datatypes-awsdatetimeoutcome)
+ [GameLiftError](#integration-server-sdk5-csharp-datatypes-gamelifterror)
+ [Enums](#integration-server-sdk5-csharp-datatypes-enums)

## LogParameters
<a name="integration-server-sdk5-csharp-dataypes-log"></a>

Utilisez ce type de données pour identifier les fichiers générés pendant une session de jeu vers lesquels vous souhaitez que le serveur de jeu les télécharge Amazon GameLift Servers après la fin de la session de jeu. Le serveur de jeu communique `LogParameters to` Amazon GameLift Servers lors d'un [ProcessReady()](integration-server-sdk5-csharp-actions.md#integration-server-sdk5-csharp-processready) appel.


|  |  | 
| --- |--- |
|  **Propriétés**  | Description | 
| LogPaths |  La liste des chemins de répertoire vers les fichiers journaux du serveur de jeu que vous Amazon GameLift Servers souhaitez stocker pour un accès futur. Le processus du serveur génère ces fichiers lors de chaque session de jeu. Vous définissez les chemins et les noms des fichiers sur votre serveur de jeu et vous les stockez dans le répertoire racine du jeu.  Les chemins du journal doivent être absolus. Par exemple, si votre build de jeu stocke les journaux de session de jeu dans un chemin tel que`MyGame\sessionLogs\`, le chemin se `c:\game\MyGame\sessionLogs` trouve sur une instance Windows. **Type :** `List<String>` **Obligatoire** : non  | 

## MetricsParameters
<a name="integration-server-sdk5-csharp-datatypes-metricsparameters"></a>

Utilisez ce type de données pour configurer la collecte de métriques et le signalement des pannes pour le serveur de jeu. Le serveur de jeu communique avec `MetricsParameters` Amazon GameLift Servers lors d'un [InitMetrics()](integration-server-sdk5-csharp-actions.md#integration-server-sdk5-csharp-initmetrics) appel.


|  |  | 
| --- |--- |
|  **Propriétés**  | Description | 
| StatsdHost |  Le nom d'hôte ou l'adresse IP du serveur StatsD pour la collecte des métriques. **Type :** `String` **Obligatoire** : non  | 
| StatsdPort |  Numéro de port du serveur StatsD pour la collecte des métriques. **Type :** `Integer` **Obligatoire** : non  | 
| CrashReporterHost |  Le nom d'hôte ou l'adresse IP du serveur signalant les incidents. **Type :** `String` **Obligatoire** : non  | 
| CrashReporterPort |  Numéro de port du serveur Crash Reporter. **Type :** `Integer` **Obligatoire** : non  | 
| FlushIntervalMs |  Intervalle en millisecondes pour le transfert des données de métriques vers le serveur. **Type :** `Integer` **Obligatoire** : non  | 
| MaxPacketSize |  Taille maximale en octets des paquets de métriques envoyés au serveur. **Type :** `Integer` **Obligatoire** : non  | 

## ProcessParameters
<a name="integration-server-sdk5-csharp-dataypes-process"></a>

Ce type de données contient l'ensemble des paramètres envoyés Amazon GameLift Servers lors d'un [ProcessReady()](integration-server-sdk5-csharp-actions.md#integration-server-sdk5-csharp-processready) appel.


|  |  | 
| --- |--- |
|  **Propriétés**  | Description | 
| LogParameters | L'objet contenant une liste de chemins de répertoire vers les fichiers journaux des sessions de jeu.**Type :** `Aws::GameLift::Server::LogParameters`**Obligatoire** : oui | 
| OnHealthCheck | Nom de la fonction de rappel Amazon GameLift Servers invoquée pour demander un rapport d'état de santé au processus du serveur. Amazon GameLift Serversappelle cette fonction toutes les 60 secondes. Après avoir appelé cette fonction, Amazon GameLift Servers elle attend 60 secondes pour recevoir une réponse. Si aucune réponse n'est reçue, le processus Amazon GameLift Servers du serveur est considéré comme défaillant.**Type :** `void OnHealthCheckDelegate()`**Obligatoire** : oui | 
| OnProcessTerminate | Nom de la fonction de rappel Amazon GameLift Servers invoquée pour forcer l'arrêt du processus du serveur. Après l'appel de cette fonction, Amazon GameLift Servers patiente cinq minutes afin que le processus serveur s'arrête et réponde avec un appel [ProcessEnding()](integration-server-sdk5-csharp-actions.md#integration-server-sdk5-csharp-processending) avant d'arrêter le processus serveur.**Type :** `void OnProcessTerminateDelegate()`**Obligatoire** : oui | 
| OnStartGameSession | Nom de la fonction de rappel Amazon GameLift Servers invoquée pour activer une nouvelle session de jeu. Amazon GameLift Serversappelle cette fonction en réponse à la demande du client [CreateGameSession](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_CreateGameSession.html). La fonction de rappel prend un [GameSession](#integration-server-sdk5-csharp-dataypes-gamesession) objet.**Type :** `void OnStartGameSessionDelegate(GameSession)`**Obligatoire** : oui | 
| OnUpdateGameSession | Nom de la fonction de rappel Amazon GameLift Servers invoquée pour transmettre un objet de session de jeu mis à jour au processus du serveur. Amazon GameLift Serversappelle cette fonction lorsqu'une demande de remplissage de correspondances a été traitée pour fournir des données de matchmaking mises à jour. Il transmet un [GameSession](#integration-server-sdk5-csharp-dataypes-gamesession) objet, une mise à jour de statut (updateReason) et l'identifiant du ticket de remplacement des matchs.**Type :** vide OnUpdateGameSessionDelegate ([UpdateGameSession](#integration-server-sdk5-csharp-dataypes-updategamesession))**Obligatoire** : non | 
|  Port | Numéro de port sur lequel le processus serveur écoute les connexions des nouveaux joueurs. La valeur doit être comprise dans la plage de ports configurée pour toutes les flottes déployant cette version de génération du serveur de jeux. Ce numéro de port est inclus dans les objets de session de jeu et de session de joueur, que les sessions de jeu utilisent pour se connecter à un processus serveur.**Type :** `Integer`**Obligatoire** : oui | 

## UpdateGameSession
<a name="integration-server-sdk5-csharp-dataypes-updategamesession"></a>

Les informations mises à jour pour un objet de session de jeu incluent la raison pour laquelle la session de jeu a été mise à jour. Si la mise à jour est liée à une action de remplissage par correspondance, ce type de données inclut l'ID du ticket de remplissage.


| Propriétés | **Description** | 
| --- | --- | 
| GameSession | Un objet [GameSession](#integration-server-sdk5-csharp-dataypes-gamesession). L'GameSessionobjet contient des propriétés décrivant une session de jeu. **Type :** `GameSession GameSession()`**Obligatoire** : oui | 
| UpdateReason | La raison pour laquelle la session de jeu est mise à jour.**Type :** `UpdateReason UpdateReason()`**Obligatoire** : oui | 
| BackfillTicketId | L'identifiant du ticket de remplacement qui tente de mettre à jour la session de jeu.**Type :** `String`**Obligatoire** : oui | 

## GameSession
<a name="integration-server-sdk5-csharp-dataypes-gamesession"></a>

Détails d'une session de jeu. 


| Propriétés | **Description** | 
| --- | --- | 
| GameSessionId |  Identifiant unique pour la session de jeu. L'ARN d'une session de jeu a le format suivant :`arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>`. **Type :** `String` **Obligatoire** : non  | 
| Nom |  Une étiquette descriptive de la session de jeu.  **Type :** `String` **Obligatoire** : non  | 
| FleetId |  Identifiant unique de la flotte sur laquelle s'exécute la session de jeu. **Type :** `String` **Obligatoire** : non  | 
| MaximumPlayerSessionCount |  Le nombre maximum de connexions de joueurs à la session de jeu. **Type :** `Integer` **Obligatoire** : non  | 
|  Port |  Le numéro de port de la session de jeu. Pour se connecter à un serveur de Amazon GameLift Servers jeu, une application a besoin à la fois de l'adresse IP et du numéro de port. **Type :** `Integer` **Obligatoire** : non  | 
| IpAddress |  Adresse IP de la session de jeu. Pour se connecter à un serveur de Amazon GameLift Servers jeu, une application a besoin à la fois de l'adresse IP et du numéro de port. **Type :** `String` **Obligatoire** : non  | 
| GameSessionData |  Ensemble de propriétés de session de jeu personnalisées, mises en forme en tant que valeur de chaîne unique.  **Type :** `String` **Obligatoire** : non  | 
| MatchmakerData |  Les informations sur le processus de matchmaking utilisé pour créer la session de jeu, en syntaxe JSON, formatées sous forme de chaîne. En plus de la configuration de matchmaking utilisée, elle contient des données sur tous les joueurs affectés au match, y compris les attributs des joueurs et les affectations des équipes. **Type :** `String` **Obligatoire** : non  | 
| GameProperties |  Ensemble de propriétés personnalisées pour une session de jeu, formatées sous forme de paires clé:valeur. Ces propriétés sont transmises avec une demande de démarrage d'une nouvelle session de jeu. **Type :** `Dictionary<string, string>` **Obligatoire** : non  | 
| DnsName |  Identifiant DNS attribué à l'instance qui exécute la session de jeu. Les valeurs ont le format suivant : [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/gameliftservers/latest/developerguide/integration-server-sdk5-csharp-datatypes.html) Lorsque vous vous connectez à une session de jeu exécutée sur une flotte compatible TLS, vous devez utiliser le nom DNS et non l'adresse IP. **Type :** `String` **Obligatoire** : non  | 

## ServerParameters
<a name="integration-server-sdk5-csharp-dataypes-serverparameters"></a>

Informations utilisées pour maintenir la connexion entre un serveur Amazon GameLift Servers Anywhere et le Amazon GameLift Servers service. Ces informations sont utilisées lors du lancement de nouveaux processus serveur avec[InitSDK()](integration-server-sdk5-csharp-actions.md#integration-server-sdk5-csharp-initsdk). Pour les serveurs hébergés sur des instances EC2 Amazon GameLift Servers gérées, utilisez un objet vide.


| Propriétés | **Description** | 
| --- | --- | 
| WebSocketUrl |  Ils `GameLiftServerSdkEndpoint` sont retournés lorsque vous `RegisterCompute` faisiez partie de Amazon GameLift Servers Anywhere. **Type :** `String` **Obligatoire** : oui  | 
| ProcessId |  Un identifiant unique enregistré auprès du processus serveur hébergeant votre jeu. **Type :** `String` **Obligatoire** : oui  | 
| HostId |  Un identifiant unique pour l'hôte chargé des processus hébergeant votre jeu sur le serveur. Le HostID est celui ComputeName utilisé lors de l'enregistrement de votre ordinateur. Pour plus d'informations, voir [RegisterCompute](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html) **Type :** `String` **Obligatoire** : oui  | 
| FleetId | ID de flotte du parc dans lequel le calcul est enregistré. Pour plus d'informations, voir, [RegisterCompute](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html).**Type :** `String`**Obligatoire** : oui | 
| AuthToken | Le jeton d'authentification généré par Amazon GameLift Servers celui-ci authentifie votre serveur auprès deAmazon GameLift Servers. Pour plus d'informations, voir, [GetComputeAuthToken](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_GetComputeAuthToken.html).**Type :** `String`**Obligatoire** : oui | 

## StartMatchBackfillRequest
<a name="integration-server-sdk5-csharp-dataypes-startmatchbackfillrequest"></a>

Informations utilisées pour créer une demande de remplissage par matchmaking. Le serveur de jeu communique ces informations Amazon GameLift Servers lors d'un [StartMatchBackfill()](integration-server-sdk5-csharp-actions.md#integration-server-sdk5-csharp-startmatchbackfill) appel.


| Propriétés | **Description** | 
| --- | --- | 
| GameSessionArn |  L'identifiant unique de session de jeu. L'opération API `[GetGameSessionId](https://docs.aws.amazon.com/gameliftservers/latest/developerguide/integration-server-sdk5-csharp-actions.html#integration-server-sdk5-csharp-getgamesessionid)` renvoie l'identifiant au format ARN. **Type :** `String` **Obligatoire** : oui  | 
| MatchmakingConfigurationArn |  L'identifiant unique, sous la forme d'un ARN, que le système de jumelage doit utiliser pour cette demande. L'ARN de matchmaking pour la session de jeu d'origine se trouve dans l'objet de session de jeu dans la propriété de données du matchmaker. Pour en savoir plus sur les données du système de jumelage, consultez la section [Travailler avec les données du système de jumelage.](https://docs.aws.amazon.com/gameliftservers/latest/flexmatchguide/match-server.html#match-server-data.html) **Type :** `String` **Obligatoire** : oui  | 
| Joueurs |  Ensemble de données représentant tous les joueurs qui participent actuellement à la session de jeu. Le matchmaker utilise ces informations pour rechercher de nouveaux joueurs qui constituent de bonnes correspondances pour les joueurs actuels. **Type :** `List<Player>` **Obligatoire** : oui  | 
| TicketId |  L'identifiant unique d'un ticket de demande de matchmaking ou de remplacement de match. Si vous ne fournissez aucune valeur, il en Amazon GameLift Servers génère une. Utilisez cet identifiant pour suivre l'état du ticket de renvoi de correspondance ou annuler la requête si nécessaire.  **Type :** `String` **Obligatoire** : non  | 

## Joueur
<a name="integration-server-sdk5-csharp-dataypes-player"></a>

Représente un joueur dans le matchmaking. Lorsqu'une demande de matchmaking démarre, un joueur dispose d'un identifiant de joueur, d'attributs et éventuellement de données de latence. Amazon GameLift Serversajoute des informations sur l'équipe après la fin d'un match.


| Propriétés | **Description** | 
| --- | --- | 
| LatencyInMS |  Ensemble de valeurs exprimées en millisecondes, qui indiquent le niveau de latence ressenti par un joueur lorsqu'il est connecté à un lieu.  Si cette propriété est utilisée, le joueur n'est jumelé qu'aux emplacements répertoriés. Si un matchmaker dispose d'une règle qui évalue la latence, les joueurs doivent indiquer la latence pour être mis en relation. **Type :** `Dictionary<string, int>` **Obligatoire** : non  | 
| PlayerAttributes |  Une collection de paires clé:valeur contenant des informations sur les joueurs à utiliser dans le matchmaking. Les clés d'attribut du joueur doivent correspondre à PlayerAttributes celles utilisées dans un ensemble de règles de matchmaking. Pour plus d'informations sur les attributs des joueurs, consultez [AttributeValue](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_AttributeValue.html). **Type :** `Dictionary<string, AttributeValue` **Obligatoire** : non  | 
| PlayerId |  Identifiant unique pour un joueur. **Type :** `String` **Obligatoire** : non  | 
| Team |  Le nom de l'équipe à laquelle le joueur est affecté lors d'un match. Vous définissez le nom de l'équipe dans le jeu de règles de matchmaking. **Type :** `String` **Obligatoire** : non  | 

## DescribePlayerSessionsRequest
<a name="integration-server-sdk5-csharp-dataypes-playersessions"></a>

Ce type de données est utilisé pour spécifier les sessions de joueur à récupérer. Il peut être utilisé de plusieurs manières : (1) fournir une session PlayerSessionId pour demander une session de joueur spécifique ; (2) fournir une GameSessionId pour demander toutes les sessions de joueur dans la session de jeu spécifiée ; ou (3) fournir une PlayerId pour demander toutes les sessions de joueur pour le joueur spécifié. Pour les volumes importants de sessions de joueur, utilisez les paramètres de pagination pour récupérer les résultats en tant que pages séquentielles.


| Propriétés | **Description** | 
| --- | --- | 
| GameSessionId |  L'identifiant unique de session de jeu. Utilisez ce paramètre pour demander toutes les sessions de joueur pour la session de jeu spécifiée. Le format de l'ID de session de jeu est le suivant : `arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>`. La valeur de <ID string>peut être une chaîne d'ID personnalisée (si spécifiée lors de la création de la session de jeu) ou une chaîne générée automatiquement.  **Type :** `String` **Obligatoire** : non  | 
| PlayerSessionId |  Identifiant unique d'une session de joueur. **Type :** `String` **Obligatoire** : non  | 
| PlayerId |  L'identifiant unique d'un joueur. Consultez [Générer un joueur IDs](player-sessions-player-identifiers.md). **Type :** `String` **Obligatoire** : non  | 
| PlayerSessionStatusFilter |  État de la session du joueur sur lequel filtrer les résultats. Les états de session de joueur possibles sont les suivants : [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/gameliftservers/latest/developerguide/integration-server-sdk5-csharp-datatypes.html) **Type :** `String` **Obligatoire** : non  | 
| NextToken |  Le jeton indiquant le début de la page de résultats suivante. Pour spécifier le début du jeu de résultats, ne fournissez aucune valeur. Si vous fournissez un identifiant de session de joueur, ce paramètre est ignoré. **Type :** `String` **Obligatoire** : non  | 
| Limite |  Nombre maximal de résultats à renvoyer. Si vous fournissez un identifiant de session de joueur, ce paramètre est ignoré. **Type :** `int` **Obligatoire** : non  | 

## StopMatchBackfillRequest
<a name="integration-server-sdk5-csharp-dataypes-stopmatchbackfillrequest"></a>

Informations utilisées pour annuler une demande de remplissage par matchmaking. Le serveur de jeu communique ces informations au Amazon GameLift Servers service lors d'un [StopMatchBackfill()](integration-server-sdk5-csharp-actions.md#integration-server-sdk5-csharp-stopmatchbackfill) appel.


| Propriétés | **Description** | 
| --- | --- | 
| GameSessionArn |  Identifiant de session de jeu unique de la demande annulée. **Type :** `string` **Obligatoire** : oui  | 
| MatchmakingConfigurationArn |  L'identifiant unique du matchmaker auquel cette demande a été envoyée. **Type :** `string` **Obligatoire** : oui  | 
| TicketId |  L'identifiant unique du ticket de demande de remblayage à annuler. **Type :** `string` **Obligatoire** : oui  | 

## GetFleetRoleCredentialsRequest
<a name="integration-server-sdk5-csharp-dataypes-getfleetrolecredentialsrequest"></a>

Ce type de données donne au serveur de jeu un accès limité à vos autres AWS ressources. Pour plus d'informations, voir,[Configurer un rôle de service IAM pour Amazon GameLift Servers](setting-up-role.md).


| Propriétés | **Description** | 
| --- | --- | 
| RoleArn | Le nom de ressource Amazon (ARN) du rôle de service qui étend un accès limité à vos AWS ressources. **Type :** `string` **Obligatoire** : oui  | 
| RoleSessionName | Nom de la session qui décrit l'utilisation des informations d'identification du rôle. **Type :** `string` **Obligatoire** : non  | 

## AttributeValue
<a name="integration-server-sdk5-csharp-datatypes-attributevalue"></a>

Utilisez ces valeurs dans les paires [Joueur](#integration-server-sdk5-csharp-dataypes-player) clé-valeur d'attribut. Cet objet vous permet de spécifier une valeur d'attribut à l'aide de n'importe quel type de données valide : chaîne, nombre, tableau de chaînes ou mappage de données. Chaque `AttributeValue` objet ne peut utiliser qu'une seule des propriétés disponibles.


| Propriétés | Description | 
| --- | --- | 
| Type ATR |  Spécifie le type de valeur d'attribut. **Type :** valeur `AttrType` [enum](#integration-server-sdk5-csharp-datatypes-enums).  **Obligatoire** : non  | 
|  S |  Représente une valeur d'attribut de chaîne. **Type :** `string` **Obligatoire** : oui  | 
| N |  Représente une valeur d'attribut numérique. **Type :** `double` **Obligatoire** : oui  | 
| SL |  Représente un tableau de valeurs d'attributs de chaîne. **Type :** `string[]` **Obligatoire** : oui  | 
| SDM |  Représente un dictionnaire de clés de chaîne et de valeurs doubles. **Type :** `Dictionary<string, double>` **Obligatoire** : oui  | 

## AwsStringOutcome
<a name="integration-server-sdk5-csharp-datatypes-awsstringoutcome"></a>

Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :


| Propriétés | Description | 
| --- | --- | 
| Résultat |  Le résultat de l'action. **Type :** `string` **Obligatoire** : non  | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  Erreur survenue en cas d'échec de l'action. **Type :** [GameLiftError](#integration-server-sdk5-csharp-datatypes-gamelifterror) **Obligatoire** : non  | 

## GenericOutcome
<a name="integration-server-sdk5-csharp-datatypes-genericoutcome"></a>

Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :


| Propriétés | Description | 
| --- | --- | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  Erreur survenue en cas d'échec de l'action. **Type :** [GameLiftError](#integration-server-sdk5-csharp-datatypes-gamelifterror) **Obligatoire** : non  | 

## MetricsManagerOutcome
<a name="integration-server-sdk5-csharp-datatypes-metricsmanageroutcome"></a>

Représente le résultat d'un [InitMetrics()](integration-server-sdk5-csharp-actions.md#integration-server-sdk5-csharp-initmetrics) appel. Contient soit une MetricsManager instance en cas de réussite, soit des informations d'erreur en cas d'échec.


|  |  | 
| --- |--- |
| Résultat |  L' MetricsManager instance de collecte et de reporting des métriques. **Type :** `MetricsManager` **Obligatoire** : non  | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  Erreur survenue en cas d'échec de l'action. **Type :** [GameLiftError](#integration-server-sdk5-csharp-datatypes-gamelifterror) **Obligatoire** : non  | 

## DescribePlayerSessionsOutcome
<a name="integration-server-sdk5-csharp-datatypes-describeplayersessionsoutcome"></a>

Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :


| Propriétés | Description | 
| --- | --- | 
| Résultat |  Le résultat de l'action. **Type :** [DescribePlayerSessionsResult](#integration-server-sdk5-csharp-datatypes-describeplayersessionsresult) **Obligatoire** : non   | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  Erreur survenue en cas d'échec de l'action. **Type :** [GameLiftError](#integration-server-sdk5-csharp-datatypes-gamelifterror) **Obligatoire** : non  | 

## DescribePlayerSessionsResult
<a name="integration-server-sdk5-csharp-datatypes-describeplayersessionsresult"></a>


| Propriétés | Description | 
| --- | --- | 
| NextToken |  Le jeton indiquant le début de la page de résultats suivante. Pour spécifier le début du jeu de résultats, ne fournissez aucune valeur. Si vous fournissez un identifiant de session de joueur, ce paramètre est ignoré. **Type :** `string` **Obligatoire** : oui  | 
| PlayerSessions |  Collection d'objets contenant les propriétés de chaque session de joueur correspondant à la demande.  **Type :** `IList<PlayerSession>` **Obligatoire** :   | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  Erreur survenue en cas d'échec de l'action. **Type :** [GameLiftError](#integration-server-sdk5-csharp-datatypes-gamelifterror) **Obligatoire** : non  | 

## PlayerSession
<a name="integration-server-sdk5-csharp-datatypes-playersession"></a>


| Propriétés | Description | 
| --- | --- | 
| CreationTime |  **Type :** `long` **Obligatoire** : oui  | 
| FleetId |  **Type :** `string` **Obligatoire** : oui  | 
| GameSessionId |  **Type :** `string` **Obligatoire** : oui  | 
| IpAddress |  **Type :** `string` **Obligatoire** : oui  | 
| PlayerData |  **Type :** `string` **Obligatoire** : oui  | 
| PlayerId |  **Type :** `string` **Obligatoire** : oui  | 
| PlayerSessionId |  **Type :** `string` **Obligatoire** : oui  | 
|  Port |  **Type :** `int` **Obligatoire** : oui  | 
| Statut |  **Type :** Une `PlayerSessionStatus` [énumération.](#integration-server-sdk5-csharp-datatypes-enums) **Obligatoire** : oui  | 
| TerminationTime |  **Type :** `long` **Obligatoire** : oui  | 
| DnsName |  **Type :** `string` **Obligatoire** : oui  | 

## StartMatchBackfillOutcome
<a name="integration-server-sdk5-csharp-datatypes-startmatchbackfilloutcome"></a>

Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :


| Propriétés | Description | 
| --- | --- | 
| Résultat |  Le résultat de l'action. **Type :** [StartMatchBackfillResult](#integration-server-sdk5-csharp-datatypes-startmatchbackfillresult) **Obligatoire** : non  | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  Erreur survenue en cas d'échec de l'action. **Type :** [GameLiftError](#integration-server-sdk5-csharp-datatypes-gamelifterror) **Obligatoire** : non  | 

## StartMatchBackfillResult
<a name="integration-server-sdk5-csharp-datatypes-startmatchbackfillresult"></a>


| Propriétés | Description | 
| --- | --- | 
| TicketId |  **Type :** `string` **Obligatoire** : oui  | 

## GetComputeCertificateOutcome
<a name="integration-server-sdk5-csharp-datatypes-getcomputecertificateoutcome"></a>

Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :


| Propriétés | Description | 
| --- | --- | 
| Résultat |  Le résultat de l'action. **Type :** [GetComputeCertificateResult](#integration-server-sdk5-csharp-datatypes-getcomputecertificateresult) **Obligatoire** : non   | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  Erreur survenue en cas d'échec de l'action. **Type :** [GameLiftError](#integration-server-sdk5-csharp-datatypes-gamelifterror) **Obligatoire** : non  | 

## GetComputeCertificateResult
<a name="integration-server-sdk5-csharp-datatypes-getcomputecertificateresult"></a>

Le chemin d'accès au certificat TLS sur votre ordinateur et le nom d'hôte du calcul.


| Propriétés | Description | 
| --- | --- | 
| CertificatePath |  **Type :** `string` **Obligatoire** : oui  | 
| ComputeName |  **Type :** `string` **Obligatoire** : oui  | 

## GetFleetRoleCredentialsOutcome
<a name="integration-server-sdk5-csharp-datatypes-getfleetrolecredentialsoutcome"></a>

Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :


| Propriétés | Description | 
| --- | --- | 
| Résultat |  Le résultat de l'action. **Type :** [GetFleetRoleCredentialsResult](#integration-server-sdk5-csharp-datatypes-getfleetrolecredentialsresult) **Obligatoire** : non  | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  Erreur survenue en cas d'échec de l'action. **Type :** [GameLiftError](#integration-server-sdk5-csharp-datatypes-gamelifterror) **Obligatoire** : non  | 

## GetFleetRoleCredentialsResult
<a name="integration-server-sdk5-csharp-datatypes-getfleetrolecredentialsresult"></a>


| Propriétés | Description | 
| --- | --- | 
| AccessKeyId |  ID de clé d'accès permettant d'authentifier et de fournir un accès à vos AWS ressources. **Type :** `string` **Obligatoire** : non  | 
| AssumedRoleId |  ID de l'utilisateur auquel appartient le rôle de service. **Type :** `string` **Obligatoire** : non  | 
| AssumedRoleUserArn |  Le nom de ressource Amazon (ARN) de l'utilisateur auquel appartient le rôle de service. **Type :** `string` **Obligatoire** : non  | 
| Expiration |  Durée avant l'expiration de vos informations d'identification de session. **Type :** `DateTime` **Obligatoire** : non  | 
| SecretAccessKey |  ID de clé d'accès secrète pour l'authentification. **Type :** `string` **Obligatoire** : non  | 
| SessionToken |  Un jeton pour identifier la session active en cours qui interagit avec vos AWS ressources. **Type :** `string` **Obligatoire** : non  | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  Erreur survenue en cas d'échec de l'action. **Type :** [GameLiftError](#integration-server-sdk5-csharp-datatypes-gamelifterror) **Obligatoire** : non  | 

## AwsDateTimeOutcome
<a name="integration-server-sdk5-csharp-datatypes-awsdatetimeoutcome"></a>

Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :


| Propriétés | Description | 
| --- | --- | 
| Résultat |  Le résultat de l'action. **Type :** `DateTime` **Obligatoire** : non   | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  Erreur survenue en cas d'échec de l'action. **Type :** [GameLiftError](#integration-server-sdk5-csharp-datatypes-gamelifterror) **Obligatoire** : non  | 

## GameLiftError
<a name="integration-server-sdk5-csharp-datatypes-gamelifterror"></a>


| Propriétés | Description | 
| --- | --- | 
| ErrorType |  Type d'erreur. **Type :** Une `GameLiftErrorType` [énumération.](#integration-server-sdk5-csharp-datatypes-enums) **Obligatoire** : non   | 
| ErrorName |  Nom de l'erreur.  **Type :** `string`  **Obligatoire** : non   | 
| ErrorMessage |  Message d’erreur.  **Type :** `string`  **Obligatoire** : non   | 

## Enums
<a name="integration-server-sdk5-csharp-datatypes-enums"></a>

Les énumérations définies pour le SDK du serveur pour Amazon GameLift Servers (C\$1) sont définies comme suit :

**AttrType**  
+ **NONE**
+ **CORDE**
+ **DOUBLE**
+ **LISTE\$1CHAÎNES**
+ **STRING\$1DOUBLE\$1MAP**

**GameLiftErrorType**  
Valeur de chaîne indiquant le type d'erreur. Les valeurs valides sont les suivantes :  
+ **SERVICE\$1CALL\$1FAILED** — Un appel à un AWS service a échoué. 
+ **LOCAL\$1CONNECTION\$1FAILED — La connexion locale a échoué**. Amazon GameLift Servers 
+ **NETWORK\$1NOT\$1INITIALIZED — Le réseau n'a pas été initialisé**. 
+ **GAMESESSION\$1ID\$1NOT\$1SET — L'ID de session de jeu n'a pas été défini**. 
+ **MAUVAISE DEMANDE D'EXCEPTION** 
+ **EXCEPTION DE SERVICE INTERNE** 
+ **ALREADY\$1INITIALIZED** — Le Amazon GameLift Servers serveur ou le client a déjà été initialisé avec Initialize (). 
+ **FLEET\$1MISMATCH** — La flotte cible ne correspond pas à la flotte d'une GameSession ou d'une PlayerSession. 
+ **GAMELIFT\$1CLIENT\$1NOT\$1INITIALIZED — Le client n'a pas été initialisé**. Amazon GameLift Servers 
+ **GAMELIFT\$1SERVER\$1NOT\$1INITIALIZED — Le serveur n'a pas été initialisé**. Amazon GameLift Servers 
+ **GAME\$1SESSION\$1ENDED\$1FAILED : le SDK du serveur n'a pas** Amazon GameLift Servers pu contacter le service pour signaler la fin de la session de jeu. 
+ **GAME\$1SESSION\$1NOT\$1READY** — La Amazon GameLift Servers session de jeu sur le serveur n'a pas été activée. 
+ **GAME\$1SESSION\$1READY\$1FAILED : le SDK du serveur n'a pas Amazon GameLift Servers pu contacter le service pour signaler que la session de jeu est prête**. 
+ **INITIALIZATION\$1MISMATCH** — Une méthode client a été appelée après Server : :Initialize (), ou vice versa. 
+ **NOT\$1INITIALIZED** — Le Amazon GameLift Servers serveur ou le client n'a pas été initialisé avec Initialize (). 
+ **NO\$1TARGET\$1ALIASID\$1SET — Aucun AliasID cible n'a été défini**. 
+ **NO\$1TARGET\$1FLEET\$1SET — Aucune flotte cible n'a été définie**. 
+ **PROCESS\$1ENDING\$1FAILED** : le SDK du serveur n'a pas Amazon GameLift Servers pu contacter le service pour signaler la fin du processus. 
+ **PROCESS\$1NOT\$1ACTIVE** — Le processus du serveur n'est pas encore actif, n'est pas lié à un et ne peut ni GameSession accepter ni traiter. PlayerSessions 
+ **PROCESS\$1NOT\$1READY** — Le processus du serveur n'est pas encore prêt à être activé. 
+ **PROCESS\$1READY\$1FAILED : le SDK du serveur n'a pas Amazon GameLift Servers pu contacter le service pour signaler que le processus est prêt**. 
+ **SDK\$1VERSION\$1DETECTION\$1FAILED — La détection de la version** du SDK a échoué. 
+ **STX\$1CALL\$1FAILED — Un appel au composant principal du XStx serveur a échoué**. 
+ **STX\$1INITIALIZATION\$1FAILED — Le composant principal du XStx serveur n'a pas pu** être initialisé. 
+ **UNEXPECTED\$1PLAYER\$1SESSION** — Le serveur a détecté une session de joueur non enregistrée. 
+ **ÉCHEC DE CONNEXION WEBSOCKET** 
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1FORBIDDEN** 
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1INVALID\$1URL** 
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1TIMEOUT** 
+ **WEBSOCKET\$1RETRIABLE\$1SEND\$1MESSAGE\$1FAILURE — Échec récupérable lors de l'envoi d'un message** au service. GameLift WebSocket 
+ **WEBSOCKET\$1SEND\$1MESSAGE\$1FAILURE — Impossible d'envoyer un message au service**. GameLift WebSocket 
+ **MATCH\$1BACKFILL\$1REQUEST\$1VALIDATION — La validation de la demande a échoué**. 
+ **PLAYER\$1SESSION\$1REQUEST\$1VALIDATION — La validation de la demande** a échoué. 

**PlayerSessionCreationPolicy**  
Valeur de chaîne indiquant si la session de jeu accepte ou non de nouveaux joueurs. Les valeurs valides sont les suivantes :   
+ **ACCEPT\$1ALL — Accepte toutes les** sessions de nouveaux joueurs. 
+ **DENY\$1ALL — Refuse toutes les** sessions de nouveaux joueurs. 
+ **NOT\$1SET** — La session de jeu n'est pas configurée pour accepter ou refuser les sessions de nouveaux joueurs. 

**PlayerSessionStatus**  
+ **ACTIF**
+ **TERMINÉ**
+ **NOT\$1SET**
+ **RÉSERVÉ**
+ **DÉLAI EXPIRÉ**

[SDK 5.x du serveur C\$1 pour Amazon GameLift Servers -- Types de données](integration-server-sdk5-csharp-datatypes.md)

**Topics**
+ [SDK 5.x du serveur C\$1 pour Amazon GameLift Servers -- Types de données](integration-server-sdk5-csharp-datatypes.md)
+ [GetSdkVersion()](#integration-server-sdk5-csharp-getsdkversion)
+ [InitMetrics()](#integration-server-sdk5-csharp-initmetrics)
+ [InitSDK()](#integration-server-sdk5-csharp-initsdk)
+ [InitSDK()](#integration-server-sdk5-csharp-initsdk-anywhere)
+ [ProcessReady()](#integration-server-sdk5-csharp-processready)
+ [ProcessEnding()](#integration-server-sdk5-csharp-processending)
+ [ActivateGameSession()](#integration-server-sdk5-csharp-activategamesession)
+ [UpdatePlayerSessionCreationPolicy()](#integration-server-sdk5-csharp-updateplayersessioncreationpolicy)
+ [GetGameSessionId()](#integration-server-sdk5-csharp-getgamesessionid)
+ [GetTerminationTime()](#integration-server-sdk5-csharp-getterm)
+ [AcceptPlayerSession()](#integration-server-sdk5-csharp-acceptplayersession)
+ [RemovePlayerSession()](#integration-server-sdk5-csharp-removeplayersession)
+ [DescribePlayerSessions()](#integration-server-sdk5-csharp-describeplayersessions)
+ [StartMatchBackfill()](#integration-server-sdk5-csharp-startmatchbackfill)
+ [StopMatchBackfill()](#integration-server-sdk5-csharp-stopmatchbackfill)
+ [GetComputeCertificate()](#integration-server-sdk5-csharp-getcomputecertificate)
+ [GetFleetRoleCredentials()](#integration-server-sdk5-csharp-getfleetrolecredentials)
+ [Détruire ()](#integration-server-sdk5-csharp-destroy)

## GetSdkVersion()
<a name="integration-server-sdk5-csharp-getsdkversion"></a>

Renvoie le numéro de version actuel du kit SDK intégré dans le processus serveur.

### Syntaxe
<a name="integration-server-sdk5-csharp-getsdkversion-syntax"></a>

```
AwsStringOutcome GetSdkVersion();
```

### Valeur renvoyée
<a name="integration-server-sdk5-csharp-getsdkversion-return"></a>

En cas de réussite, renvoie la version actuelle du kit SDK en tant qu'objet [AwsStringOutcome](integration-server-sdk5-csharp-datatypes.md#integration-server-sdk5-csharp-datatypes-awsstringoutcome). La chaîne renvoyée inclut le numéro de version (exemple`5.0.0`). En cas d'échec, renvoie un message d'erreur.

### Exemple
<a name="integration-server-sdk5-csharp-getsdkversion-example"></a>

```
var getSdkVersionOutcome = GameLiftServerAPI.GetSdkVersion();
```

## InitMetrics()
<a name="integration-server-sdk5-csharp-initmetrics"></a>

Initialise le système de métriques pour la collecte et le reporting des données de performance du serveur. Pour de meilleurs résultats, appelez cette méthode avant [InitSDK()](#integration-server-sdk5-csharp-initsdk) pour activer la collecte de métriques lors de l'initialisation du SDK.

### Syntaxe
<a name="integration-server-sdk5-csharp-initmetrics-syntax"></a>

```
MetricsManagerOutcome InitMetrics();
MetricsManagerOutcome InitMetrics(MetricsParameters metricsParameters);
```

### Parameters
<a name="integration-server-sdk5-csharp-initmetrics-parameter"></a>

[MetricsParameters](integration-server-sdk5-csharp-datatypes.md#integration-server-sdk5-csharp-datatypes-metricsparameters) (facultatif)  
Paramètres de configuration pour la collecte de métriques. Si ce n'est pas le cas, utilise des valeurs par défaut qui peuvent être remplacées par des variables d'environnement.

### Valeur renvoyée
<a name="integration-server-sdk5-csharp-initmetrics-return"></a>

En cas de succès, renvoie un [MetricsManagerOutcome](integration-server-sdk5-csharp-datatypes.md#integration-server-sdk5-csharp-datatypes-metricsmanageroutcome) objet contenant l' MetricsManager instance. En cas d'échec, renvoie un message d'erreur.

### Exemple
<a name="integration-server-sdk5-csharp-initmetrics-example"></a>

```
// Initialize with default parameters (uses environment variables if available)
var outcome = GameLiftServerAPI.InitMetrics();
if (outcome.Success) {
    var metricsManager = outcome.Result;
} else {
    Console.WriteLine("Failed to initialize metrics: " + outcome.Error.ErrorMessage);
}

// Initialize with custom parameters
var metricsParams = new MetricsParameters("localhost", 8125, "crash-host", 9999, 1000, 1024);
var customOutcome = GameLiftServerAPI.InitMetrics(metricsParams);
if (customOutcome.Success) {
    var metricsManager = customOutcome.Result;
}
```

## InitSDK()
<a name="integration-server-sdk5-csharp-initsdk"></a>

Initialise le Amazon GameLift Servers SDK pour un parc EC2 géré. Appelez cette méthode au lancement, avant que toute autre initialisation associée ne se Amazon GameLift Servers produise. Cette méthode lit les paramètres du serveur depuis l'environnement hôte afin de configurer la communication entre le serveur et le Amazon GameLift Servers service. Il utilise un jeton d'idempotencie, de sorte que vous pouvez réessayer cet appel en toute sécurité en cas d'échec.

### Syntaxe
<a name="integration-server-sdk5-csharp-initsdk-syntax"></a>

```
GenericOutcome InitSDK();
```

### Valeur renvoyée
<a name="integration-server-sdk5-csharp-initsdk-return"></a>

En cas de succès, renvoie un InitSdkOutcome objet indiquant que le processus serveur est prêt à être appelé[ProcessReady()](#integration-server-sdk5-csharp-processready). 

### Exemple
<a name="integration-server-sdk5-csharp-initsdk-example"></a>

```
//Call InitSDK to establish a local connection with the GameLift agent to enable further communication.
GenericOutcome initSDKOutcome = GameLiftServerAPI.InitSDK();
```

## InitSDK()
<a name="integration-server-sdk5-csharp-initsdk-anywhere"></a>

Initialise le Amazon GameLift Servers SDK pour une flotte Anywhere. Appelez cette méthode au lancement, avant que toute autre initialisation associée ne se Amazon GameLift Servers produise. Cette méthode nécessite des paramètres de serveur explicites pour configurer la communication entre le serveur et le Amazon GameLift Servers service. Il utilise un jeton d'idempotencie, de sorte que vous pouvez réessayer cet appel en toute sécurité en cas d'échec.

### Syntaxe
<a name="integration-server-sdk5-csharp-initsdk-anywhere-syntax"></a>

```
GenericOutcome InitSDK(ServerParameters serverParameters);
```

### Parameters
<a name="integration-server-sdk5-csharp-initsdk-anywhere-parameter"></a>

[ServerParameters](integration-server-sdk5-csharp-datatypes.md#integration-server-sdk5-csharp-dataypes-serverparameters)  
Pour initialiser un serveur de jeu sur une flotte Amazon GameLift Servers Anywhere, créez un `ServerParameters` objet avec les informations suivantes :  
+ URL WebSocket utilisée pour vous connecter à votre serveur de jeu. 
+ ID du processus utilisé pour héberger votre serveur de jeu. 
+ L'ID de l'ordinateur hébergeant les processus de votre serveur de jeu. 
+ L'ID du Amazon GameLift Servers parc contenant votre ordinateur Amazon GameLift Servers Anywhere.
+ Le jeton d'autorisation généré par l'Amazon GameLift Serversopération. 

### Valeur renvoyée
<a name="integration-server-sdk5-csharp-initsdk-anywhere-return"></a>

En cas de succès, renvoie un InitSdkOutcome objet indiquant que le processus serveur est prêt à être appelé[ProcessReady()](#integration-server-sdk5-csharp-processready). 

**Note**  
Si les appels à échouent pour `InitSDK()` les builds de jeu déployés sur des flottes Anywhere, vérifiez le `ServerSdkVersion` paramètre utilisé lors de la création de la ressource de build. Vous devez définir explicitement cette valeur en fonction de la version du SDK du serveur utilisée. La valeur par défaut de ce paramètre est 4.x, ce qui n'est pas compatible. Pour résoudre ce problème, créez une nouvelle version et déployez-la sur une nouvelle flotte.

### Exemple
<a name="integration-server-sdk5-csharp-initsdk-anywhere-example"></a>

```
//Define the server parameters
string websocketUrl = "wss://us-west-1.api.amazongamelift.com";
string processId = "PID1234";
string fleetId = "aarn:aws:gamelift:us-west-1:111122223333:fleet/fleet-9999ffff-88ee-77dd-66cc-5555bbbb44aa";
string hostId = "HardwareAnywhere";
string authToken = "1111aaaa-22bb-33cc-44dd-5555eeee66ff";
ServerParameters serverParameters = 
  new ServerParameters(webSocketUrl, processId, hostId, fleetId, authToken);

//Call InitSDK to establish a local connection with the GameLift agent to enable further communication.
GenericOutcome initSDKOutcome = GameLiftServerAPI.InitSDK(serverParameters);
```

## ProcessReady()
<a name="integration-server-sdk5-csharp-processready"></a>

Amazon GameLift ServersIndique que le processus du serveur est prêt à héberger des sessions de jeu. Appelez cette méthode après l'avoir invoquée. [InitSDK()](#integration-server-sdk5-csharp-initsdk) Cette méthode ne doit être appelée qu'une seule fois par processus.

### Syntaxe
<a name="integration-server-sdk5-csharp-processready-syntax"></a>

```
GenericOutcome ProcessReady(ProcessParameters processParameters)
```

### Parameters
<a name="integration-server-sdk5-csharp-processready-parameter"></a>

**[ProcessParameters](integration-server-sdk5-csharp-datatypes.md#integration-server-sdk5-csharp-dataypes-process)**  
Un `ProcessParameters` objet contient des informations sur le processus du serveur.

### Valeur renvoyée
<a name="integration-server-sdk5-csharp-processready-return"></a>

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

### Exemple
<a name="integration-server-sdk5-csharp-processready-example"></a>

Cet exemple illustre à la fois les implémentations de méthodes et de fonctions déléguées.

```
// Set parameters and call ProcessReady
ProcessParameters processParams = new ProcessParameters(
  this.OnStartGameSession,
  this.OnProcessTerminate,
  this.OnHealthCheck,
  this.OnUpdateGameSession,
  port,
  new LogParameters(new List<string>()  
  // Examples of log and error files written by the game server
  {
    "C:\\game\\logs",
    "C:\\game\\error"
  })
);
GenericOutcome processReadyOutcome = GameLiftServerAPI.ProcessReady(processParams);
```

## ProcessEnding()
<a name="integration-server-sdk5-csharp-processending"></a>

Amazon GameLift ServersIndique que le processus du serveur est en train de se terminer. Appelez cette méthode après toutes les autres tâches de nettoyage (y compris la fermeture de la session de jeu active) et avant de terminer le processus. En fonction du résultat de`ProcessEnding()`, le processus se termine avec succès (0) ou erreur (-1) et génère un événement de flotte. Si le processus se termine par une erreur, l'événement de flotte généré est`SERVER_PROCESS_TERMINATED_UNHEALTHY`.

### Syntaxe
<a name="integration-server-sdk5-csharp-processending-syntax"></a>

```
GenericOutcome ProcessEnding()
```

### Valeur renvoyée
<a name="integration-server-sdk5-csharp-processending-return"></a>

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

### Exemple
<a name="integration-server-sdk5-csharp-processending-example"></a>

Cet exemple appelle `ProcessEnding()` et `Destroy()` avant de terminer le processus du serveur avec un code de sortie de réussite ou d'erreur.

```
GenericOutcome processEndingOutcome = GameLiftServerAPI.ProcessEnding();
GameLiftServerAPI.Destroy();

if (processEndingOutcome.Success)
  {
    Environment.Exit(0);
  }
else
  {
    Console.WriteLine("ProcessEnding() failed. Error: " + processEndingOutcome.Error.ToString());
    Environment.Exit(-1);  
  }
```

## ActivateGameSession()
<a name="integration-server-sdk5-csharp-activategamesession"></a>

Amazon GameLift ServersIndique que le processus du serveur a activé une session de jeu et qu'il est maintenant prêt à recevoir les connexions des joueurs. Cette action doit être appelée dans le cadre de la fonction de `onStartGameSession()` rappel, après toute initialisation de session de jeu.

### Syntaxe
<a name="integration-server-sdk5-csharp-activategamesession-syntax"></a>

```
GenericOutcome ActivateGameSession()
```

### Valeur renvoyée
<a name="integration-server-sdk5-csharp-activategamesession-return"></a>

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

### Exemple
<a name="integration-server-sdk5-csharp-activategamesession-example"></a>

Cet exemple illustre l'appel de `ActivateGameSession()` dans le cadre de la fonction déléguée `onStartGameSession()`. 

```
void OnStartGameSession(GameSession gameSession)
{
  // game-specific tasks when starting a new game session, such as loading map   
  // When ready to receive players   
  GenericOutcome activateGameSessionOutcome = GameLiftServerAPI.ActivateGameSession();
}
```

## UpdatePlayerSessionCreationPolicy()
<a name="integration-server-sdk5-csharp-updateplayersessioncreationpolicy"></a>

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.

### Syntaxe
<a name="integration-server-sdk5-csharp-updateplayersessioncreationpolicy-syntax"></a>

```
GenericOutcome UpdatePlayerSessionCreationPolicy(PlayerSessionCreationPolicy playerSessionPolicy)
```

### Parameters
<a name="integration-server-sdk5-csharp-updateplayersessioncreationpolicy-parameter"></a>

**playerSessionPolicy**  
Valeur de chaîne indiquant si la session de jeu accepte de nouveaux joueurs.   
Les valeurs valides sont les suivantes :  
+ **ACCEPT\$1ALL — Accepte toutes les** sessions de nouveaux joueurs.
+ **DENY\$1ALL — Refuse toutes les** sessions de nouveaux joueurs.

### Valeur renvoyée
<a name="integration-server-sdk5-csharp-updateplayersessioncreationpolicy-return"></a>

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

### Exemple
<a name="integration-server-sdk5-csharp-updateplayersessioncreationpolicy-example"></a>

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.

```
GenericOutcome updatePlayerSessionPolicyOutcome = 
  GameLiftServerAPI.UpdatePlayerSessionCreationPolicy(PlayerSessionCreationPolicy.ACCEPT_ALL);
```

## GetGameSessionId()
<a name="integration-server-sdk5-csharp-getgamesessionid"></a>

Récupère l'ID de la session de jeu hébergée par le processus serveur actif.

Pour les processus inactifs qui ne sont pas activés lors d'une session de jeu, l'appel renvoie un[GameLiftError](integration-server-sdk5-csharp-datatypes.md#integration-server-sdk5-csharp-datatypes-gamelifterror).

### Syntaxe
<a name="integration-server-sdk5-csharp-getgamesessionid-syntax"></a>

```
AwsStringOutcome GetGameSessionId()
```

### Valeur renvoyée
<a name="integration-server-sdk5-csharp-getgamesessionid-return"></a>

En cas de réussite, renvoie l'ID de session de jeu en tant qu'objet [AwsStringOutcome](integration-server-sdk5-csharp-datatypes.md#integration-server-sdk5-csharp-datatypes-awsstringoutcome). En cas d'échec, renvoie un message d'erreur. »

### Exemple
<a name="integration-server-sdk5-csharp-getgamesessionid-example"></a>

```
AwsStringOutcome getGameSessionIdOutcome = GameLiftServerAPI.GetGameSessionId();
```

## GetTerminationTime()
<a name="integration-server-sdk5-csharp-getterm"></a>

Renvoie l'heure d'arrêt planifiée pour un processus serveur, si une heure de résiliation est disponible. Un processus serveur exécute cette action après avoir reçu un `onProcessTerminate()` rappel deAmazon GameLift Servers. Amazon GameLift Serversappels `onProcessTerminate()` pour les raisons suivantes : 
+ Lorsque le processus du serveur a signalé un mauvais état de santé ou n'a pas réponduAmazon GameLift Servers.
+ Lorsque vous mettez fin à l'instance lors d'un événement de réduction.
+ Lorsqu'une instance est interrompue en raison d'une interruption [ponctuelle](spot-tasks.md).

### Syntaxe
<a name="integration-server-sdk5-csharp-getterm-syntax"></a>

```
AwsDateTimeOutcome GetTerminationTime()
```

### Valeur renvoyée
<a name="integration-server-sdk5-csharp-getterm-return"></a>

En cas de succès, renvoie l'heure de fin sous forme d'[AwsDateTimeOutcome](integration-server-sdk5-csharp-datatypes.md#integration-server-sdk5-csharp-datatypes-awsdatetimeoutcome)objet. La valeur est le délai de résiliation, 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 à celle `637355968000000000` des ticks. Si aucune heure de résiliation n'est disponible, renvoie un message d'erreur.

### Exemple
<a name="integration-server-sdk5-csharp-getterm-example"></a>

```
AwsDateTimeOutcome getTerminationTimeOutcome = GameLiftServerAPI.GetTerminationTime(); 
```

## AcceptPlayerSession()
<a name="integration-server-sdk5-csharp-acceptplayersession"></a>

Amazon GameLift ServersIndique qu'un joueur avec l'identifiant de session de joueur spécifié s'est connecté au processus du serveur et doit être validé. Amazon GameLift Serversvérifie que l'identifiant de session du joueur est valide. Une fois la session du joueur validée, le statut de l'emplacement du joueur Amazon GameLift Servers passe de RÉSERVÉ à ACTIF. 

### Syntaxe
<a name="integration-server-sdk5-csharp-acceptplayersession-syntax"></a>

```
GenericOutcome AcceptPlayerSession(String playerSessionId)
```

### Parameters
<a name="integration-server-sdk5-csharp-acceptplayersession-parameter"></a>

playerSessionId  
Identifiant unique émis GameLift lors de la création d'une nouvelle session de joueur.

### Valeur renvoyée
<a name="integration-server-sdk5-csharp-acceptplayersession-return"></a>

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

### Exemple
<a name="integration-server-sdk5-csharp-acceptplayersession-example"></a>

Cet exemple illustre une fonction permettant de gérer une demande de connexion, notamment de valider et de rejeter une session de joueur non valide. IDs 

```
void ReceiveConnectingPlayerSessionID (Connection connection, String playerSessionId)
{
  GenericOutcome acceptPlayerSessionOutcome = GameLiftServerAPI.AcceptPlayerSession(playerSessionId);
  if(acceptPlayerSessionOutcome.Success)
  {
    connectionToSessionMap.emplace(connection, playerSessionId);
    connection.Accept();
  }
  else 
  {
    connection.Reject(acceptPlayerSessionOutcome.Error.ErrorMessage);
  }       
}
```

## RemovePlayerSession()
<a name="integration-server-sdk5-csharp-removeplayersession"></a>

Indique Amazon GameLift Servers qu'un joueur s'est déconnecté du processus serveur. En réponse, Amazon GameLift Servers change l'emplacement du joueur pour le rendre disponible. 

### Syntaxe
<a name="integration-server-sdk5-csharp-removeplayersession-syntax"></a>

```
GenericOutcome RemovePlayerSession(String playerSessionId)
```

### Parameters
<a name="integration-server-sdk5-csharp-removeplayersession-parameter"></a>

**playerSessionId**  
Identifiant unique émis Amazon GameLift Servers lors de la création d'une nouvelle session de joueur.

### Valeur renvoyée
<a name="integration-server-sdk5-csharp-removeplayersession-return"></a>

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

### Exemple
<a name="integration-server-sdk5-csharp-removeplayersession-example"></a>

```
GenericOutcome removePlayerSessionOutcome = GameLiftServerAPI.RemovePlayerSession(playerSessionId);
```

## DescribePlayerSessions()
<a name="integration-server-sdk5-csharp-describeplayersessions"></a>

Récupère les données de session du joueur, notamment les paramètres, les métadonnées de session et les données du 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
<a name="integration-server-sdk5-csharp-describeplayersessions-syntax"></a>

```
DescribePlayerSessionsOutcome DescribePlayerSessions(DescribePlayerSessionsRequest describePlayerSessionsRequest)
```

### Parameters
<a name="integration-server-sdk5-csharp-describeplayersessions-parameter"></a>

**[DescribePlayerSessionsRequest](integration-server-sdk5-csharp-datatypes.md#integration-server-sdk5-csharp-dataypes-playersessions)**  
[DescribePlayerSessionsRequest](integration-server-sdk5-csharp-datatypes.md#integration-server-sdk5-csharp-dataypes-playersessions)Objet qui décrit les sessions de joueur à récupérer.

### Valeur renvoyée
<a name="integration-server-sdk5-csharp-describeplayersessions-return"></a>

En cas de succès, renvoie un [DescribePlayerSessionsOutcome](integration-server-sdk5-csharp-datatypes.md#integration-server-sdk5-csharp-datatypes-describeplayersessionsoutcome) objet contenant un ensemble d'objets de session de joueur correspondant aux paramètres de la demande.

### Exemple
<a name="integration-server-sdk5-csharp-describeplayersessions-example"></a>

Cet exemple illustre une demande de toutes les sessions de joueur activement connectées à une session de jeu spécifiée. En omettant *NextToken*et en définissant la valeur *limite* sur 10, les 10 premiers enregistrements de session de joueurs correspondant à la demande Amazon GameLift Servers seront renvoyés.

```
// Set request parameters 
DescribePlayerSessionsRequest describePlayerSessionsRequest = new DescribePlayerSessionsRequest()
{
  GameSessionId = GameLiftServerAPI.GetGameSessionId().Result,    //gets the ID for the current game session
  Limit = 10,
  PlayerSessionStatusFilter = 
    PlayerSessionStatusMapper.GetNameForPlayerSessionStatus(PlayerSessionStatus.ACTIVE)
}; 
// Call DescribePlayerSessions
DescribePlayerSessionsOutcome describePlayerSessionsOutcome = 
  GameLiftServerAPI.DescribePlayerSessions(describePlayerSessionsRequest);
```

## StartMatchBackfill()
<a name="integration-server-sdk5-csharp-startmatchbackfill"></a>

Envoie une demande de recherche de nouveaux joueurs pour des emplacements ouverts dans une session de jeu créée avec FlexMatch. Pour plus d'informations, voir la [fonction de FlexMatch remblayage](https://docs.aws.amazon.com/gameliftservers/latest/flexmatchguide/match-backfill.html).

Cette action est asynchrone. Si de nouveaux joueurs sont jumelés, Amazon GameLift Servers fournit des données de matchmaking mises à jour à l'aide de 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()](#integration-server-sdk5-csharp-stopmatchbackfill) pour annuler la requête d'origine.

### Syntaxe
<a name="integration-server-sdk5-csharp-startmatchbackfill-syntax"></a>

```
StartMatchBackfillOutcome StartMatchBackfill (StartMatchBackfillRequest startBackfillRequest);
```

### Parameters
<a name="integration-server-sdk5-csharp-startmatchbackfill-parameter"></a>

**[StartMatchBackfillRequest](integration-server-sdk5-csharp-datatypes.md#integration-server-sdk5-csharp-dataypes-startmatchbackfillrequest)**  
Un `StartMatchBackfillRequest` objet contient des informations relatives à la demande de remblayage.

### Valeur renvoyée
<a name="integration-server-sdk5-csharp-startmatchbackfill-return"></a>

Renvoie un [StartMatchBackfillOutcome](integration-server-sdk5-csharp-datatypes.md#integration-server-sdk5-csharp-datatypes-startmatchbackfilloutcome) objet avec l'identifiant du ticket de remplacement correspondant, ou un échec avec un message d'erreur. 

### Exemple
<a name="integration-server-sdk5-csharp-startmatchbackfill-example"></a>

```
// Build a backfill request
StartMatchBackfillRequest startBackfillRequest = new StartMatchBackfillRequest()
{
  TicketId = "1111aaaa-22bb-33cc-44dd-5555eeee66ff", //optional
  MatchmakingConfigurationArn = "arn:aws:gamelift:us-west-2:111122223333:matchmakingconfiguration/MyMatchmakerConfig", 
  GameSessionId = GameLiftServerAPI.GetGameSessionId().Result,    // gets ID for current game session
  MatchmakerData matchmakerData = 
    MatchmakerData.FromJson(gameSession.MatchmakerData),  // gets matchmaker data for current players
  // get matchmakerData.Players
  // remove data for players who are no longer connected
  Players = ListOfPlayersRemainingInTheGame
};

// Send backfill request
StartMatchBackfillOutcome startBackfillOutcome = GameLiftServerAPI.StartMatchBackfill(startBackfillRequest);

// Implement callback function for backfill
void OnUpdateGameSession(GameSession myGameSession)
{
  // game-specific tasks to prepare for the newly matched players and update matchmaker data as needed  
}
```

## StopMatchBackfill()
<a name="integration-server-sdk5-csharp-stopmatchbackfill"></a>

Annule une demande de remplacement de match active. Pour plus d'informations, voir la [fonction de FlexMatch remblayage](https://docs.aws.amazon.com/gameliftservers/latest/flexmatchguide/match-backfill.html).

### Syntaxe
<a name="integration-server-sdk5-csharp-stopmatchbackfill-syntax"></a>

```
GenericOutcome StopMatchBackfill (StopMatchBackfillRequest stopBackfillRequest);
```

### Parameters
<a name="integration-server-sdk5-csharp-stopmatchbackfill-parameter"></a>

**[StopMatchBackfillRequest](integration-server-sdk5-csharp-datatypes.md#integration-server-sdk5-csharp-dataypes-stopmatchbackfillrequest)**  
Un `StopMatchBackfillRequest` objet qui fournit des détails sur le ticket de matchmaking que vous êtes en train d'arrêter.

### Valeur renvoyée
<a name="integration-server-sdk5-csharp-stopmatchbackfill-return"></a>

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

### Exemple
<a name="integration-server-sdk5-csharp-stopmatchbackfill-example"></a>

```
// Set backfill stop request parameters
StopMatchBackfillRequest stopBackfillRequest = new StopMatchBackfillRequest(){
  TicketId = "1111aaaa-22bb-33cc-44dd-5555eeee66ff", //optional, if not provided one is autogenerated
  MatchmakingConfigurationArn = "arn:aws:gamelift:us-west-2:111122223333:matchmakingconfiguration/MyMatchmakerConfig",
  GameSessionId = GameLiftServerAPI.GetGameSessionId().Result    //gets the ID for the current game session
};
GenericOutcome stopBackfillOutcome = GameLiftServerAPI.StopMatchBackfillRequest(stopBackfillRequest);
```

## GetComputeCertificate()
<a name="integration-server-sdk5-csharp-getcomputecertificate"></a>

 Récupère le chemin d'accès au certificat TLS utilisé pour chiffrer la connexion réseau entre le serveur de jeu et votre client de jeu. Vous pouvez utiliser le chemin du certificat lorsque vous enregistrez votre appareil informatique dans un parc Amazon GameLift Servers Anywhere. Pour plus d'informations, voir, [RegisterCompute](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html).

### Syntaxe
<a name="integration-server-sdk5-csharp-getcomputecertificate-syntax"></a>

```
GetComputeCertificateOutcome GetComputeCertificate();
```

### Valeur renvoyée
<a name="integration-server-sdk5-csharp-getcomputecertificate-return"></a>

Renvoie un GetComputeCertificateResponse objet contenant les éléments suivants : 
+  CertificatePath: chemin d'accès au certificat TLS sur votre ressource de calcul. Lorsque vous utilisez une flotte Amazon GameLift Servers gérée, ce chemin contient :
  + `certificate.pem`: le certificat de l'utilisateur final. La chaîne de certificats complète est la combinaison des `certificateChain.pem` éléments ajoutés à ce certificat.
  + `certificateChain.pem`: chaîne de certificats qui contient le certificat racine et les certificats intermédiaires.
  + `rootCertificate.pem`: le certificat racine.
  + `privateKey.pem`: clé privée pour le certificat d'utilisateur final.
+ ComputeName: nom de votre ressource de calcul.

### Exemple
<a name="integration-server-sdk5-csharp-getcomputecertificate-example"></a>

```
GetComputeCertificateOutcome getComputeCertificateOutcome = GameLiftServerAPI.GetComputeCertificate();
```

## GetFleetRoleCredentials()
<a name="integration-server-sdk5-csharp-getfleetrolecredentials"></a>

Récupère les informations d'identification du rôle IAM qui autorisent l'interaction avec Amazon GameLift Servers d'autres utilisateurs. Services AWS Pour de plus amples informations, veuillez consulter [Connectez votre serveur de jeu Amazon GameLift Servers hébergé à d'autres AWS ressources](gamelift-sdk-server-resources.md).

### Syntaxe
<a name="integration-server-sdk5-csharp-getfleetrolecredentials-syntax"></a>

```
GetFleetRoleCredentialsOutcome GetFleetRoleCredentials(GetFleetRoleCredentialsRequest request);
```

### Parameters
<a name="integration-server-sdk5-csharp-getfleetrolecredentials-parameters"></a>

[GetFleetRoleCredentialsRequest](integration-server-sdk5-csharp-datatypes.md#integration-server-sdk5-csharp-dataypes-getfleetrolecredentialsrequest)  
Des informations d'identification de rôle qui étendent un accès limité à vos AWS ressources au serveur de jeu.

### Valeur renvoyée
<a name="integration-server-sdk5-csharp-getfleetrolecredentials-return"></a>

Renvoie un objet [GetFleetRoleCredentialsOutcome](integration-server-sdk5-csharp-datatypes.md#integration-server-sdk5-csharp-datatypes-getfleetrolecredentialsoutcome).

### Exemple
<a name="integration-server-sdk5-csharp-getfleetrolecredentials-example"></a>

```
// form the fleet credentials request  
GetFleetRoleCredentialsRequest getFleetRoleCredentialsRequest = new GetFleetRoleCredentialsRequest(){  
  RoleArn = "arn:aws:iam::123456789012:role/service-role/exampleGameLiftAction"  
};
GetFleetRoleCredentialsOutcome GetFleetRoleCredentialsOutcome credentials = GetFleetRoleCredentials(getFleetRoleCredentialsRequest);
```

## Détruire ()
<a name="integration-server-sdk5-csharp-destroy"></a>

Libère de la mémoire le SDK du serveur de Amazon GameLift Servers jeu. Il est recommandé d'appeler cette méthode après `ProcessEnding()` et avant de terminer le processus. Si vous utilisez une flotte Anywhere et que vous n'interrompez pas les processus du serveur après chaque session de jeu, appelez `Destroy()` puis `InitSDK()` réinitialisez avant de signaler Amazon GameLift Servers que le processus est prêt à héberger une session de jeu avec. `ProcessReady()`

### Syntaxe
<a name="integration-server-sdk5-csharp-destroy-syntax"></a>

```
GenericOutcome Destroy()
```

### Valeur renvoyée
<a name="integration-server-sdk5-csharp-destroy-return"></a>

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

### Exemple
<a name="integration-server-sdk5-csharp-destroy-example"></a>

```
// Operations to end game sessions and the server process
GenericOutcome processEndingOutcome = GameLiftServerAPI.ProcessEnding();

// Shut down and destroy the instance of the GameLift Game Server SDK
GenericOutcome destroyOutcome = GameLiftServerAPI.Destroy();

// Exit the process with success or failure
if (processEndingOutcome.Success)
  { 
    Environment.Exit(0); 
  }
else
  {
    Console.WriteLine("ProcessEnding() failed. Error: " + processEndingOutcome.Error.ToString());
    Environment.Exit(-1); 
  }
```

# SDK du serveur Go pour Amazon GameLift Servers -- Actions
<a name="integration-server-sdk-go-actions"></a>

Utilisez la référence du SDK 5.x du serveur pour intégrer votre jeu multijoueur à des fins d'hébergement. Amazon GameLift Servers Pour obtenir des conseils sur le processus d'intégration, consultez[Ajoutez Amazon GameLift Servers à votre serveur de jeu avec le SDK du serveur](gamelift-sdk-server-api.md).

`GameLiftServerAPI.go`définit les actions du SDK du serveur Go.

# SDK du serveur Go pour Amazon GameLift Servers -- Types de données
<a name="integration-server-sdk-go-datatypes"></a>

Utilisez la référence du SDK du serveur pour intégrer votre jeu multijoueur à des fins d'Amazon GameLift Servershébergement. Pour obtenir des conseils sur le processus d'intégration, consultez[Ajoutez Amazon GameLift Servers à votre serveur de jeu avec le SDK du serveur](gamelift-sdk-server-api.md).

`GameLiftServerAPI.go`définit les actions du SDK du serveur Go.

[SDK du serveur Go pour Amazon GameLift Servers -- Actions](integration-server-sdk-go-actions.md)

**Topics**
+ [LogParameters](#integration-server-sdk-go-dataypes-log)
+ [MetricsParameters](#integration-server-sdk-go-dataypes-metrics)
+ [ProcessParameters](#integration-server-sdk-go-dataypes-process)
+ [UpdateGameSession](#integration-server-sdk-go-dataypes-updategamesession)
+ [GameSession](#integration-server-sdk-go-dataypes-gamesession)
+ [ServerParameters](#integration-server-sdk-go-dataypes-serverparameters)
+ [StartMatchBackfillRequest](#integration-server-sdk-go-dataypes-startmatchbackfillrequest)
+ [Joueur](#integration-server-sdk-go-dataypes-player)
+ [DescribePlayerSessionsRequest](#integration-server-sdk-go-dataypes-playersessions)
+ [StopMatchBackfillRequest](#integration-server-sdk-go-dataypes-stopmatchbackfillrequest)
+ [GetFleetRoleCredentialsRequest](#integration-server-sdk-go-dataypes-getfleetrolecredentialsrequest)

## LogParameters
<a name="integration-server-sdk-go-dataypes-log"></a>

Objet identifiant les fichiers générés au cours d'une session de jeu que vous Amazon GameLift Servers souhaitez télécharger et stocker à la fin de la session de jeu. Le serveur de jeu fournit `LogParameters` to dans Amazon GameLift Servers le cadre d'un `ProcessParameters` objet lors d'un [ProcessReady()](integration-server-sdk-go-actions.md#integration-server-sdk-go-processready) appel.


|  |  | 
| --- |--- |
|  **Propriétés**  | Description | 
| LogPaths |  Liste des chemins de répertoire vers les fichiers journaux du serveur de jeu que vous Amazon GameLift Servers souhaitez stocker pour un accès futur. Le processus du serveur génère ces fichiers lors de chaque session de jeu. Vous définissez les chemins et les noms des fichiers sur votre serveur de jeu et vous les stockez dans le répertoire racine du jeu.  Les chemins du journal doivent être absolus. Par exemple, si votre build de jeu stocke les journaux de session de jeu dans un chemin tel que`MyGame\sessionLogs\`, alors le chemin se `c:\game\MyGame\sessionLogs` trouve sur une instance Windows. **Type :** `[]string` **Obligatoire** : non  | 

## MetricsParameters
<a name="integration-server-sdk-go-dataypes-metrics"></a>

Un objet communiquant les paramètres de configuration pour initialiser le système de métriques. Cette configuration est utilisée pour configurer les rapports StatsD, les rapports de crash et le comportement de traitement des métriques. Le serveur de jeu le fournit `MetricsParameters` dans Amazon GameLift Servers le cadre d'un [InitMetrics()](integration-server-sdk-go-actions.md#integration-server-sdk-go-initmetrics) appel.


|  |  | 
| --- |--- |
|  **Propriétés**  | Description | 
| StatsdHost |  L'hôte du serveur StatsD pour les rapports de mesures (par exemple, « localhost »). **Type :** `string` **Obligatoire** : oui  | 
| StatsdPort |  Le port du serveur StatsD pour les rapports de mesures (par exemple, 8125). **Type :** `int` **Obligatoire** : oui  | 
| CrashReporterHost |  L'hébergeur responsable du suivi des accidents et de la surveillance des processus. **Type :** `string` **Obligatoire** : oui  | 
| CrashReporterPort |  Le port Crash Reporter pour le suivi des incidents et la surveillance des processus. **Type :** `int` **Obligatoire** : oui  | 
| FlushIntervalMs |  Intervalle de vidange des métriques en millisecondes. Contrôle la fréquence à laquelle les métriques sont envoyées à StatsD. **Type :** `int` **Obligatoire** : oui  | 
| MaxPacketSize |  Taille de paquet maximale pour les métriques en octets. Limite la taille des paquets UDP envoyés à StatsD. **Type :** `int` **Obligatoire** : oui  | 

## ProcessParameters
<a name="integration-server-sdk-go-dataypes-process"></a>

Objet décrivant la communication entre un processus serveur etAmazon GameLift Servers. Le processus du serveur fournit ces informations à l'Amazon GameLift Serversaide d'un appel à[ProcessReady()](integration-server-sdk-go-actions.md#integration-server-sdk-go-processready).


|  |  | 
| --- |--- |
|  **Propriétés**  | Description | 
| LogParameters | Objet avec des chemins de répertoire vers des fichiers générés au cours d'une session de jeu. Amazon GameLift Serverscopie et stocke les fichiers pour un accès futur.**Type :** `LogParameters`**Obligatoire** : non | 
| OnHealthCheck | La fonction de rappel qui Amazon GameLift Servers appelle le processus du serveur pour demander un rapport d'état de santé. Amazon GameLift Serversappelle cette fonction toutes les 60 secondes et attend une réponse pendant 60 secondes. Le processus du serveur revient TRUE s'il est sain, FALSE sinon sain. Si aucune réponse n'est renvoyée, Amazon GameLift Servers enregistre le processus du serveur comme non sain.**Type :** `OnHealthCheck func() bool`**Obligatoire** : non | 
| OnProcessTerminate | La fonction de rappel qui Amazon GameLift Servers invoque pour forcer l'arrêt du processus du serveur. Après avoir appelé cette fonction, Amazon GameLift Servers attendez 5 minutes que le processus serveur s'arrête et répondez par un [ProcessEnding()](integration-server-sdk-go-actions.md#integration-server-sdk-go-processending) appel avant d'arrêter le processus serveur.**Type :** `OnProcessTerminate func()`**Obligatoire** : oui | 
| OnStartGameSession | La fonction de rappel qui Amazon GameLift Servers appelle pour transmettre un objet de session de jeu mis à jour au processus du serveur. Amazon GameLift Serversappelle cette fonction lorsqu'une demande de remplissage de correspondances a été traitée pour fournir des données de matchmaking mises à jour. Il transmet un [GameSession](#integration-server-sdk-go-dataypes-gamesession) objet, une mise à jour de statut (updateReason) et l'identifiant du ticket de remplacement des matchs.**Type :** `OnStartGameSession func (model.GameSession )`**Obligatoire** : oui | 
| OnUpdateGameSession | La fonction de rappel qui demande de Amazon GameLift Servers transmettre les informations de session de jeu mises à jour au processus du serveur. Amazon GameLift Serversappelle cette fonction après avoir traité une demande de remplissage de correspondance pour fournir des données de matchmaking mises à jour. **Type :** `OnUpdateGameSession func (model.UpdateGameSession)`**Obligatoire** : non | 
| Port | Numéro de port sur lequel le processus serveur écoute les connexions des nouveaux joueurs. La valeur doit être comprise dans la plage de ports configurée pour toutes les flottes déployant cette version de génération du serveur de jeux. Ce numéro de port est inclus dans les objets de session de jeu et de session de joueur, que les sessions de jeu utilisent pour se connecter à un processus serveur.**Type :** `int`**Obligatoire** : oui | 

## UpdateGameSession
<a name="integration-server-sdk-go-dataypes-updategamesession"></a>

Les mises à jour apportées à un objet de session de jeu, y compris la raison pour laquelle la session de jeu a été mise à jour et l'identifiant du ticket de remplissage associé si le remplissage est utilisé pour remplir les sessions des joueurs pendant la session de jeu.


| Propriétés | **Description** | 
| --- | --- | 
| GameSession | Un objet [GameSession](#integration-server-sdk-go-dataypes-gamesession). L'GameSessionobjet contient des propriétés décrivant une session de jeu. **Type :** `GameSession GameSession()`**Obligatoire** : oui | 
| UpdateReason | La raison pour laquelle la session de jeu est mise à jour.**Type :** `UpdateReason UpdateReason()`**Obligatoire** : oui | 
| BackfillTicketId | L'identifiant du ticket de remplacement qui tente de mettre à jour la session de jeu.**Type :** `String`**Obligatoire** : non | 

## GameSession
<a name="integration-server-sdk-go-dataypes-gamesession"></a>

Les détails d'une session de jeu. 


| Propriétés | **Description** | 
| --- | --- | 
| GameSessionId |  Identifiant unique pour la session de jeu. Une session de jeu Amazon Resource Name (ARN) a le format suivant :`arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>`. **Type :** `String` **Obligatoire** : non  | 
| Nom |  Une étiquette descriptive de la session de jeu.  **Type :** `String` **Obligatoire** : non  | 
| FleetId |  Identifiant unique de la flotte sur laquelle s'exécute la session de jeu. **Type :** `String` **Obligatoire** : non  | 
| MaximumPlayerSessionCount |  Le nombre maximum de connexions de joueurs à la session de jeu. **Type :** `Integer` **Obligatoire** : non  | 
|  Port |  Le numéro de port de la session de jeu. Pour se connecter à un serveur de Amazon GameLift Servers jeu, une application a besoin à la fois de l'adresse IP et du numéro de port. **Type :** `Integer` **Obligatoire** : non  | 
| IpAddress |  Adresse IP de la session de jeu. Pour se connecter à un serveur de Amazon GameLift Servers jeu, une application a besoin à la fois de l'adresse IP et du numéro de port. **Type :** `String` **Obligatoire** : non  | 
| GameSessionData |  Ensemble de propriétés de session de jeu personnalisées, mises en forme en tant que valeur de chaîne unique.  **Type :** `String` **Obligatoire** : non  | 
| MatchmakerData |  Les informations sur le processus de matchmaking utilisé pour créer la session de jeu, en syntaxe JSON, formatées sous forme de chaîne. En plus de la configuration de matchmaking utilisée, il contient des données sur tous les joueurs affectés au match, y compris les attributs des joueurs et les affectations des équipes. **Type :** `String` **Obligatoire** : non  | 
| GameProperties |  Ensemble de propriétés personnalisées pour une session de jeu, formatées sous forme de paires clé:valeur. Ces propriétés sont transmises avec une demande de démarrage d'une nouvelle session de jeu. **Type :** `map[string] string` **Obligatoire** : non  | 
| DnsName |  Identifiant DNS attribué à l'instance qui exécute la session de jeu. Les valeurs ont le format suivant : [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/gameliftservers/latest/developerguide/integration-server-sdk-go-datatypes.html) Lorsque vous vous connectez à une session de jeu exécutée sur une flotte compatible TLS, vous devez utiliser le nom DNS et non l'adresse IP. **Type :** `String` **Obligatoire** : non  | 

## ServerParameters
<a name="integration-server-sdk-go-dataypes-serverparameters"></a>

Informations utilisées pour maintenir la connexion entre un serveur Amazon GameLift Servers Anywhere et le Amazon GameLift Servers service. Ces informations sont utilisées lors du lancement de nouveaux processus serveur avec[InitSDK()](integration-server-sdk-go-actions.md#integration-server-sdk-go-initsdk). Pour les serveurs hébergés sur des instances EC2 Amazon GameLift Servers gérées, utilisez un objet vide.


| Propriétés | **Description** | 
| --- | --- | 
| WebSocketURL |  Les `GameLiftServerSdkEndpoint` Amazon GameLift Servers retours lorsque vous [https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html)recherchez une ressource de calcul Amazon GameLift Servers Anywhere. **Type :** `string` **Obligatoire** : oui  | 
| ProcessID |  Un identifiant unique enregistré auprès du processus serveur hébergeant votre jeu. **Type :** `string` **Obligatoire** : oui  | 
| HostID |  Identifiant unique de la ressource de calcul hébergeant le nouveau processus du serveur.  Le `HostID` est celui `ComputeName` utilisé lorsque vous avez enregistré votre ordinateur. Pour de plus amples informations, veuillez consulter [RegisterCompute](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html). **Type :** `string` **Obligatoire** : oui  | 
| FleetID | Identifiant unique de la flotte dans laquelle le calcul est enregistré. Pour de plus amples informations, veuillez consulter [RegisterCompute](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html).**Type :** `string`**Obligatoire** : oui | 
| AuthToken | Le jeton d'authentification généré par Amazon GameLift Servers celui-ci authentifie votre serveur auprès deAmazon GameLift Servers. Pour de plus amples informations, veuillez consulter [GetComputeAuthToken](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_GetComputeAuthToken.html).**Type :** `string`**Obligatoire** : oui | 

## StartMatchBackfillRequest
<a name="integration-server-sdk-go-dataypes-startmatchbackfillrequest"></a>

Informations utilisées pour créer une demande de remplissage par matchmaking. Le serveur de jeu communique ces informations Amazon GameLift Servers lors d'un [StartMatchBackfill()](integration-server-sdk-go-actions.md#integration-server-sdk-go-startmatchbackfill) appel.


| Propriétés | **Description** | 
| --- | --- | 
| GameSessionArn |  L'identifiant unique de session de jeu. L'opération API `[GetGameSessionId](https://docs.aws.amazon.com/gameliftservers/latest/developerguide/integration-server-sdk-go-actions.html#integration-server-sdk-go-getgamesessionid)` renvoie l'identifiant au format ARN. **Type :** `String` **Obligatoire** : oui  | 
| MatchmakingConfigurationArn |  L'identifiant unique (sous la forme d'un ARN) que le système de jumelage doit utiliser pour cette demande. L'ARN de matchmaking pour la session de jeu d'origine se trouve dans l'objet de session de jeu dans la propriété de données du matchmaker. Pour plus d'informations sur les données du système de jumelage, consultez la section Utilisation des données du système de [jumelage.](https://docs.aws.amazon.com/gameliftservers/latest/flexmatchguide/match-server.html#match-server-data.html) **Type :** `String` **Obligatoire** : oui  | 
| Joueurs |  Ensemble de données représentant tous les joueurs qui participent actuellement à la session de jeu. Le matchmaker utilise ces informations pour rechercher de nouveaux joueurs qui constituent de bonnes correspondances pour les joueurs actuels. **Type :** `[]model.Player` **Obligatoire** : oui  | 
| TicketId |  L'identifiant unique d'un ticket de demande de matchmaking ou de remplacement de match. Si vous ne fournissez aucune valeur, il en Amazon GameLift Servers génère une. Utilisez cet identifiant pour suivre l'état du ticket de renvoi de correspondance ou annuler la requête si nécessaire.  **Type :** `String` **Obligatoire** : non  | 

## Joueur
<a name="integration-server-sdk-go-dataypes-player"></a>

L'objet qui représente un joueur dans le matchmaking. Lorsqu'une demande de matchmaking démarre, un joueur dispose d'un identifiant de joueur, d'attributs et éventuellement de données de latence. Amazon GameLift Serversajoute des informations sur l'équipe après la fin d'un match.


| Propriétés | **Description** | 
| --- | --- | 
| LatencyInMS |  Ensemble de valeurs exprimées en millisecondes qui indiquent le niveau de latence ressenti par un joueur lorsqu'il est connecté à un lieu.  Si cette propriété est utilisée, le joueur n'est jumelé qu'aux emplacements répertoriés. Si un matchmaker dispose d'une règle qui évalue la latence, les joueurs doivent indiquer la latence pour être mis en relation. **Type :** `map[string] int` **Obligatoire** : non  | 
| PlayerAttributes |  Une collection de paires clé:valeur contenant des informations sur les joueurs à utiliser dans le matchmaking. Les clés d'attribut du joueur doivent correspondre à PlayerAttributes celles utilisées dans un ensemble de règles de matchmaking. Pour plus d'informations sur les attributs des joueurs, consultez [AttributeValue](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_AttributeValue.html). **Type :** `map[string] AttributeValue` **Obligatoire** : non  | 
| PlayerId |  Identifiant unique pour un joueur. **Type :** `String` **Obligatoire** : non  | 
| Team |  Le nom de l'équipe à laquelle le joueur est affecté lors d'un match. Vous définissez le nom de l'équipe dans le jeu de règles de matchmaking. **Type :** `String` **Obligatoire** : non  | 

## DescribePlayerSessionsRequest
<a name="integration-server-sdk-go-dataypes-playersessions"></a>

Objet qui indique les sessions de joueur à récupérer. Le processus du serveur fournit ces informations en [DescribePlayerSessions()](integration-server-sdk-go-actions.md#integration-server-sdk-go-describeplayersessions) appelantAmazon GameLift Servers.


| Propriétés | **Description** | 
| --- | --- | 
| GameSessionID |  Un identifiant de session de jeu unique. Utilisez ce paramètre pour demander toutes les sessions de joueur pour la session de jeu spécifiée.  Le format de l'identifiant de session de jeu est`arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>`. `GameSessionID`Il s'agit d'une chaîne d'identification personnalisée ou d'une chaîne générée.  **Type :** `String` **Obligatoire** : non  | 
| PlayerSessionID |  Identifiant unique d'une session de joueur. Utilisez ce paramètre pour demander une session de joueur spécifique. **Type :** `String` **Obligatoire** : non  | 
| PlayerID |  L'identifiant unique d'un joueur. Utilisez ce paramètre pour demander toutes les sessions de joueur pour un joueur spécifique. Consultez [Générer un joueur IDs](player-sessions-player-identifiers.md). **Type :** `String` **Obligatoire** : non  | 
| PlayerSessionStatusFilter |  État de la session du joueur sur lequel filtrer les résultats. Les statuts de session de joueur possibles incluent : [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/gameliftservers/latest/developerguide/integration-server-sdk-go-datatypes.html) **Type :** `String` **Obligatoire** : non  | 
| NextToken |  Le jeton indiquant le début de la page de résultats suivante. Pour spécifier le début du jeu de résultats, ne fournissez aucune valeur. Si vous fournissez un identifiant de session de joueur, ce paramètre est ignoré. **Type :** `String` **Obligatoire** : non  | 
| Limit |  Nombre maximal de résultats à renvoyer. Si vous fournissez un identifiant de session de joueur, ce paramètre est ignoré. **Type :** `int` **Obligatoire** : non  | 

## StopMatchBackfillRequest
<a name="integration-server-sdk-go-dataypes-stopmatchbackfillrequest"></a>

Informations utilisées pour annuler une demande de remplissage par matchmaking. Le serveur de jeu communique ces informations au Amazon GameLift Servers service lors d'un [StopMatchBackfill()](integration-server-sdk-go-actions.md#integration-server-sdk-go-stopmatchbackfill) appel.


| Propriétés | **Description** | 
| --- | --- | 
| GameSessionArn |  Identifiant de session de jeu unique de la demande annulée. **Type :** `string` **Obligatoire** : non  | 
| MatchmakingConfigurationArn |  L'identifiant unique du matchmaker auquel cette demande a été envoyée. **Type :** `string` **Obligatoire** : non  | 
| TicketId |  L'identifiant unique du ticket de demande de remblayage à annuler. **Type :** `string` **Obligatoire** : non  | 

## GetFleetRoleCredentialsRequest
<a name="integration-server-sdk-go-dataypes-getfleetrolecredentialsrequest"></a>

Les informations d'identification du rôle qui étendent l'accès limité à vos AWS ressources au serveur de jeu. Pour plus d'informations, voir,[Configurer un rôle de service IAM pour Amazon GameLift Servers](setting-up-role.md).


| Propriétés | **Description** | 
| --- | --- | 
| RoleArn | L'ARN du rôle de service qui étend un accès limité à vos AWS ressources.**Type :** `string`**Obligatoire** : oui | 
| RoleSessionName | Le nom de la session qui décrit l'utilisation des informations d'identification du rôle.**Type :** `string`**Obligatoire** : oui | 

[SDK du serveur Go pour Amazon GameLift Servers -- Types de données](integration-server-sdk-go-datatypes.md)

**Topics**
+ [SDK du serveur Go pour Amazon GameLift Servers -- Types de données](integration-server-sdk-go-datatypes.md)
+ [GetSdkVersion()](#integration-server-sdk-go-getsdkversion)
+ [InitMetrics()](#integration-server-sdk-go-initmetrics)
+ [InitMetricsFromEnvironment()](#integration-server-sdk-go-initmetricsfromenv)
+ [InitSDK()](#integration-server-sdk-go-initsdk)
+ [ProcessReady()](#integration-server-sdk-go-processready)
+ [ProcessEnding()](#integration-server-sdk-go-processending)
+ [ActivateGameSession()](#integration-server-sdk-go-activategamesession)
+ [UpdatePlayerSessionCreationPolicy()](#integration-server-sdk-go-updateplayersessioncreationpolicy)
+ [GetGameSessionId()](#integration-server-sdk-go-getgamesessionid)
+ [GetTerminationTime()](#integration-server-sdk-go-getterm)
+ [AcceptPlayerSession()](#integration-server-sdk-go-acceptplayersession)
+ [RemovePlayerSession()](#integration-server-sdk-go-removeplayersession)
+ [DescribePlayerSessions()](#integration-server-sdk-go-describeplayersessions)
+ [StartMatchBackfill()](#integration-server-sdk-go-startmatchbackfill)
+ [StopMatchBackfill()](#integration-server-sdk-go-stopmatchbackfill)
+ [GetComputeCertificate()](#integration-server-sdk-go-getcomputecertificate)
+ [GetFleetRoleCredentials()](#integration-server-sdk-go-getfleetrolecredentials)
+ [Détruire ()](#integration-server-sdk-go-destroy)

## GetSdkVersion()
<a name="integration-server-sdk-go-getsdkversion"></a>

Renvoie le numéro de version actuel du kit SDK intégré dans le processus serveur.

### Syntaxe
<a name="integration-server-sdk-go-getsdkversion-syntax"></a>

```
func GetSdkVersion() (string, error)
```

### Valeur renvoyée
<a name="integration-server-sdk-go-getsdkversion-return"></a>

En cas de succès, renvoie la version actuelle du SDK sous forme de chaîne. La chaîne renvoyée inclut le numéro de version (exemple`5.0.0`). En cas d'échec, renvoie un message d'erreur tel que`common.SdkVersionDetectionFailed`.

### Exemple
<a name="integration-server-sdk-go-getsdkversion-example"></a>

```
version, err := server.GetSdkVersion()
```

## InitMetrics()
<a name="integration-server-sdk-go-initmetrics"></a>

Initialise la collecte de métriques pour le Amazon GameLift Servers SDK. Cette méthode permet de configurer des rapports de mesures pour aider à surveiller les performances et l'état du serveur. Appelez cette méthode après [InitSDK()](#integration-server-sdk-go-initsdk) mais avant[ProcessReady()](#integration-server-sdk-go-processready).

### Syntaxe
<a name="integration-server-sdk-go-initmetrics-syntax"></a>

```
func InitMetrics() error
func InitMetrics(metricsParameters MetricsParameters) error
```

### Parameters
<a name="integration-server-sdk-go-initmetrics-parameter"></a>

MetricsParameters (facultatif)  
Un `MetricsParameters` objet qui configure la collecte de métriques. Si elle n'est pas fournie, la configuration des métriques par défaut est utilisée. La MetricsParameters structure contient les champs suivants :  
+ `StatsdHost`- Le nom d'hôte ou l'adresse IP du serveur StatsD.
+ `StatsdPort`- Le numéro de port du serveur StatsD.
+ `CrashReporterHost`- Le nom d'hôte ou l'adresse IP du service Crash Reporter.
+ `CrashReporterPort`- Le numéro de port du service Crash Reporter.
+ `FlushIntervalMs`- Intervalle en millisecondes pour le vidage des données métriques.
+ `MaxPacketSize`- La taille maximale des paquets de métriques en octets.
Pour plus d'informations sur la MetricsParameters structure, consultez le [SDK de serveur 5.x pour les types de données C\$1.](https://docs.aws.amazon.com/gameliftservers/latest/developerguide/integration-server-sdk5-csharp-datatypes.html)

### Valeur renvoyée
<a name="integration-server-sdk-go-initmetrics-return"></a>

En cas de succès, renvoie `nil` une erreur indiquant que la collecte des métriques a été initialisée avec succès.

### Exemple
<a name="integration-server-sdk-go-initmetrics-example"></a>

Initialisez les métriques avec la configuration par défaut :

```
err := server.InitMetrics()
```

Initialisez les métriques avec une configuration personnalisée :

```
metricsParams := MetricsParameters{
    StatsdHost:        "localhost",
    StatsdPort:        8125,
    CrashReporterHost: "localhost",
    CrashReporterPort: 9125,
    FlushIntervalMs:   5000,
    MaxPacketSize:     1024,
}

err := server.InitMetrics(metricsParams)
```

## InitMetricsFromEnvironment()
<a name="integration-server-sdk-go-initmetricsfromenv"></a>

Initialise la collecte de métriques pour le Amazon GameLift Servers SDK à l'aide de la configuration à partir de variables d'environnement. Cette méthode configure le reporting des métriques à l'aide des paramètres par défaut dérivés de l'environnement d'exécution.

Appelez cette méthode après [InitSDK()](#integration-server-sdk-go-initsdk) mais avant[ProcessReady()](#integration-server-sdk-go-processready).

### Syntaxe
<a name="integration-server-sdk-go-initmetricsfromenv-syntax"></a>

```
func InitMetricsFromEnvironment() error
```

### Valeur renvoyée
<a name="integration-server-sdk-go-initmetricsfromenv-return"></a>

En cas de succès, renvoie `nil` une erreur indiquant que la collecte des métriques a été initialisée avec succès à l'aide de la configuration de l'environnement.

### Exemple
<a name="integration-server-sdk-go-initmetricsfromenv-example"></a>

```
err := server.InitMetricsFromEnvironment()
```

## InitSDK()
<a name="integration-server-sdk-go-initsdk"></a>

Initialise le kit SDK Amazon GameLift Servers. Appelez cette méthode au lancement avant que toute autre initialisation associée ne se Amazon GameLift Servers produise. Cette méthode permet de configurer la communication entre le serveur et le Amazon GameLift Servers service.

### Syntaxe
<a name="integration-server-sdk-go-initsdk-syntax"></a>

```
func InitSDK(params ServerParameters) error 
```

### Parameters
<a name="integration-server-sdk-go-initsdk-parameter"></a>

[ServerParameters](integration-server-sdk-go-datatypes.md#integration-server-sdk-go-dataypes-serverparameters)  
Pour initialiser un serveur de jeu sur une flotte Amazon GameLift Servers Anywhere, créez un `ServerParameters` objet avec les informations suivantes :  
+ URL de l'URL WebSocket utilisée pour se connecter à votre serveur de jeu. 
+ ID du processus utilisé pour héberger votre serveur de jeu. 
+ L'ID de l'ordinateur hébergeant les processus de votre serveur de jeu. 
+ L'ID du Amazon GameLift Servers parc contenant votre ordinateur Amazon GameLift Servers Anywhere.
+ Le jeton d'autorisation généré par l'Amazon GameLift Serversopération. 
Pour initialiser un serveur de jeu sur une flotte EC2 Amazon GameLift Servers gérée, créez un `ServerParameters` objet sans paramètres. Avec cet appel, l'Amazon GameLift Serversagent configure l'environnement informatique et se connecte automatiquement au Amazon GameLift Servers service pour vous. 

### Valeur renvoyée
<a name="integration-server-sdk-go-initsdk-return"></a>

En cas de succès, renvoie `nil` une erreur indiquant que le processus serveur est prêt à être appelé[ProcessReady()](#integration-server-sdk-go-processready). 

**Note**  
Si les appels à échouent pour `InitSDK()` les builds de jeu déployés sur des flottes Anywhere, vérifiez le `ServerSdkVersion` paramètre utilisé lors de la création de la ressource de build. Vous devez définir explicitement cette valeur en fonction de la version du SDK du serveur utilisée. La valeur par défaut de ce paramètre est 4.x, ce qui n'est pas compatible. Pour résoudre ce problème, créez une nouvelle version et déployez-la sur une nouvelle flotte.

### Exemple
<a name="integration-server-sdk-go-initsdk-example"></a>

Amazon GameLift ServersExemple n'importe où

```
//Define the server parameters
serverParameters := ServerParameters {
  WebSocketURL: "wss://us-west-1.api.amazongamelift.com",
  ProcessID: "PID1234",
  HostID: "HardwareAnywhere",
  FleetID: "aarn:aws:gamelift:us-west-1:111122223333:fleet/fleet-9999ffff-88ee-77dd-66cc-5555bbbb44aa",
  AuthToken: "1111aaaa-22bb-33cc-44dd-5555eeee66ff"
}

//Call InitSDK to establish a local connection with the Amazon GameLift Servers Agent to enable further communication.
err := server.InitSDK(serverParameters)
```

Amazon GameLift Serversexemple EC2 géré

```
//Define the server parameters
serverParameters := ServerParameters {}

//Call InitSDK to establish a local connection with the Amazon GameLift Servers Agent to enable further communication.
err := server.InitSDK(serverParameters)
```

## ProcessReady()
<a name="integration-server-sdk-go-processready"></a>

Amazon GameLift ServersIndique que le processus du serveur est prêt à héberger des sessions de jeu. Appelez cette méthode après l'avoir invoquée. [InitSDK()](#integration-server-sdk-go-initsdk) Cette méthode ne doit être appelée qu'une seule fois par processus.

### Syntaxe
<a name="integration-server-sdk-go-processready-syntax"></a>

```
func ProcessReady(param ProcessParameters) error
```

### Parameters
<a name="integration-server-sdk-go-processready-parameter"></a>

**ProcessParameters**  
Un [ProcessParameters](integration-server-sdk-go-datatypes.md#integration-server-sdk-go-dataypes-process) objet communique les informations suivantes concernant le processus du serveur :  
+ Les noms des méthodes de rappel implémentées dans le code du serveur de jeu invoqué par le Amazon GameLift Servers service pour communiquer avec le processus du serveur.
+ Numéro de port sur lequel le processus serveur est en train d'écouter.
+ Type de [LogParameters](integration-server-sdk-go-datatypes.md#integration-server-sdk-go-dataypes-log) données contenant le chemin d'accès à tous les fichiers spécifiques à une session de jeu que vous souhaitez capturer et Amazon GameLift Servers stocker.

### Valeur renvoyée
<a name="integration-server-sdk-go-processready-return"></a>

Renvoie une erreur accompagnée d'un message d'erreur en cas d'échec de la méthode. Renvoie `nil` si la méthode est réussie.

### Exemple
<a name="integration-server-sdk-go-processready-example"></a>

Cet exemple illustre les implémentations de l'appel [ProcessReady()](#integration-server-sdk-go-processready) et de la fonction déléguée.

```
// Define the process parameters
processParams := ProcessParameters {
  OnStartGameSession: gameProcess.OnStartGameSession,
  OnUpdateGameSession: gameProcess.OnGameSessionUpdate,
  OnProcessTerminate: gameProcess.OnProcessTerminate,
  OnHealthCheck: gameProcess.OnHealthCheck,
  Port: port,
  LogParameters: LogParameters {    // logging and error example
    []string {"C:\\game\\logs", "C:\\game\\error"}
  }
}

err := server.ProcessReady(processParams)
```

## ProcessEnding()
<a name="integration-server-sdk-go-processending"></a>

Amazon GameLift ServersIndique que le processus du serveur est en train de se terminer. Appelez cette méthode après toutes les autres tâches de nettoyage (y compris la fermeture de la session de jeu active) et avant de terminer le processus. En fonction du résultat de`ProcessEnding()`, le processus se termine avec succès (0) ou erreur (-1) et génère un événement de flotte. Si le processus se termine par une erreur, l'événement de flotte généré est`SERVER_PROCESS_TERMINATED_UNHEALTHY`.

### Syntaxe
<a name="integration-server-sdk-go-processending-syntax"></a>

```
func ProcessEnding() error
```

### Valeur renvoyée
<a name="integration-server-sdk-go-processending-return"></a>

Renvoie un code d'erreur 0 ou un code d'erreur défini.

### Exemple
<a name="integration-server-sdk-go-processending-example"></a>

```
// operations to end game sessions and the server process
defer func() {
  err := server.ProcessEnding()
  server.Destroy()
  if err != nil {
    fmt.Println("ProcessEnding() failed. Error: ", err)
    os.Exit(-1)
  } else {
    os.Exit(0)
  }
}
```

## ActivateGameSession()
<a name="integration-server-sdk-go-activategamesession"></a>

Amazon GameLift ServersIndique que le processus du serveur a activé une session de jeu et qu'il est maintenant prêt à recevoir les connexions des joueurs. Cette action est appelée dans le cadre de la fonction de `onStartGameSession()` rappel, après toute initialisation de session de jeu.

### Syntaxe
<a name="integration-server-sdk-go-activategamesession-syntax"></a>

```
func ActivateGameSession() error
```

### Valeur renvoyée
<a name="integration-server-sdk-go-activategamesession-return"></a>

Renvoie une erreur accompagnée d'un message d'erreur en cas d'échec de la méthode.

### Exemple
<a name="integration-server-sdk-go-activategamesession-example"></a>

Cet exemple montre l'`ActivateGameSession()`appel dans le cadre de la fonction de `onStartGameSession()` délégation. 

```
func OnStartGameSession(GameSession gameSession) {
  // game-specific tasks when starting a new game session, such as loading map   
  // Activate when ready to receive players   
  err := server.ActivateGameSession();
}
```

## UpdatePlayerSessionCreationPolicy()
<a name="integration-server-sdk-go-updateplayersessioncreationpolicy"></a>

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.

### Syntaxe
<a name="integration-server-sdk-go-updateplayersessioncreationpolicy-syntax"></a>

```
func UpdatePlayerSessionCreationPolicy(policy model.PlayerSessionCreationPolicy) error
```

### Parameters
<a name="integration-server-sdk-go-updateplayersessioncreationpolicy-parameter"></a>

**playerSessionCreationPolitique**  
Valeur de chaîne indiquant si la session de jeu accepte de nouveaux joueurs.   
Les valeurs valides sont les suivantes :  
+ **`model.AcceptAll`**— Acceptez toutes les sessions pour nouveaux joueurs.
+ **`model.DenyAll`**— Refusez toutes les sessions pour les nouveaux joueurs.

### Valeur renvoyée
<a name="integration-server-sdk-go-updateplayersessioncreationpolicy-return"></a>

Renvoie une erreur avec un message d'erreur en cas d'échec.

### Exemple
<a name="integration-server-sdk-go-updateplayersessioncreationpolicy-example"></a>

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.

```
err := server.UpdatePlayerSessionCreationPolicy(model.AcceptAll)
```

## GetGameSessionId()
<a name="integration-server-sdk-go-getgamesessionid"></a>

Récupère l'ID de la session de jeu hébergée par le processus serveur actif.

### Syntaxe
<a name="integration-server-sdk-go-getgamesessionid-syntax"></a>

```
func GetGameSessionID() (string, error)
```

### Parameters
<a name="integration-server-sdk-go-getgamesessionid-parameter"></a>

Cette action n'a aucun paramètre.

### Valeur renvoyée
<a name="integration-server-sdk-go-getgamesessionid-return"></a>

En cas de succès, renvoie l'identifiant de session de jeu et aucune erreur. Pour les processus inactifs qui ne sont pas encore activés lors d'une session de jeu, l'appel renvoie une chaîne vide et une `nil` erreur.

### Exemple
<a name="integration-server-sdk-go-getgamesessionid-example"></a>

```
gameSessionID, err := server.GetGameSessionID()
```

## GetTerminationTime()
<a name="integration-server-sdk-go-getterm"></a>

Renvoie l'heure à laquelle il est prévu d'arrêter un processus serveur si une heure de fin est disponible. Un processus serveur exécute cette action après avoir reçu un `onProcessTerminate()` rappel deAmazon GameLift Servers. Amazon GameLift Serversappels `onProcessTerminate()` pour les raisons suivantes : 
+ Lorsque le processus du serveur a signalé un mauvais état de santé ou n'a pas réponduAmazon GameLift Servers.
+ Lorsque vous mettez fin à l'instance lors d'un événement de réduction de la taille.
+ Lorsqu'une instance est interrompue en raison d'une interruption [ponctuelle](spot-tasks.md).

### Syntaxe
<a name="integration-server-sdk-go-getterm-syntax"></a>

```
func GetTerminationTime() (int64, error)
```

### Valeur renvoyée
<a name="integration-server-sdk-go-getterm-return"></a>

En cas de succès, renvoie l'horodatage en secondes pendant lequel le processus du serveur est programmé pour s'arrêter et une `nil` erreur s'est terminée. La valeur est le délai de résiliation, 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 à celle `637355968000000000` des ticks. Si aucune heure de résiliation n'est disponible, renvoie un message d'erreur.

### Exemple
<a name="integration-server-sdk-go-getterm-example"></a>

```
terminationTime, err := server.GetTerminationTime()
```

## AcceptPlayerSession()
<a name="integration-server-sdk-go-acceptplayersession"></a>

Amazon GameLift ServersIndique qu'un joueur avec l'identifiant de session de joueur spécifié s'est connecté au processus du serveur et doit être validé. Amazon GameLift Serversvérifie que l'identifiant de session du joueur est valide. Une fois la session du joueur validée, le statut de l'emplacement du joueur Amazon GameLift Servers passe de `RESERVED` à`ACTIVE`. 

### Syntaxe
<a name="integration-server-sdk-go-acceptplayersession-syntax"></a>

```
func AcceptPlayerSession(playerSessionID string) error
```

### Parameters
<a name="integration-server-sdk-go-acceptplayersession-parameter"></a>

`playerSessionId`  
Identifiant unique émis Amazon GameLift Servers lors de la création d'une nouvelle session de joueur.

### Valeur renvoyée
<a name="integration-server-sdk-go-acceptplayersession-return"></a>

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

### Exemple
<a name="integration-server-sdk-go-acceptplayersession-example"></a>

Cet exemple traite une demande de connexion qui inclut la validation et le rejet d'une session de joueur non valide. IDs 

```
func ReceiveConnectingPlayerSessionID(conn Connection, playerSessionID string) {
    err := server.AcceptPlayerSession(playerSessionID)
    if err != nil {
        connection.Accept()
    } else {
        connection.Reject(err.Error())
    }
}
```

## RemovePlayerSession()
<a name="integration-server-sdk-go-removeplayersession"></a>

Indique Amazon GameLift Servers qu'un joueur s'est déconnecté du processus serveur. En réponse, Amazon GameLift Servers change l'emplacement du joueur pour le rendre disponible. 

### Syntaxe
<a name="integration-server-sdk-go-removeplayersession-syntax"></a>

```
func RemovePlayerSession(playerSessionID string) error
```

### Parameters
<a name="integration-server-sdk-go-removeplayersession-parameter"></a>

**`playerSessionId`**  
Identifiant unique émis Amazon GameLift Servers lors de la création d'une nouvelle session de joueur.

### Valeur renvoyée
<a name="integration-server-sdk-go-removeplayersession-return"></a>

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

### Exemple
<a name="integration-server-sdk-go-removeplayersession-example"></a>

```
err := server.RemovePlayerSession(playerSessionID)
```

## DescribePlayerSessions()
<a name="integration-server-sdk-go-describeplayersessions"></a>

Récupère les données de session du joueur, notamment les paramètres, les métadonnées de session et les données du joueur. Utilisez cette méthode pour obtenir des informations sur les points suivants :
+ Une session solo
+ Toutes les sessions des joueurs au cours d'une session de jeu
+ Toutes les sessions de joueur associées à un identifiant de joueur unique

### Syntaxe
<a name="integration-server-sdk-go-describeplayersessions-syntax"></a>

```
func DescribePlayerSessions(req request.DescribePlayerSessionsRequest) (result.DescribePlayerSessionsResult, error) {
	return srv.describePlayerSessions(&req)
}
```

### Parameters
<a name="integration-server-sdk-go-describeplayersessions-parameter"></a>

**[DescribePlayerSessionsRequest](integration-server-sdk-go-datatypes.md#integration-server-sdk-go-dataypes-playersessions)**  
Un `DescribePlayerSessionsRequest` objet décrit les sessions de joueur à récupérer.

### Valeur renvoyée
<a name="integration-server-sdk-go-describeplayersessions-return"></a>

En cas de succès, renvoie un `DescribePlayerSessionsResult` objet contenant un ensemble d'objets de session de joueur correspondant aux paramètres de la demande.

### Exemple
<a name="integration-server-sdk-go-describeplayersessions-example"></a>

Cet exemple demande toutes les sessions de joueur activement connectées à une session de jeu spécifiée. En omettant *NextToken*et en définissant la valeur *limite* sur 10, Amazon GameLift Servers renvoie les 10 premiers enregistrements de session de joueur correspondant à la demande.

```
// create request
describePlayerSessionsRequest := request.NewDescribePlayerSessions() 
describePlayerSessionsRequest.GameSessionID, _ = server.GetGameSessionID() // get ID for the current game session
describePlayerSessionsRequest.Limit = 10                                 // return the first 10 player sessions
describePlayerSessionsRequest.PlayerSessionStatusFilter = "ACTIVE"         // Get all player sessions actively connected to the game session

describePlayerSessionsResult, err := server.DescribePlayerSessions(describePlayerSessionsRequest)
```

## StartMatchBackfill()
<a name="integration-server-sdk-go-startmatchbackfill"></a>

Envoie une demande de recherche de nouveaux joueurs pour des emplacements ouverts dans une session de jeu créée avec FlexMatch. Pour plus d'informations, voir la [fonction de FlexMatch remblayage](https://docs.aws.amazon.com/gameliftservers/latest/flexmatchguide/match-backfill.html).

Cette action est asynchrone. Si de nouveaux joueurs sont jumelés, Amazon GameLift Servers fournit des données de matchmaking mises à jour à l'aide de 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()](#integration-server-sdk-go-stopmatchbackfill) pour annuler la requête d'origine.

### Syntaxe
<a name="integration-server-sdk-go-startmatchbackfill-syntax"></a>

```
func StartMatchBackfill(req request.StartMatchBackfillRequest) (result.StartMatchBackfillResult, error)
```

### Parameters
<a name="integration-server-sdk-go-startmatchbackfill-parameter"></a>

**[StartMatchBackfillRequest](integration-server-sdk-go-datatypes.md#integration-server-sdk-go-dataypes-startmatchbackfillrequest)**  
Un StartMatchBackfillRequest objet communique les informations suivantes :  
+ ID de ticket à attribuer à la requête de renvoi. Ces informations sont facultatives ; si aucun identifiant n'est fourni, il en Amazon GameLift Servers génère un.
+ Matchmaker auquel envoyer la requête. L'ARN de configuration complet est obligatoire. Cette valeur se trouve dans les données du matchmaker de la session de jeu.
+ ID de la session de jeu à compléter.
+ Les données de matchmaking disponibles pour les joueurs actuels de la session de jeu.

### Valeur renvoyée
<a name="integration-server-sdk-go-startmatchbackfill-return"></a>

Renvoie un `StartMatchBackfillResult` objet avec l'identifiant du ticket de remplacement correspondant, ou un échec avec un message d'erreur. 

### Exemple
<a name="integration-server-sdk-go-startmatchbackfill-example"></a>

```
// form the request
startBackfillRequest := request.NewStartMatchBackfill()
startBackfillRequest.RequestID = "1111aaaa-22bb-33cc-44dd-5555eeee66ff"          // optional
startBackfillRequest.MatchmakingConfigurationArn = "arn:aws:gamelift:us-west-2:111122223333:matchmakingconfiguration/MyMatchmakerConfig"
var matchMaker model.MatchmakerData
if err := matchMaker.UnmarshalJSON([]byte(gameSession.MatchmakerData)); err != nil {    
    return
}
startBackfillRequest.Players = matchMaker.Players
res, err := server.StartMatchBackfill(startBackfillRequest)

// Implement callback function for backfill
func OnUpdateGameSession(myGameSession model.GameSession) {
    // game-specific tasks to prepare for the newly matched players and update matchmaker data as needed
}
```

## StopMatchBackfill()
<a name="integration-server-sdk-go-stopmatchbackfill"></a>

Annule une demande de remplacement de match active. Pour plus d'informations, voir la [fonction de FlexMatch remblayage](https://docs.aws.amazon.com/gameliftservers/latest/flexmatchguide/match-backfill.html).

### Syntaxe
<a name="integration-server-sdk-go-stopmatchbackfill-syntax"></a>

```
func StopMatchBackfill(req request.StopMatchBackfillRequest) error
```

### Parameters
<a name="integration-server-sdk-go-stopmatchbackfill-parameter"></a>

**[StopMatchBackfillRequest](integration-server-sdk-go-datatypes.md#integration-server-sdk-go-dataypes-stopmatchbackfillrequest)**  
Un StopMatchBackfillRequest objet qui identifie le ticket de matchmaking à annuler :   
+ L'identifiant du ticket attribué à la demande de remblayage.
+ L'entremetteur à qui la demande de remblayage a été envoyée.
+ La session de jeu associée à la demande de remplacement.

### Valeur renvoyée
<a name="integration-server-sdk-go-stopmatchbackfill-return"></a>

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

### Exemple
<a name="integration-server-sdk-go-stopmatchbackfill-example"></a>

```
stopBackfillRequest := request.NewStopMatchBackfill()  // Use this function to create request
stopBackfillRequest.TicketID = "1111aaaa-22bb-33cc-44dd-5555eeee66ff"
stopBackfillRequest.MatchmakingConfigurationArn = "arn:aws:gamelift:us-west-2:111122223333:matchmakingconfiguration/MyMatchmakerConfig"
                
//error
err := server.StopMatchBackfill(stopBackfillRequest)
```

## GetComputeCertificate()
<a name="integration-server-sdk-go-getcomputecertificate"></a>

Récupère le chemin d'accès au certificat TLS utilisé pour chiffrer la connexion réseau entre le serveur de jeu et votre client de jeu. Vous pouvez utiliser le chemin du certificat lorsque vous enregistrez votre appareil informatique dans un parc Amazon GameLift Servers Anywhere. Pour de plus amples informations, veuillez consulter [RegisterCompute](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html).

### Syntaxe
<a name="integration-server-sdk-go-getcomputecertificate-syntax"></a>

```
func GetComputeCertificate() (result.GetComputeCertificateResult, error)
```

### Valeur renvoyée
<a name="integration-server-sdk-go-getcomputecertificate-return"></a>

Renvoie un `GetComputeCertificateResult` objet contenant les éléments suivants : 
+  CertificatePath: chemin d'accès au certificat TLS sur votre ressource de calcul. Lorsque vous utilisez une flotte Amazon GameLift Servers gérée, ce chemin contient : 
  + `certificate.pem`: le certificat de l'utilisateur final. La chaîne de certificats complète est la combinaison des `certificateChain.pem` éléments ajoutés à ce certificat.
  + `certificateChain.pem`: chaîne de certificats qui contient le certificat racine et les certificats intermédiaires.
  + `rootCertificate.pem`: le certificat racine.
  + `privateKey.pem`: clé privée pour le certificat d'utilisateur final.
+ ComputeName: nom de votre ressource de calcul.

### Exemple
<a name="integration-server-sdk-go-getcomputecertificate-example"></a>

```
tlsCertificate, err := server.GetFleetRoleCredentials(getFleetRoleCredentialsRequest)
```

## GetFleetRoleCredentials()
<a name="integration-server-sdk-go-getfleetrolecredentials"></a>

Récupère les informations d'identification du rôle de service que vous créez pour étendre les autorisations à votre interlocuteur Services AWS . Amazon GameLift Servers Ces informations d'identification permettent à votre serveur de jeu d'utiliser vos AWS ressources. Pour de plus amples informations, veuillez consulter [Configurer un rôle de service IAM pour Amazon GameLift Servers](setting-up-role.md).

### Syntaxe
<a name="integration-server-sdk-go-getfleetrolecredentials-syntax"></a>

```
func GetFleetRoleCredentials(
  req request.GetFleetRoleCredentialsRequest,
) (result.GetFleetRoleCredentialsResult, error) {
  return srv.getFleetRoleCredentials(&req)
}
```

### Parameters
<a name="integration-server-sdk-go-getfleetrolecredentials-parameters"></a>

[GetFleetRoleCredentialsRequest](integration-server-sdk-go-datatypes.md#integration-server-sdk-go-dataypes-getfleetrolecredentialsrequest)  
Des informations d'identification de rôle qui étendent un accès limité à vos AWS ressources au serveur de jeu.

### Valeur renvoyée
<a name="integration-server-sdk-go-getfleetrolecredentials-return"></a>

Renvoie un `GetFleetRoleCredentialsResult` objet contenant les éléments suivants : 
+ AssumedRoleUserArn - Le nom de ressource Amazon (ARN) de l'utilisateur auquel appartient le rôle de service. 
+ AssumedRoleId - L'ID de l'utilisateur auquel appartient le rôle de service. 
+ AccessKeyId - L'ID de clé d'accès pour authentifier et fournir un accès à vos AWS ressources. 
+ SecretAccessKey - L'identifiant de la clé d'accès secrète pour l'authentification. 
+ SessionToken - Un jeton pour identifier la session active en cours qui interagit avec vos AWS ressources. 
+ Expiration : délai avant l'expiration des informations d'identification de votre session.

### Exemple
<a name="integration-server-sdk-go-getfleetrolecredentials-example"></a>

```
// form the customer credentials request
getFleetRoleCredentialsRequest := request.NewGetFleetRoleCredentials()
getFleetRoleCredentialsRequest.RoleArn = "arn:aws:iam::123456789012:role/service-role/exampleGameLiftAction"

credentials, err := server.GetFleetRoleCredentials(getFleetRoleCredentialsRequest)
```

## Détruire ()
<a name="integration-server-sdk-go-destroy"></a>

Libère de la mémoire le SDK du serveur de Amazon GameLift Servers jeu. Il est recommandé d'appeler cette méthode après `ProcessEnding()` et avant de terminer le processus. Si vous utilisez une flotte Anywhere et que vous n'interrompez pas les processus du serveur après chaque session de jeu, appelez `Destroy()` puis `InitSDK()` réinitialisez avant de signaler Amazon GameLift Servers que le processus est prêt à héberger une session de jeu avec. `ProcessReady()`

### Syntaxe
<a name="integration-server-sdk-go-destroy-syntax"></a>

```
func Destroy() error {
	return srv.destroy()
}
```

### Valeur renvoyée
<a name="integration-server-sdk-go-destroy-return"></a>

Renvoie une erreur accompagnée d'un message d'erreur en cas d'échec de la méthode.

### Exemple
<a name="integration-server-sdk-go-destroy-example"></a>

```
// operations to end game sessions and the server process
defer func() {
  err := server.ProcessEnding()
  server.Destroy()
  if err != nil {
    fmt.Println("ProcessEnding() failed. Error: ", err)
    os.Exit(-1)
  } else {
    os.Exit(0)
  }
}
```

# SDK 5.x du serveur C\$1\$1 (Unreal) pour Amazon GameLift Servers -- Actions
<a name="integration-server-sdk5-unreal-actions"></a>

Utilisez la référence du SDK du serveur Amazon GameLift Servers Unreal 5.x pour vous aider à préparer votre jeu multijoueur en vue de son utilisation avec. Amazon GameLift Servers Pour plus de détails sur le processus d'intégration, consultez[Ajoutez Amazon GameLift Servers à votre serveur de jeu avec le SDK du serveur](gamelift-sdk-server-api.md). Si vous utilisez le Amazon GameLift Servers plugin pour Unreal, consultez également[Amazon GameLift Serversplugin pour Unreal Engine](unreal-plugin.md).

**Note**  
Cette rubrique décrit l'API Amazon GameLift Servers C\$1\$1 que vous pouvez utiliser lorsque vous créez pour Unreal Engine. Plus précisément, cette documentation s'applique au code que vous compilez avec l'`-DBUILD_FOR_UNREAL=1`option. 

# SDK 5.x du serveur C\$1\$1 (Unreal) pour Amazon GameLift Servers -- Types de données
<a name="integration-server-sdk5-unreal-datatypes"></a>

Utilisez la référence du SDK du serveur Amazon GameLift Servers Unreal 5.x pour vous aider à préparer votre jeu multijoueur en vue de son utilisation avec. Amazon GameLift Servers Pour plus de détails sur le processus d'intégration, consultez[Ajoutez Amazon GameLift Servers à votre serveur de jeu avec le SDK du serveur](gamelift-sdk-server-api.md). Si vous utilisez le Amazon GameLift Servers plugin pour Unreal, consultez également[Amazon GameLift Serversplugin pour Unreal Engine](unreal-plugin.md).

**Note**  
Cette rubrique décrit l'API Amazon GameLift Servers C\$1\$1 que vous pouvez utiliser lorsque vous créez pour Unreal Engine. Plus précisément, cette documentation s'applique au code que vous compilez avec l'`-DBUILD_FOR_UNREAL=1`option. 

[SDK 5.x du serveur C\$1\$1 (Unreal) pour Amazon GameLift Servers -- Actions](integration-server-sdk5-unreal-actions.md)

**Topics**
+ [FProcessParamètres](#integration-server-sdk5-unreal-dataypes-process)
+ [UpdateGameSession](#integration-server-sdk5-unreal-dataypes-updategamesession)
+ [GameSession](#integration-server-sdk5-unreal-dataypes-gamesession)
+ [FServerParamètres](#integration-server-sdk5-unreal-dataypes-serverparameters)
+ [FStartMatchBackfillRequest](#integration-server-sdk5-unreal-dataypes-startmatchbackfillrequest)
+ [FPlayer](#integration-server-sdk5-unreal-dataypes-player)
+ [FGameLiftDescribePlayerSessionsRequest](#integration-server-sdk5-unreal-dataypes-playersessions)
+ [FStopMatchBackfillRequest](#integration-server-sdk5-unreal-dataypes-stopmatchbackfillrequest)
+ [FAttributeValeur](#integration-server-sdk5-unreal-dataypes-attributevalue)
+ [FGameLiftGetFleetRoleCredentialsRequest](#integration-server-sdk5-unreal-dataypes-getfleetrolecredentialsrequest)
+ [FGameLiftLongOutcome](#integration-server-sdk5-unreal-dataypes-awslongoutcome)
+ [FGameLiftStringOutcome](#integration-server-sdk5-unreal-dataypes-awsstringoutcome)
+ [FGameLiftDescribePlayerSessionsOutcome](#integration-server-sdk5-unreal-dataypes-describeplayersessionsoutcome)
+ [FGameLiftDescribePlayerSessionsResult](#integration-server-sdk5-unreal-dataypes-describeplayersessionresult)
+ [FGenericRésultat](#integration-server-sdk5-unreal-dataypes-genericoutcome)
+ [FGameLiftPlayerSession](#integration-server-sdk5-unreal-dataypes-playersession)
+ [FGameLiftGetComputeCertificateOutcome](#integration-server-sdk5-unreal-dataypes-getcomputecertificateoutcome)
+ [FGameLiftGetComputeCertificateResult](#integration-server-sdk5-unreal-dataypes-getcomputecertificateresult)
+ [FGameLiftGetFleetRoleCredentialsOutcome](#integration-server-sdk5-unreal-dataypes-getfleetrolecredentialsoutcome)
+ [FGetFleetRoleCredentialsResult](#integration-server-sdk5-unreal-dataypes-getfleetrolecredentialsresult)
+ [FGameLiftError](#integration-server-sdk5-unreal-dataypes-gamelifterror)
+ [Enums](#integration-server-sdk5-unreal-dataypes-enums)

## FProcessParamètres
<a name="integration-server-sdk5-unreal-dataypes-process"></a>

Ce type de données contient l'ensemble des paramètres envoyés à Amazon GameLift Servers dans un[ProcessReady()](integration-server-sdk5-unreal-actions.md#integration-server-sdk5-unreal-processready).


|  |  | 
| --- |--- |
|  **Propriétés**  | Description | 
| LogParameters | Objet avec des chemins de répertoire vers des fichiers générés au cours d'une session de jeu. Amazon GameLift Serverscopie et stocke les fichiers pour un accès futur.**Type :** `TArray<FString>`**Obligatoire** : non | 
| OnHealthCheck | La fonction de rappel qui Amazon GameLift Servers appelle le processus du serveur pour demander un rapport d'état de santé. Amazon GameLift Serversappelle cette fonction toutes les 60 secondes et attend une réponse pendant 60 secondes. Le processus du serveur revient TRUE s'il est sain, FALSE sinon sain. Si aucune réponse n'est renvoyée, Amazon GameLift Servers enregistre le processus du serveur comme non sain. Cette propriété est une fonction déléguée définie comme suit `DECLARE_DELEGATE_RetVal(bool, FOnHealthCheck)` :   **Type :** `FOnHealthCheck`**Obligatoire** : non | 
| OnProcessTerminate | La fonction de rappel qui Amazon GameLift Servers invoque pour forcer l'arrêt du processus du serveur. Après avoir appelé cette fonction, Amazon GameLift Servers attendez 5 minutes que le processus serveur s'arrête et répondez par un [ProcessEnding()](integration-server-sdk5-unreal-actions.md#integration-server-sdk5-unreal-processending) appel avant d'arrêter le processus serveur.**Type :** `FSimpleDelegate`**Obligatoire** : oui | 
| OnStartGameSession | La fonction de rappel qui Amazon GameLift Servers appelle pour activer une nouvelle session de jeu. Amazon GameLift Serversappelle cette fonction en réponse à une demande du client [CreateGameSession](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_CreateGameSession.html). La fonction de rappel transmet un [GameSession](#integration-server-sdk5-unreal-dataypes-gamesession) objet. Cette propriété est une fonction déléguée définie comme `DECLARE_DELEGATE_OneParam(FOnStartGameSession, Aws::GameLift::Server::Model::GameSession);`  **Type :** `FOnStartGameSession`**Obligatoire** : oui | 
| OnUpdateGameSession | La fonction de rappel qui Amazon GameLift Servers appelle pour transmettre un objet de session de jeu mis à jour au processus du serveur. Amazon GameLift Serversappelle cette fonction lorsqu'une demande de remplissage de correspondances a été traitée pour fournir des données de matchmaking mises à jour. Il transmet un [GameSession](#integration-server-sdk5-unreal-dataypes-gamesession) objet, une mise à jour de statut (updateReason) et l'identifiant du ticket de remplacement des matchs. Cette propriété est une fonction déléguée définie comme `DECLARE_DELEGATE_OneParam(FOnUpdateGameSession, Aws::GameLift::Server::Model::UpdateGameSession);` **Type :** `FOnUpdateGameSession`**Obligatoire** : non | 
|  Port | Numéro de port sur lequel le processus serveur écoute les connexions des nouveaux joueurs. La valeur doit être comprise dans la plage de ports configurée pour toutes les flottes déployant cette version de génération du serveur de jeux. Ce numéro de port est inclus dans les objets de session de jeu et de session de joueur, que les sessions de jeu utilisent pour se connecter à un processus serveur.**Type :** `int`**Obligatoire** : oui | 

## UpdateGameSession
<a name="integration-server-sdk5-unreal-dataypes-updategamesession"></a>

Ce type de données est mis à jour vers un objet de session de jeu, qui inclut la raison pour laquelle la session de jeu a été mise à jour et l'identifiant du ticket de remplissage associé si le remplissage est utilisé pour remplir les sessions des joueurs pendant la session de jeu.


| Propriétés | **Description** | 
| --- | --- | 
| GameSession | Un objet [GameSession](#integration-server-sdk5-unreal-dataypes-gamesession). L'GameSessionobjet contient des propriétés décrivant une session de jeu. **Type :** `Aws::GameLift::Server::GameSession`**Obligatoire** : non | 
| UpdateReason | La raison pour laquelle la session de jeu est mise à jour. **Type :** `enum class UpdateReason`  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/gameliftservers/latest/developerguide/integration-server-sdk5-unreal-datatypes.html) **Obligatoire** : non   | 
| BackfillTicketId | L'identifiant du ticket de remplacement qui tente de mettre à jour la session de jeu.**Type :** `char[]`**Obligatoire** : non | 

## GameSession
<a name="integration-server-sdk5-unreal-dataypes-gamesession"></a>

Ce type de données fournit les détails d'une session de jeu. 


| Propriétés | **Description** | 
| --- | --- | 
| GameSessionId |  Identifiant unique pour la session de jeu. L'ARN d'une session de jeu a le format suivant :`arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>`. **Type :** `char[]` **Obligatoire** : non  | 
| Nom |  Une étiquette descriptive de la session de jeu.  **Type :** `char[]` **Obligatoire** : non  | 
| FleetId |  Identifiant unique de la flotte sur laquelle s'exécute la session de jeu. **Type :** `char[]` **Obligatoire** : non  | 
| MaximumPlayerSessionCount |  Le nombre maximum de connexions de joueurs à la session de jeu. **Type :** `int` **Obligatoire** : non  | 
|  Port |  Le numéro de port de la session de jeu. Pour se connecter à un serveur de Amazon GameLift Servers jeu, une application a besoin de l'adresse IP et du numéro de port. **Type :** `int` **Obligatoire** : non  | 
| IpAddress |  Adresse IP de la session de jeu. Pour se connecter à un serveur de Amazon GameLift Servers jeu, une application a besoin de l'adresse IP et du numéro de port. **Type :** `char[]` **Obligatoire** : non  | 
| GameSessionData |  Ensemble de propriétés de session de jeu personnalisées, mises en forme en tant que valeur de chaîne unique.  **Type :** `char[]` **Obligatoire** : non  | 
| MatchmakerData |  Informations sur le processus de matchmaking utilisé pour créer la session de jeu, en syntaxe JSON, formatée sous forme de chaîne. En plus de la configuration de matchmaking utilisée, il contient des données sur tous les joueurs affectés au match, y compris les attributs des joueurs et les affectations des équipes. **Type :** `char[]` **Obligatoire** : non  | 
| GameProperties |  Ensemble de propriétés personnalisées pour une session de jeu, formatées sous forme de paires clé:valeur. Ces propriétés sont transmises avec une demande de démarrage d'une nouvelle session de jeu. **Type :** `GameProperty[]` **Obligatoire** : non  | 
| DnsName |  Identifiant DNS attribué à l'instance qui exécute la session de jeu. Les valeurs ont le format suivant : [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/gameliftservers/latest/developerguide/integration-server-sdk5-unreal-datatypes.html) Lorsque vous vous connectez à une session de jeu exécutée sur une flotte compatible TLS, vous devez utiliser le nom DNS et non l'adresse IP. **Type :** `char[]` **Obligatoire** : non  | 

## FServerParamètres
<a name="integration-server-sdk5-unreal-dataypes-serverparameters"></a>

Informations utilisées pour maintenir la connexion entre un serveur Amazon GameLift Servers Anywhere et le Amazon GameLift Servers service. Ces informations sont utilisées lors du lancement de nouveaux processus serveur avec[InitSDK()](integration-server-sdk5-unreal-actions.md#integration-server-sdk5-unreal-initsdk). Pour les serveurs hébergés sur des instances EC2 Amazon GameLift Servers gérées, utilisez un objet vide.


| Propriétés | **Description** | 
| --- | --- | 
| webSocketUrl |  Les `GameLiftServerSdkEndpoint` Amazon GameLift Servers retours lorsque vous [https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html)recherchez une ressource de calcul Amazon GameLift Servers Anywhere. **Type :** `char[]` **Obligatoire** : oui   | 
| ID du processus |  Un identifiant unique enregistré auprès du processus serveur hébergeant votre jeu. **Type :** `char[]` **Obligatoire** : oui  | 
| hostId | Le HostID est celui ComputeName utilisé lorsque vous avez enregistré votre ordinateur. Pour plus d'informations, voir, [RegisterCompute](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html).**Type :** `char[]`**Obligatoire** : oui | 
| ID de flotte | Identifiant unique de la flotte dans laquelle le calcul est enregistré. Pour plus d'informations, voir, [RegisterCompute](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html).**Type :** `char[]`**Obligatoire** : oui | 
| Jeton d'authentification | Le jeton d'authentification généré par Amazon GameLift Servers celui-ci authentifie votre serveur auprès deAmazon GameLift Servers. Pour plus d'informations, voir, [GetComputeAuthToken](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_GetComputeAuthToken.html).**Type :** `char[]`**Obligatoire** : oui | 

## FStartMatchBackfillRequest
<a name="integration-server-sdk5-unreal-dataypes-startmatchbackfillrequest"></a>

Informations utilisées pour créer une demande de remplissage par matchmaking. Le serveur de jeu communique ces informations Amazon GameLift Servers lors d'un [StartMatchBackfill()](integration-server-sdk5-unreal-actions.md#integration-server-sdk5-unreal-startmatchbackfill) appel.


| Propriétés | **Description** | 
| --- | --- | 
| GameSessionArn |  Un identifiant de session de jeu unique. L'opération API `[GetGameSessionId](https://docs.aws.amazon.com/gameliftservers/latest/developerguide/integration-server-sdk5-unreal-actions.html#integration-server-sdk5-unreal-getgamesessionid)` renvoie l'identifiant au format ARN. **Type :** `char[]` **Obligatoire** : oui  | 
| MatchmakingConfigurationArn |  Un identifiant unique, sous la forme d'un ARN, que le système de jumelage doit utiliser pour cette demande. L'ARN de matchmaking pour la session de jeu d'origine se trouve dans l'objet de session de jeu dans la propriété de données du matchmaker. Pour en savoir plus sur les données du système de jumelage, consultez la section [Travailler avec les données du système de jumelage.](https://docs.aws.amazon.com/gameliftservers/latest/flexmatchguide/match-server.html#match-server-data.html) **Type :** `char[]` **Obligatoire** : oui  | 
| Joueurs |  Ensemble de données représentant tous les joueurs participant à la session de jeu. Le matchmaker utilise ces informations pour rechercher de nouveaux joueurs qui constituent de bonnes correspondances pour les joueurs actuels. **Type :** `TArray<FPlayer>` **Obligatoire** : oui  | 
| TicketId |  Un identifiant unique pour un ticket de demande de matchmaking ou de remplacement de match. Si vous ne fournissez aucune valeur, il en Amazon GameLift Servers génère une. Utilisez cet identifiant pour suivre l'état du ticket de renvoi de correspondance ou annuler la requête si nécessaire.  **Type :** `char[]` **Obligatoire** : non  | 

## FPlayer
<a name="integration-server-sdk5-unreal-dataypes-player"></a>

Ce type de données représente un joueur dans le matchmaking. Lors du lancement d'une demande de matchmaking, un joueur dispose d'un identifiant de joueur, d'attributs et éventuellement de données de latence. Amazon GameLift Serversajoute des informations sur l'équipe après la fin d'un match.


| Propriétés | **Description** | 
| --- | --- | 
| LatencyInMS |  Ensemble de valeurs exprimées en millisecondes qui indiquent le niveau de latence ressenti par un joueur lorsqu'il est connecté à un lieu.  Si cette propriété est utilisée, le joueur n'est jumelé qu'aux emplacements répertoriés. Si un matchmaker dispose d'une règle qui évalue la latence, les joueurs doivent indiquer la latence pour être mis en relation. **Type :** `TMap>FString, int32<` **Obligatoire** : non  | 
| PlayerAttributes |  Une collection de paires clé:valeur contenant des informations sur les joueurs à utiliser dans le matchmaking. Les clés d'attribut du joueur doivent correspondre à PlayerAttributes celles utilisées dans un ensemble de règles de matchmaking. Pour plus d'informations sur les attributs des joueurs, consultez [AttributeValue](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_AttributeValue.html). **Type :** `TMap>FString, FAttributeValue<` **Obligatoire** : non  | 
| PlayerId |  Identifiant unique pour un joueur. **Type :** `std::string` **Obligatoire** : non  | 
| Team |  Le nom de l'équipe à laquelle le joueur est affecté lors d'un match. Vous définissez le nom de l'équipe dans le jeu de règles de matchmaking. **Type :** `FString` **Obligatoire** : non  | 

## FGameLiftDescribePlayerSessionsRequest
<a name="integration-server-sdk5-unreal-dataypes-playersessions"></a>

Objet qui indique les sessions de joueur à récupérer. Le processus du serveur fournit ces informations en [DescribePlayerSessions()](integration-server-sdk5-unreal-actions.md#integration-server-sdk5-unreal-describeplayersessions) appelantAmazon GameLift Servers.


| Propriétés | **Description** | 
| --- | --- | 
| GameSessionId |  Un identifiant de session de jeu unique. Utilisez ce paramètre pour demander toutes les sessions de joueur pour la session de jeu spécifiée.  Le format de l'identifiant de session de jeu est`FString`. `GameSessionID`Il s'agit d'une chaîne d'identification personnalisée ou d'un **Type :** `std::string` **Obligatoire** : non  | 
| PlayerSessionId |  Identifiant unique d'une session de joueur. Utilisez ce paramètre pour demander une session de joueur spécifique. **Type :** `FString` **Obligatoire** : non  | 
| PlayerId |  L'identifiant unique d'un joueur. Utilisez ce paramètre pour demander toutes les sessions de joueur pour un joueur spécifique. Consultez [Générer un joueur IDs](player-sessions-player-identifiers.md). **Type :** `FString` **Obligatoire** : non  | 
| PlayerSessionStatusFilter |  État de la session du joueur sur lequel filtrer les résultats. Les statuts de session de joueur possibles incluent : [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/gameliftservers/latest/developerguide/integration-server-sdk5-unreal-datatypes.html) **Type :** `FString` **Obligatoire** : non  | 
| NextToken |  Le jeton indiquant le début de la page de résultats suivante. Pour spécifier le début du jeu de résultats, ne fournissez aucune valeur. Si vous fournissez un identifiant de session de joueur, ce paramètre est ignoré. **Type :** `FString` **Obligatoire** : non  | 
| Limite |  Nombre maximal de résultats à renvoyer. Si vous fournissez un identifiant de session de joueur, ce paramètre est ignoré. **Type :** `int` **Obligatoire** : non  | 

## FStopMatchBackfillRequest
<a name="integration-server-sdk5-unreal-dataypes-stopmatchbackfillrequest"></a>

Informations utilisées pour annuler une demande de remplissage par matchmaking. Le serveur de jeu communique ces informations au Amazon GameLift Servers service lors d'un [StopMatchBackfill()](integration-server-sdk5-unreal-actions.md#integration-server-sdk5-unreal-stopmatchbackfill) appel.


| Propriétés | **Description** | 
| --- | --- | 
| GameSessionArn |  Identifiant de session de jeu unique de la demande annulée. **Type :** `FString` **Obligatoire** : oui  | 
| MatchmakingConfigurationArn |  Un identifiant unique du matchmaker auquel cette demande a été envoyée. **Type :** `FString` **Obligatoire** : oui  | 
| TicketId |  Identifiant unique du ticket de demande de remblayage à annuler. **Type :** `FString` **Obligatoire** : oui  | 

## FAttributeValeur
<a name="integration-server-sdk5-unreal-dataypes-attributevalue"></a>

Utilisez ces valeurs dans les paires [FPlayer](#integration-server-sdk5-unreal-dataypes-player) clé-valeur d'attribut. Cet objet vous permet de spécifier une valeur d'attribut à l'aide de n'importe quel type de données valide : chaîne, nombre, tableau de chaînes ou mappage de données. Chaque `AttributeValue` objet ne peut utiliser qu'une seule des propriétés disponibles.


| Propriétés | Description | 
| --- | --- | 
| Type ATR |  Spécifie le type de valeur d'attribut. **Type :** valeur `FAttributeType` [enum](#integration-server-sdk5-unreal-dataypes-enums).  **Obligatoire** : non  | 
|  S |  Représente une valeur d'attribut de chaîne. **Type :** `FString` **Obligatoire** : non  | 
| N |  Représente une valeur d'attribut numérique. **Type :** `double` **Obligatoire** : non  | 
| SL |  Représente un tableau de valeurs d'attributs de chaîne. **Type :** `TArray<FString>` **Obligatoire** : non  | 
| SDM |  Représente un dictionnaire de clés de chaîne et de valeurs doubles. **Type :** `TMap<FString, double>` **Obligatoire** : non  | 

## FGameLiftGetFleetRoleCredentialsRequest
<a name="integration-server-sdk5-unreal-dataypes-getfleetrolecredentialsrequest"></a>

Ce type de données fournit des informations d'identification de rôle qui étendent l'accès limité à vos AWS ressources au serveur de jeu. Pour plus d'informations, voir[Configurer un rôle de service IAM pour Amazon GameLift Servers](setting-up-role.md).


| Propriétés | **Description** | 
| --- | --- | 
| RoleArn | Le nom de ressource Amazon (ARN) du rôle de service qui étend un accès limité à vos AWS ressources.**Type :** `FString`**Obligatoire** : non | 
| RoleSessionName | Nom de la session décrivant l'utilisation des informations d'identification du rôle.**Type :** `FString`**Obligatoire** : non | 

## FGameLiftLongOutcome
<a name="integration-server-sdk5-unreal-dataypes-awslongoutcome"></a>

Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :


| Propriétés | Description | 
| --- | --- | 
| Résultat |  Le résultat de l'action. **Type :** `long` **Obligatoire** : non  | 
| ResultWithOwnership |   Le résultat de l'action, converti en valeur rvalue, afin que le code appelant puisse s'approprier l'objet.  **Type :** `long&&` **Obligatoire** : non  | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  Erreur survenue en cas d'échec de l'action. **Type :** [FGameLiftError](#integration-server-sdk5-unreal-dataypes-gamelifterror) **Obligatoire** : non  | 

## FGameLiftStringOutcome
<a name="integration-server-sdk5-unreal-dataypes-awsstringoutcome"></a>

Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :


| Propriétés | Description | 
| --- | --- | 
| Résultat |  Le résultat de l'action. **Type :** `FString` **Obligatoire** : non  | 
| ResultWithOwnership |   Le résultat de l'action, converti en valeur rvalue, afin que le code appelant puisse s'approprier l'objet.  **Type :** `FString&&` **Obligatoire** : non  | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  Erreur survenue en cas d'échec de l'action. **Type :** [FGameLiftError](#integration-server-sdk5-unreal-dataypes-gamelifterror) **Obligatoire** : non  | 

## FGameLiftDescribePlayerSessionsOutcome
<a name="integration-server-sdk5-unreal-dataypes-describeplayersessionsoutcome"></a>

Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :


| Propriétés | Description | 
| --- | --- | 
| Résultat |  Le résultat de l'action. **Type :** [FGameLiftDescribePlayerSessionsResult](#integration-server-sdk5-unreal-dataypes-describeplayersessionresult) **Obligatoire** : non   | 
| ResultWithOwnership |   Le résultat de l'action, converti en valeur rvalue, afin que le code appelant puisse s'approprier l'objet.  **Type :** `FGameLiftDescribePlayerSessionsResult&&` **Obligatoire** : non  | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  Erreur survenue en cas d'échec de l'action. **Type :** [FGameLiftError](#integration-server-sdk5-unreal-dataypes-gamelifterror) **Obligatoire** : non  | 

## FGameLiftDescribePlayerSessionsResult
<a name="integration-server-sdk5-unreal-dataypes-describeplayersessionresult"></a>


| Propriétés | Description | 
| --- | --- | 
| PlayerSessions |   **Type :** `TArray<FGameLiftPlayerSession>` **Obligatoire** : oui  | 
| NextToken |  Le jeton indiquant le début de la page de résultats suivante. Pour spécifier le début du jeu de résultats, ne fournissez aucune valeur. Si vous fournissez un identifiant de session de joueur, ce paramètre est ignoré. **Type :** `FString` **Obligatoire** : non  | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  Erreur survenue en cas d'échec de l'action. **Type :** [FGameLiftError](#integration-server-sdk5-unreal-dataypes-gamelifterror) **Obligatoire** : non  | 

## FGenericRésultat
<a name="integration-server-sdk5-unreal-dataypes-genericoutcome"></a>

Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :


| Propriétés | Description | 
| --- | --- | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  Erreur survenue en cas d'échec de l'action. **Type :** [FGameLiftError](#integration-server-sdk5-unreal-dataypes-gamelifterror) **Obligatoire** : non  | 

## FGameLiftPlayerSession
<a name="integration-server-sdk5-unreal-dataypes-playersession"></a>


| Propriétés | Description | 
| --- | --- | 
| CreationTime |  **Type :** `long` **Obligatoire** : oui  | 
| FleetId |  **Type :** `FString` **Obligatoire** : oui  | 
| GameSessionId |  **Type :** `FString` **Obligatoire** : oui  | 
| IpAddress |  **Type :** `FString` **Obligatoire** : oui  | 
| PlayerData |  **Type :** `FString` **Obligatoire** : oui  | 
| PlayerId |  **Type :** `FString` **Obligatoire** : oui  | 
| PlayerSessionId |  **Type :** `FString` **Obligatoire** : oui  | 
|  Port |  **Type :** `int` **Obligatoire** : oui  | 
| Statut |  **Type :** Une `PlayerSessionStatus` [énumération.](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-dataypes-enums) **Obligatoire** : oui  | 
| TerminationTime |  **Type :** `long` **Obligatoire** : oui  | 
| DnsName |  **Type :** `FString` **Obligatoire** : oui  | 

## FGameLiftGetComputeCertificateOutcome
<a name="integration-server-sdk5-unreal-dataypes-getcomputecertificateoutcome"></a>

Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :


| Propriétés | Description | 
| --- | --- | 
| Résultat |  Le résultat de l'action. **Type :** [FGameLiftGetComputeCertificateResult](#integration-server-sdk5-unreal-dataypes-getcomputecertificateresult) **Obligatoire** : non   | 
| ResultWithOwnership |   Le résultat de l'action, converti en valeur rvalue, afin que le code appelant puisse s'approprier l'objet.  **Type :** `FGameLiftGetComputeCertificateResult&&` **Obligatoire** : non  | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  Erreur survenue en cas d'échec de l'action. **Type :** [FGameLiftError](#integration-server-sdk5-unreal-dataypes-gamelifterror) **Obligatoire** : non  | 

## FGameLiftGetComputeCertificateResult
<a name="integration-server-sdk5-unreal-dataypes-getcomputecertificateresult"></a>

Le chemin d'accès au certificat TLS sur votre ordinateur et le nom d'hôte du calcul.


| Propriétés | Description | 
| --- | --- | 
| CertificatePath |  **Type :** `FString` **Obligatoire** : oui  | 
| ComputeName |  **Type :** `FString` **Obligatoire** : oui  | 

## FGameLiftGetFleetRoleCredentialsOutcome
<a name="integration-server-sdk5-unreal-dataypes-getfleetrolecredentialsoutcome"></a>

Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :


| Propriétés | Description | 
| --- | --- | 
| Résultat |  Le résultat de l'action. **Type :** [FGetFleetRoleCredentialsResult](#integration-server-sdk5-unreal-dataypes-getfleetrolecredentialsresult) **Obligatoire** : non   | 
| ResultWithOwnership |   Le résultat de l'action, converti en valeur rvalue, afin que le code appelant puisse s'approprier l'objet.  **Type :** `FGameLiftGetFleetRoleCredentialsResult&&` **Obligatoire** : non  | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  Erreur survenue en cas d'échec de l'action. **Type :** [FGameLiftError](#integration-server-sdk5-unreal-dataypes-gamelifterror) **Obligatoire** : non  | 

## FGetFleetRoleCredentialsResult
<a name="integration-server-sdk5-unreal-dataypes-getfleetrolecredentialsresult"></a>


| Propriétés | Description | 
| --- | --- | 
| AccessKeyId |  ID de clé d'accès permettant d'authentifier et de fournir un accès à vos AWS ressources. **Type :** `FString` **Obligatoire** : non  | 
| AssumedRoleId |  ID de l'utilisateur auquel appartient le rôle de service. **Type :** `FString` **Obligatoire** : non  | 
| AssumedRoleUserArn |  Le nom de ressource Amazon (ARN) de l'utilisateur auquel appartient le rôle de service. **Type :** `FString` **Obligatoire** : non  | 
| Expiration |  Durée avant l'expiration de vos informations d'identification de session. **Type :** `FDateTime` **Obligatoire** : non  | 
| SecretAccessKey |  ID de clé d'accès secrète pour l'authentification. **Type :** `FString` **Obligatoire** : non  | 
| SessionToken |  Un jeton pour identifier la session active en cours qui interagit avec vos AWS ressources. **Type :** `FString` **Obligatoire** : non  | 
| Réussite |  Que l'action ait été couronnée de succès ou non. **Type :** `bool` **Obligatoire** : oui  | 
| Erreur |  Erreur survenue en cas d'échec de l'action. **Type :** [GameLiftError](integration-server-sdk5-csharp-datatypes.md#integration-server-sdk5-csharp-datatypes-gamelifterror) **Obligatoire** : non  | 

## FGameLiftError
<a name="integration-server-sdk5-unreal-dataypes-gamelifterror"></a>


| Propriétés | Description | 
| --- | --- | 
| ErrorType |  Type d'erreur. **Type :** Une `GameLiftErrorType` [énumération.](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-dataypes-enums) **Obligatoire** : non   | 
| ErrorName |  Nom de l'erreur.  **Type :** `std::string`  **Obligatoire** : non   | 
| ErrorMessage |  Message d’erreur.  **Type :** `std::string`  **Obligatoire** : non   | 

## Enums
<a name="integration-server-sdk5-unreal-dataypes-enums"></a>

Les énumérations définies pour le SDK du serveur pour Amazon GameLift Servers (Unreal) sont définies comme suit :

**FAttributeType**  
+ **NONE**
+ **CHAÎNE**
+ **DOUBLE**
+ **LISTE\$1CHAÎNES**
+ **STRING\$1DOUBLE\$1MAP**

**GameLiftErrorType**  
Valeur de chaîne indiquant le type d'erreur. Les valeurs valides sont les suivantes :  
+ **SERVICE\$1CALL\$1FAILED** — Un appel à un AWS service a échoué. 
+ **LOCAL\$1CONNECTION\$1FAILED — La connexion locale a échoué**. Amazon GameLift Servers 
+ **NETWORK\$1NOT\$1INITIALIZED — Le réseau n'a pas été initialisé**. 
+ **GAMESESSION\$1ID\$1NOT\$1SET — L'ID de session de jeu n'a pas été défini**. 
+ **MAUVAISE DEMANDE D'EXCEPTION** 
+ **EXCEPTION DE SERVICE INTERNE** 
+ **ALREADY\$1INITIALIZED** — Le Amazon GameLift Servers serveur ou le client a déjà été initialisé avec Initialize (). 
+ **FLEET\$1MISMATCH** — La flotte cible ne correspond pas à la flotte d'une GameSession ou d'une PlayerSession. 
+ **GAMELIFT\$1CLIENT\$1NOT\$1INITIALIZED — Le client n'a pas été initialisé**. Amazon GameLift Servers 
+ **GAMELIFT\$1SERVER\$1NOT\$1INITIALIZED — Le serveur n'a pas été initialisé**. Amazon GameLift Servers 
+ **GAME\$1SESSION\$1ENDED\$1FAILED : le SDK du serveur n'a pas** Amazon GameLift Servers pu contacter le service pour signaler la fin de la session de jeu. 
+ **GAME\$1SESSION\$1NOT\$1READY** — La Amazon GameLift Servers session de jeu sur le serveur n'a pas été activée. 
+ **GAME\$1SESSION\$1READY\$1FAILED : le SDK du serveur n'a pas Amazon GameLift Servers pu contacter le service pour signaler que la session de jeu est prête**. 
+ **INITIALIZATION\$1MISMATCH** — Une méthode client a été appelée après Server : :Initialize (), ou vice versa. 
+ **NOT\$1INITIALIZED** — Le Amazon GameLift Servers serveur ou le client n'a pas été initialisé avec Initialize (). 
+ **NO\$1TARGET\$1ALIASID\$1SET — Aucun AliasID cible n'a été défini**. 
+ **NO\$1TARGET\$1FLEET\$1SET — Aucune flotte cible n'a été définie**. 
+ **PROCESS\$1ENDING\$1FAILED** : le SDK du serveur n'a pas Amazon GameLift Servers pu contacter le service pour signaler la fin du processus. 
+ **PROCESS\$1NOT\$1ACTIVE** — Le processus du serveur n'est pas encore actif, n'est pas lié à un et ne peut ni GameSession accepter ni traiter. PlayerSessions 
+ **PROCESS\$1NOT\$1READY** — Le processus du serveur n'est pas encore prêt à être activé. 
+ **PROCESS\$1READY\$1FAILED : le SDK du serveur n'a pas Amazon GameLift Servers pu contacter le service pour signaler que le processus est prêt**. 
+ **SDK\$1VERSION\$1DETECTION\$1FAILED — La détection de la version** du SDK a échoué. 
+ **STX\$1CALL\$1FAILED — Un appel au composant principal du XStx serveur a échoué**. 
+ **STX\$1INITIALIZATION\$1FAILED — Le composant principal du XStx serveur n'a pas pu** être initialisé. 
+ **UNEXPECTED\$1PLAYER\$1SESSION** — Le serveur a détecté une session de joueur non enregistrée. 
+ **ÉCHEC DE CONNEXION WEBSOCKET** 
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1FORBIDDEN** 
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1INVALID\$1URL** 
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1TIMEOUT** 
+ **WEBSOCKET\$1RETRIABLE\$1SEND\$1MESSAGE\$1FAILURE — Échec récupérable lors de l'envoi d'un message** au service. GameLift WebSocket 
+ **WEBSOCKET\$1SEND\$1MESSAGE\$1FAILURE — Impossible d'envoyer un message au service**. GameLift WebSocket 
+ **MATCH\$1BACKFILL\$1REQUEST\$1VALIDATION — La validation de la demande a échoué**. 
+ **PLAYER\$1SESSION\$1REQUEST\$1VALIDATION — La validation de la demande** a échoué. 

**EPlayerSessionCreationPolicy**  
Valeur de chaîne indiquant si la session de jeu accepte ou non de nouveaux joueurs. Les valeurs valides sont les suivantes :   
+ **ACCEPT\$1ALL — Accepte toutes les** sessions de nouveaux joueurs. 
+ **DENY\$1ALL — Refuse toutes les** sessions de nouveaux joueurs. 
+ **NOT\$1SET** — La session de jeu n'est pas configurée pour accepter ou refuser les sessions de nouveaux joueurs. 

**EPlayerSessionStatus**  
+ **ACTIF**
+ **TERMINÉ**
+ **NOT\$1SET**
+ **RÉSERVÉ**
+ **DÉLAI EXPIRÉ**

[SDK 5.x du serveur C\$1\$1 (Unreal) pour Amazon GameLift Servers -- Types de données](integration-server-sdk5-unreal-datatypes.md)

**Topics**
+ [SDK 5.x du serveur C\$1\$1 (Unreal) pour Amazon GameLift Servers -- Types de données](integration-server-sdk5-unreal-datatypes.md)
+ [GetSdkVersion()](#integration-server-sdk5-unreal-getsdkversion)
+ [InitSDK()](#integration-server-sdk5-unreal-initsdk)
+ [InitSDK()](#integration-server-sdk5-unreal-initsdk-anywhere)
+ [ProcessReady()](#integration-server-sdk5-unreal-processready)
+ [ProcessEnding()](#integration-server-sdk5-unreal-processending)
+ [ActivateGameSession()](#integration-server-sdk5-unreal-activategamesession)
+ [UpdatePlayerSessionCreationPolicy()](#integration-server-sdk5-unreal-updateplayersessioncreationpolicy)
+ [GetGameSessionId()](#integration-server-sdk5-unreal-getgamesessionid)
+ [GetTerminationTime()](#integration-server-sdk5-unreal-getterm)
+ [AcceptPlayerSession()](#integration-server-sdk5-unreal-acceptplayersession)
+ [RemovePlayerSession()](#integration-server-sdk5-unreal-removeplayersession)
+ [DescribePlayerSessions()](#integration-server-sdk5-unreal-describeplayersessions)
+ [StartMatchBackfill()](#integration-server-sdk5-unreal-startmatchbackfill)
+ [StopMatchBackfill()](#integration-server-sdk5-unreal-stopmatchbackfill)
+ [GetComputeCertificate()](#integration-server-sdk5-unreal-getcomputecertificate)
+ [GetFleetRoleCredentials()](#integration-server-sdk5-unreal-getfleetrolecredentials)
+ [Détruire ()](#integration-server-sdk5-unreal-ref-destroy)

## GetSdkVersion()
<a name="integration-server-sdk5-unreal-getsdkversion"></a>

Renvoie le numéro de version actuel du kit SDK intégré dans le processus serveur.

### Syntaxe
<a name="integration-server-sdk5-unreal-getsdkversion-syntax"></a>

```
FGameLiftStringOutcome GetSdkVersion();
```

### Valeur renvoyée
<a name="integration-server-sdk5-unreal-getsdkversion-return"></a>

En cas de réussite, renvoie la version actuelle du kit SDK en tant qu'objet [FGameLiftStringOutcome](integration-server-sdk5-unreal-datatypes.md#integration-server-sdk5-unreal-dataypes-awsstringoutcome). L'objet renvoyé inclut le numéro de version (exemple`5.0.0`). En cas d'échec, renvoie un message d'erreur.

### Exemple
<a name="integration-server-sdk5-unreal-getsdkversion-example"></a>

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

## InitSDK()
<a name="integration-server-sdk5-unreal-initsdk"></a>

Initialise le Amazon GameLift Servers SDK pour un parc EC2 géré. Appelez cette méthode au lancement, avant que toute autre initialisation associée ne se Amazon GameLift Servers produise. Cette méthode lit les paramètres du serveur depuis l'environnement hôte afin de configurer la communication entre le serveur et le Amazon GameLift Servers service. Il utilise un jeton d'idempuissance, de sorte que vous pouvez réessayer cet appel en toute sécurité en cas d'échec.

### Syntaxe
<a name="integration-server-sdk5-unreal-initsdk-syntax"></a>

```
FGameLiftGenericOutcome InitSDK()
```

### Valeur renvoyée
<a name="integration-server-sdk5-unreal-initsdk-return"></a>

En cas de succès, renvoie un `InitSdkOutcome` objet indiquant que le processus serveur est prêt à être appelé[ProcessReady()](#integration-server-sdk5-unreal-processready). 

### Exemple
<a name="integration-server-sdk5-unreal-initsdk-example"></a>

```
//Call InitSDK to establish a local connection with the Amazon GameLift Servers Agent to enable further communication.
FGameLiftGenericOutcome initSdkOutcome = GameLiftSdkModule->InitSDK();
```

## InitSDK()
<a name="integration-server-sdk5-unreal-initsdk-anywhere"></a>

Initialise le Amazon GameLift Servers SDK pour une flotte Anywhere ou une flotte de conteneurs gérés. Appelez cette méthode au lancement, avant que toute autre initialisation associée ne se Amazon GameLift Servers produise. Cette méthode nécessite des paramètres de serveur explicites pour configurer la communication entre le serveur et le Amazon GameLift Servers service. Il utilise un jeton d'idempuissance, de sorte que vous pouvez réessayer cet appel en toute sécurité en cas d'échec.

### Syntaxe
<a name="integration-server-sdk5-unreal-initsdk-anywhere-syntax"></a>

```
FGameLiftGenericOutcome InitSDK(serverParameters)
```

### Parameters
<a name="integration-server-sdk5-unreal-initsdk-anywhere-parameter"></a>

[FServerParamètres](integration-server-sdk5-unreal-datatypes.md#integration-server-sdk5-unreal-dataypes-serverparameters)  
Pour initialiser un serveur de jeu sur une flotte Amazon GameLift Servers Anywhere, créez un `ServerParameters` objet avec les informations suivantes :  
+ URL WebSocket utilisée pour vous connecter à votre serveur de jeu. 
+ ID du processus utilisé pour héberger votre serveur de jeu. 
+ L'ID de l'ordinateur hébergeant les processus de votre serveur de jeu. 
+ L'ID du Amazon GameLift Servers parc contenant votre ordinateur Amazon GameLift Servers Anywhere.
+ Le jeton d'autorisation généré par l'Amazon GameLift Serversopération. 

### Valeur renvoyée
<a name="integration-server-sdk5-unreal-initsdk-anywhere-return"></a>

En cas de succès, renvoie un `InitSdkOutcome` objet indiquant que le processus serveur est prêt à être appelé[ProcessReady()](#integration-server-sdk5-unreal-processready). 

**Note**  
Si les appels à échouent pour `InitSDK()` les builds de jeu déployés sur des flottes Anywhere, vérifiez le `ServerSdkVersion` paramètre utilisé lors de la création de la ressource de build. Vous devez définir explicitement cette valeur en fonction de la version du SDK du serveur utilisée. La valeur par défaut de ce paramètre est 4.x, ce qui n'est pas compatible. Pour résoudre ce problème, créez une nouvelle version et déployez-la sur une nouvelle flotte.

### Exemple
<a name="integration-server-sdk5-unreal-initsdk-anywhere-example"></a>

```
//Define the server parameters
FServerParameters serverParameters;
parameters.m_authToken = "1111aaaa-22bb-33cc-44dd-5555eeee66ff"; 
parameters.m_fleetId = "arn:aws:gamelift:us-west-1:111122223333:fleet/fleet-9999ffff-88ee-77dd-66cc-5555bbbb44aa";
parameters.m_hostId = "HardwareAnywhere"; 
parameters.m_processId = "PID1234";
parameters.m_webSocketUrl = "wss://us-west-1.api.amazongamelift.com"; 

//Call InitSDK to establish a local connection with the Amazon GameLift Servers Agent to enable further communication.
FGameLiftGenericOutcome initSdkOutcome = GameLiftSdkModule->InitSDK(serverParameters);
```

## ProcessReady()
<a name="integration-server-sdk5-unreal-processready"></a>

Amazon GameLift ServersIndique que le processus du serveur est prêt à héberger des sessions de jeu. Appelez cette méthode après l'avoir invoquée. [InitSDK()](#integration-server-sdk5-unreal-initsdk) Cette méthode ne doit être appelée qu'une seule fois par processus.

### Syntaxe
<a name="integration-server-sdk5-unreal-processready-syntax"></a>

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

### Parameters
<a name="integration-server-sdk5-unreal-processready-parameter"></a>

**processParameters**  
[FProcessParamètres](integration-server-sdk5-unreal-datatypes.md#integration-server-sdk5-unreal-dataypes-process)Objet communiquant les informations suivantes concernant le processus du serveur :  
+ Noms des méthodes de rappel implémentées dans le code du serveur de jeu que le Amazon GameLift Servers service invoque pour communiquer avec le processus du serveur.
+ Numéro de port sur lequel le processus serveur écoute.
+ Chemin vers les fichiers spécifiques à une session de jeu que vous voulez qu'Amazon GameLift Servers capture et stocke.

### Valeur renvoyée
<a name="integration-server-sdk5-unreal-processready-return"></a>

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

### Exemple
<a name="integration-server-sdk5-unreal-processready-example"></a>

Cet exemple illustre les implémentations de l'appel [ProcessReady()](#integration-server-sdk5-unreal-processready) et de la fonction déléguée.

```
//Calling ProcessReady tells Amazon GameLift Servers this game server is ready to receive incoming game sessions!
UE_LOG(GameServerLog, Log, TEXT("Calling Process Ready"));
FGameLiftGenericOutcome processReadyOutcome = GameLiftSdkModule->ProcessReady(*params);
```

## ProcessEnding()
<a name="integration-server-sdk5-unreal-processending"></a>

Amazon GameLift ServersIndique que le processus du serveur est en train de se terminer. Appelez cette méthode après toutes les autres tâches de nettoyage (y compris la fermeture de la session de jeu active) et avant de terminer le processus. En fonction du résultat de`ProcessEnding()`, le processus se termine avec succès (0) ou erreur (-1) et génère un événement de flotte. Si le processus se termine par une erreur, l'événement de flotte généré est`SERVER_PROCESS_TERMINATED_UNHEALTHY`).

### Syntaxe
<a name="integration-server-sdk5-unreal-processending-syntax"></a>

```
FGameLiftGenericOutcome ProcessEnding()
```

### Valeur renvoyée
<a name="integration-server-sdk5-unreal-processending-return"></a>

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

### Exemple
<a name="integration-server-sdk5-unreal-processending-example"></a>

```
//OnProcessTerminate callback. Amazon GameLift Servers will invoke this callback before shutting down an instance hosting this game server.
//It gives this game server a chance to save its state, communicate with services, etc., before being shut down.
//In this case, we simply tell Amazon GameLift Servers we are indeed going to shutdown.
params->OnTerminate.BindLambda([=]() {
  UE_LOG(GameServerLog, Log, TEXT("Game Server Process is terminating"));
  GameLiftSdkModule->ProcessEnding();
});
```

## ActivateGameSession()
<a name="integration-server-sdk5-unreal-activategamesession"></a>

Amazon GameLift ServersIndique que le processus du serveur a activé une session de jeu et qu'il est maintenant prêt à recevoir les connexions des joueurs. Cette action doit être appelée dans le cadre de la fonction de `onStartGameSession()` rappel, après toute initialisation de session de jeu.

### Syntaxe
<a name="integration-server-sdk5-unreal-activategamesession-syntax"></a>

```
FGameLiftGenericOutcome ActivateGameSession()
```

### Valeur renvoyée
<a name="integration-server-sdk5-unreal-activategamesession-return"></a>

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

### Exemple
<a name="integration-server-sdk5-unreal-activategamesession-example"></a>

Cet exemple montre l'`ActivateGameSession()`appel dans le cadre de la fonction de `onStartGameSession()` délégation. 

```
//When a game session is created, Amazon GameLift Servers sends an activation request to the game server and passes along the game session object containing game properties and other settings.
//Here is where a game server should take action based on the game session object.
//Once the game server is ready to receive incoming player connections, it should invoke GameLiftServerAPI.ActivateGameSession()
auto onGameSession = [=](Aws::GameLift::Server::Model::GameSession gameSession)
{
  FString gameSessionId = FString(gameSession.GetGameSessionId());
  UE_LOG(GameServerLog, Log, TEXT("GameSession Initializing: %s"), *gameSessionId);
  GameLiftSdkModule->ActivateGameSession();
};
```

## UpdatePlayerSessionCreationPolicy()
<a name="integration-server-sdk5-unreal-updateplayersessioncreationpolicy"></a>

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.

### Syntaxe
<a name="integration-server-sdk5-unreal-updateplayersessioncreationpolicy-syntax"></a>

```
FGameLiftGenericOutcome UpdatePlayerSessionCreationPolicy(EPlayerSessionCreationPolicy policy)
```

### Parameters
<a name="integration-server-sdk5-unreal-updateplayersessioncreationpolicy-parameter"></a>

**playerCreationSessionPolitique**  
Valeur de chaîne indiquant si la session de jeu accepte ou non de nouveaux joueurs.   
Les valeurs valides sont les suivantes :  
+ **ACCEPT\$1ALL — Accepte toutes les** sessions de nouveaux joueurs.
+ **DENY\$1ALL — Refuse toutes les** sessions de nouveaux joueurs.

### Valeur renvoyée
<a name="integration-server-sdk5-unreal-updateplayersessioncreationpolicy-return"></a>

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

### Exemple
<a name="integration-server-sdk5-unreal-updateplayersessioncreationpolicy-example"></a>

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.

```
FGameLiftGenericOutcome outcome = GameLiftSdkModule->UpdatePlayerSessionCreationPolicy(Aws::GameLift::Model::EPlayerSessionCreationPolicy::ACCEPT_ALL);
```

## GetGameSessionId()
<a name="integration-server-sdk5-unreal-getgamesessionid"></a>

Récupère l'ID de la session de jeu hébergée par le processus serveur actif. 

Pour les processus inactifs qui ne sont pas activés lors d'une session de jeu, l'appel renvoie un[FGameLiftError](integration-server-sdk5-unreal-datatypes.md#integration-server-sdk5-unreal-dataypes-gamelifterror).

### Syntaxe
<a name="integration-server-sdk5-unreal-getgamesessionid-syntax"></a>

```
FGameLiftStringOutcome GetGameSessionId()
```

### Parameters
<a name="integration-server-sdk5-unreal-getgamesessionid-parameter"></a>

Cette action n'a aucun paramètre.

### Valeur renvoyée
<a name="integration-server-sdk5-unreal-getgamesessionid-return"></a>

En cas de réussite, renvoie l'ID de session de jeu en tant qu'objet [FGameLiftStringOutcome](integration-server-sdk5-unreal-datatypes.md#integration-server-sdk5-unreal-dataypes-awsstringoutcome). En cas d'échec, renvoie un message d'erreur. »

Pour les processus inactifs qui ne sont pas activés lors d'une session de jeu, l'appel renvoie `Success` = `True` et `GameSessionId` =`""`.

### Exemple
<a name="integration-server-sdk5-unreal-getgamesessionid-example"></a>

```
//When a game session is created, Amazon GameLift Servers sends an activation request to the game server and passes along the game session object containing game properties and other settings.
//Here is where a game server should take action based on the game session object.
//Once the game server is ready to receive incoming player connections, it should invoke GameLiftServerAPI.ActivateGameSession()
auto onGameSession = [=](Aws::GameLift::Server::Model::GameSession gameSession)
{
  FString gameSessionId = FString(gameSession.GetGameSessionId());
  UE_LOG(GameServerLog, Log, TEXT("GameSession Initializing: %s"), *gameSessionId);
  GameLiftSdkModule->ActivateGameSession();
};
```

## GetTerminationTime()
<a name="integration-server-sdk5-unreal-getterm"></a>

Renvoie l'heure d'arrêt planifiée pour un processus serveur, si une heure de résiliation est disponible. Un processus serveur prend des mesures après avoir reçu un `onProcessTerminate()` rappel deAmazon GameLift Servers. Amazon GameLift Serversappels `onProcessTerminate()` pour les raisons suivantes : 
+ Lorsque le processus du serveur a signalé un mauvais état de santé ou n'a pas réponduAmazon GameLift Servers.
+ Lorsque vous mettez fin à l'instance lors d'un événement de réduction de la taille.
+ Lorsqu'une instance est interrompue en raison d'une interruption [ponctuelle](spot-tasks.md).

### Syntaxe
<a name="integration-server-sdk5-unreal-getterm-syntax"></a>

```
AwsDateTimeOutcome GetTerminationTime()
```

### Valeur renvoyée
<a name="integration-server-sdk5-unreal-getterm-return"></a>

En cas de succès, renvoie l'heure de fin sous forme d'`AwsDateTimeOutcome`objet. La valeur est le délai de résiliation, 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 à celle `637355968000000000` des ticks. Si aucune heure de résiliation n'est disponible, renvoie un message d'erreur.

Si le processus n'a pas reçu de ` ProcessParameters.OnProcessTerminate()` rappel, un message d'erreur est renvoyé. Pour plus d'informations sur l'arrêt d'un processus serveur, consultez[Répondre à une notification d'arrêt du processus du serveur](gamelift-sdk-server-api.md#gamelift-sdk-server-terminate).

### Exemple
<a name="integration-server-sdk5-unreal-getterm-example"></a>

```
AwsDateTimeOutcome TermTimeOutcome = GameLiftSdkModule->GetTerminationTime();
```

## AcceptPlayerSession()
<a name="integration-server-sdk5-unreal-acceptplayersession"></a>

Amazon GameLift ServersIndique qu'un joueur avec l'identifiant de session de joueur spécifié s'est connecté au processus du serveur et doit être validé. Amazon GameLift Serversvérifie que l'identifiant de session du joueur est valide. Une fois la session du joueur validée, le statut de l'emplacement du joueur Amazon GameLift Servers passe de RÉSERVÉ à ACTIF. 

### Syntaxe
<a name="integration-server-sdk5-unreal-acceptplayersession-syntax"></a>

```
FGameLiftGenericOutcome AcceptPlayerSession(const FString& playerSessionId)
```

### Parameters
<a name="integration-server-sdk5-unreal-acceptplayersession-parameter"></a>

playerSessionId  
Identifiant unique émis Amazon GameLift Servers lors de la création d'une nouvelle session de joueur.

### Valeur renvoyée
<a name="integration-server-sdk5-unreal-acceptplayersession-return"></a>

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

### Exemple
<a name="integration-server-sdk5-unreal-acceptplayersession-example"></a>

Cet exemple traite une demande de connexion qui inclut la validation et le rejet d'une session de joueur non valide. IDs

```
bool GameLiftManager::AcceptPlayerSession(const FString& playerSessionId, const FString& playerId)
{
  #if WITH_GAMELIFT
  UE_LOG(GameServerLog, Log, TEXT("Accepting GameLift PlayerSession: %s . PlayerId: %s"), *playerSessionId, *playerId);
  FString gsId = GetCurrentGameSessionId();
  if (gsId.IsEmpty()) {
    UE_LOG(GameServerLog, Log, TEXT("No GameLift GameSessionId. Returning early!"));
    return false;
  }
  
  if (!GameLiftSdkModule->AcceptPlayerSession(playerSessionId).IsSuccess()) {
    UE_LOG(GameServerLog, Log, TEXT("PlayerSession not Accepted."));
    return false;
  }

  // Add PlayerSession from internal data structures keeping track of connected players
  connectedPlayerSessionIds.Add(playerSessionId);
  idToPlayerSessionMap.Add(playerSessionId, PlayerSession{ playerId, playerSessionId });
  return true;
  #else
  return false;
  #endif
}
```

## RemovePlayerSession()
<a name="integration-server-sdk5-unreal-removeplayersession"></a>

Indique Amazon GameLift Servers qu'un joueur s'est déconnecté du processus serveur. En réponse, Amazon GameLift Servers change l'emplacement du joueur pour le rendre disponible. 

### Syntaxe
<a name="integration-server-sdk5-unreal-removeplayersession-syntax"></a>

```
FGameLiftGenericOutcome RemovePlayerSession(const FString& playerSessionId)
```

### Parameters
<a name="integration-server-sdk5-unreal-removeplayersession-parameter"></a>

**`playerSessionId`**  
Identifiant unique émis Amazon GameLift Servers lors de la création d'une nouvelle session de joueur.

### Valeur renvoyée
<a name="integration-server-sdk5-unreal-removeplayersession-return"></a>

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

### Exemple
<a name="integration-server-sdk5-unreal-removeplayersession-example"></a>

```
bool GameLiftManager::RemovePlayerSession(const FString& playerSessionId)
{
  #if WITH_GAMELIFT
  UE_LOG(GameServerLog, Log, TEXT("Removing GameLift PlayerSession: %s"), *playerSessionId);

  if (!GameLiftSdkModule->RemovePlayerSession(playerSessionId).IsSuccess()) {
    UE_LOG(GameServerLog, Log, TEXT("PlayerSession Removal Failed"));
    return false;
  }

  // Remove PlayerSession from internal data structures that are keeping track of connected players
  connectedPlayerSessionIds.Remove(playerSessionId);
  idToPlayerSessionMap.Remove(playerSessionId);

  // end the session if there are no more players connected
  if (connectedPlayerSessionIds.Num() == 0) {
    EndSession();
  }

  return true;
  #else
  return false;
  #endif
}
```

## DescribePlayerSessions()
<a name="integration-server-sdk5-unreal-describeplayersessions"></a>

Récupère les données de session du joueur, notamment les paramètres, les métadonnées de session et les données du joueur. Utilisez cette méthode pour obtenir des informations sur les points suivants :
+ Une session solo
+ Toutes les sessions des joueurs dans une session de jeu
+ Toutes les sessions de joueur associées à un identifiant de joueur unique

### Syntaxe
<a name="integration-server-sdk5-unreal-describeplayersessions-syntax"></a>

```
FGameLiftDescribePlayerSessionsOutcome DescribePlayerSessions(const FGameLiftDescribePlayerSessionsRequest &describePlayerSessionsRequest)
```

### Parameters
<a name="integration-server-sdk5-unreal-describeplayersessions-parameter"></a>

**[FGameLiftDescribePlayerSessionsRequest](integration-server-sdk5-unreal-datatypes.md#integration-server-sdk5-unreal-dataypes-playersessions)**  
[FGameLiftDescribePlayerSessionsRequest](integration-server-sdk5-unreal-datatypes.md#integration-server-sdk5-unreal-dataypes-playersessions)Objet qui décrit les sessions de joueur à récupérer.

### Valeur renvoyée
<a name="integration-server-sdk5-unreal-describeplayersessions-return"></a>

En cas de réussite, renvoie un objet [FGameLiftDescribePlayerSessionsOutcome](integration-server-sdk5-unreal-datatypes.md#integration-server-sdk5-unreal-dataypes-describeplayersessionsoutcome) qui contient un ensemble d'objets de session de joueur correspondant aux paramètres de la demande.

### Exemple
<a name="integration-server-sdk5-unreal-describeplayersessions-example"></a>

Cet exemple demande toutes les sessions de joueur activement connectées à une session de jeu spécifiée. En omettant *NextToken*et en définissant la valeur *limite* sur 10, Amazon GameLift Servers renvoie les 10 premiers enregistrements de session de joueur correspondant à la demande.

```
void GameLiftManager::DescribePlayerSessions()
{
  #if WITH_GAMELIFT
  FString localPlayerSessions;
  for (auto& psId : connectedPlayerSessionIds)
  {
    PlayerSession ps = idToPlayerSessionMap[psId];
    localPlayerSessions += FString::Printf(TEXT("%s : %s  ; "), *(ps.playerSessionId), *(ps.playerId));
  }
  UE_LOG(GameServerLog, Log, TEXT("LocalPlayerSessions: %s"), *localPlayerSessions);

  UE_LOG(GameServerLog, Log, TEXT("Describing PlayerSessions in this GameSession"));
  FGameLiftDescribePlayerSessionsRequest request;
  request.m_gameSessionId = GetCurrentGameSessionId();

  FGameLiftDescribePlayerSessionsOutcome outcome = GameLiftSdkModule->DescribePlayerSessions(request);
  LogDescribePlayerSessionsOutcome(outcome);
  #endif
}
```

## StartMatchBackfill()
<a name="integration-server-sdk5-unreal-startmatchbackfill"></a>

Envoie une demande de recherche de nouveaux joueurs pour des emplacements ouverts dans une session de jeu créée avec FlexMatch. Pour plus d'informations, voir la [fonction de FlexMatch remblayage](https://docs.aws.amazon.com/gameliftservers/latest/flexmatchguide/match-backfill.html).

Cette action est asynchrone. Si de nouveaux joueurs sont jumelés, Amazon GameLift Servers fournit des données de matchmaking mises à jour à l'aide de 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()](#integration-server-sdk5-unreal-stopmatchbackfill) pour annuler la requête d'origine.

### Syntaxe
<a name="integration-server-sdk5-unreal-startmatchbackfill-syntax"></a>

```
FGameLiftStringOutcome StartMatchBackfill (FStartMatchBackfillRequest &startBackfillRequest);
```

### Parameters
<a name="integration-server-sdk5-unreal-startmatchbackfill-parameter"></a>

**[FStartMatchBackfillRequest](integration-server-sdk5-unreal-datatypes.md#integration-server-sdk5-unreal-dataypes-startmatchbackfillrequest)**  
Un StartMatchBackfillRequest objet qui communique les informations suivantes :  
+ ID de ticket à attribuer à la requête de renvoi. Ces informations sont facultatives ; si aucun identifiant n'est fourni, il en Amazon GameLift Servers générera un.
+ Matchmaker auquel envoyer la requête. L'ARN de configuration complet est obligatoire. Cette valeur se trouve dans les données du matchmaker de la session de jeu.
+ ID de la session de jeu à compléter.
+ Les données de matchmaking disponibles pour les joueurs actuels de la session de jeu.

### Valeur renvoyée
<a name="integration-server-sdk5-unreal-startmatchbackfill-return"></a>

Renvoie un `StartMatchBackfillOutcome` objet avec l'identifiant du ticket de remplacement correspondant, ou un échec avec un message d'erreur. 

### Exemple
<a name="integration-server-sdk5-unreal-startmatchbackfill-example"></a>

```
FGameLiftStringOutcome FGameLiftServerSDKModule::StartMatchBackfill(const FStartMatchBackfillRequest& request) 
{
  #if WITH_GAMELIFT
  Aws::GameLift::Server::Model::StartMatchBackfillRequest sdkRequest;
  sdkRequest.SetTicketId(TCHAR_TO_UTF8(*request.m_ticketId));
  sdkRequest.SetGameSessionArn(TCHAR_TO_UTF8(*request.m_gameSessionArn));
  sdkRequest.SetMatchmakingConfigurationArn(TCHAR_TO_UTF8(*request.m_matchmakingConfigurationArn));
  for (auto player : request.m_players) {
    Aws::GameLift::Server::Model::Player sdkPlayer;
    sdkPlayer.SetPlayerId(TCHAR_TO_UTF8(*player.m_playerId));
    sdkPlayer.SetTeam(TCHAR_TO_UTF8(*player.m_team));
    for (auto entry : player.m_latencyInMs) {
      sdkPlayer.WithLatencyMs(TCHAR_TO_UTF8(*entry.Key), entry.Value);
    }

    std::map<std::string, Aws::GameLift::Server::Model::AttributeValue> sdkAttributeMap;
    for (auto attributeEntry : player.m_playerAttributes) {
      FAttributeValue value = attributeEntry.Value;
      Aws::GameLift::Server::Model::AttributeValue attribute;
      switch (value.m_type) {
        case FAttributeType::STRING:
          attribute = Aws::GameLift::Server::Model::AttributeValue(TCHAR_TO_UTF8(*value.m_S));
        break;
        case FAttributeType::DOUBLE:
          attribute = Aws::GameLift::Server::Model::AttributeValue(value.m_N);
        break;
        case FAttributeType::STRING_LIST:
          attribute = Aws::GameLift::Server::Model::AttributeValue::ConstructStringList();
          for (auto sl : value.m_SL) {
            attribute.AddString(TCHAR_TO_UTF8(*sl));
          };
        break;
        case FAttributeType::STRING_DOUBLE_MAP:
          attribute = Aws::GameLift::Server::Model::AttributeValue::ConstructStringDoubleMap();
          for (auto sdm : value.m_SDM) {
            attribute.AddStringAndDouble(TCHAR_TO_UTF8(*sdm.Key), sdm.Value);
          };
        break;
      }
      sdkPlayer.WithPlayerAttribute((TCHAR_TO_UTF8(*attributeEntry.Key)), attribute);
    }
    sdkRequest.AddPlayer(sdkPlayer);
  }
  auto outcome = Aws::GameLift::Server::StartMatchBackfill(sdkRequest);
  if (outcome.IsSuccess()) {
    return FGameLiftStringOutcome(outcome.GetResult().GetTicketId());
  }
  else {
    return FGameLiftStringOutcome(FGameLiftError(outcome.GetError()));
  }
  #else
  return FGameLiftStringOutcome("");
  #endif
}
```

## StopMatchBackfill()
<a name="integration-server-sdk5-unreal-stopmatchbackfill"></a>

Annule une demande de remplacement de match active. Pour plus d'informations, voir la [fonction de FlexMatch remblayage](https://docs.aws.amazon.com/gameliftservers/latest/flexmatchguide/match-backfill.html).

### Syntaxe
<a name="integration-server-sdk5-unreal-stopmatchbackfill-syntax"></a>

```
FGameLiftGenericOutcome StopMatchBackfill (FStopMatchBackfillRequest &stopBackfillRequest);
```

### Parameters
<a name="integration-server-sdk5-unreal-stopmatchbackfill-parameter"></a>

**[FStopMatchBackfillRequest](integration-server-sdk5-unreal-datatypes.md#integration-server-sdk5-unreal-dataypes-stopmatchbackfillrequest)**  
Un StopMatchBackfillRequest objet identifiant le ticket de matchmaking à annuler :   
+ L'identifiant du ticket attribué à la demande de remblayage.
+ L'entremetteur à qui la demande de remblayage a été envoyée.
+ La session de jeu associée à la demande de remplacement.

### Valeur renvoyée
<a name="integration-server-sdk5-unreal-stopmatchbackfill-return"></a>

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

### Exemple
<a name="integration-server-sdk5-unreal-stopmatchbackfill-example"></a>

```
FGameLiftGenericOutcome FGameLiftServerSDKModule::StopMatchBackfill(const FStopMatchBackfillRequest& request)
{
  #if WITH_GAMELIFT
  Aws::GameLift::Server::Model::StopMatchBackfillRequest sdkRequest;
  sdkRequest.SetTicketId(TCHAR_TO_UTF8(*request.m_ticketId));
  sdkRequest.SetGameSessionArn(TCHAR_TO_UTF8(*request.m_gameSessionArn));
  sdkRequest.SetMatchmakingConfigurationArn(TCHAR_TO_UTF8(*request.m_matchmakingConfigurationArn));
  auto outcome = Aws::GameLift::Server::StopMatchBackfill(sdkRequest);
  if (outcome.IsSuccess()) {
    return FGameLiftGenericOutcome(nullptr);
  }
  else {
    return FGameLiftGenericOutcome(FGameLiftError(outcome.GetError()));
  }
  #else
  return FGameLiftGenericOutcome(nullptr);
  #endif
}
```

## GetComputeCertificate()
<a name="integration-server-sdk5-unreal-getcomputecertificate"></a>

Récupère le chemin d'accès au certificat TLS utilisé pour chiffrer la connexion réseau entre votre ressource de calcul Amazon GameLift Servers Anywhere et. Amazon GameLift Servers Vous pouvez utiliser le chemin du certificat lorsque vous enregistrez votre appareil informatique dans un parc Amazon GameLift Servers Anywhere. Pour plus d'informations, voir, [RegisterCompute](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html).

### Syntaxe
<a name="integration-server-sdk5-unreal-getcomputecertificate-syntax"></a>

```
FGameLiftGetComputeCertificateOutcome FGameLiftServerSDKModule::GetComputeCertificate()
```

### Valeur renvoyée
<a name="integration-server-sdk5-unreal-getcomputecertificate-return"></a>

Renvoie un `GetComputeCertificateResponse` objet contenant les éléments suivants : 
+ CertificatePath: chemin d'accès au certificat TLS sur votre ressource de calcul. 
+ HostName: nom d'hôte de votre ressource de calcul.

### Exemple
<a name="integration-server-sdk5-unreal-getcomputecertificate-example"></a>

```
FGameLiftGetComputeCertificateOutcome FGameLiftServerSDKModule::GetComputeCertificate()
{
  #if WITH_GAMELIFT
  auto outcome = Aws::GameLift::Server::GetComputeCertificate();
  if (outcome.IsSuccess()) {
    auto& outres = outcome.GetResult();
    FGameLiftGetComputeCertificateResult result;
    result.m_certificate_path = UTF8_TO_TCHAR(outres.GetCertificatePath());
    result.m_computeName = UTF8_TO_TCHAR(outres.GetComputeName());
    return FGameLiftGetComputeCertificateOutcome(result);
  }
  else {
    return FGameLiftGetComputeCertificateOutcome(FGameLiftError(outcome.GetError()));
  }
  #else
  return FGameLiftGetComputeCertificateOutcome(FGameLiftGetComputeCertificateResult());
  #endif
}
```

## GetFleetRoleCredentials()
<a name="integration-server-sdk5-unreal-getfleetrolecredentials"></a>

Récupère les informations d'identification du rôle IAM qui autorisent l'interaction avec Amazon GameLift Servers d'autres utilisateurs. Services AWS Pour de plus amples informations, veuillez consulter [Connectez votre serveur de jeu Amazon GameLift Servers hébergé à d'autres AWS ressources](gamelift-sdk-server-resources.md).

### Syntaxe
<a name="integration-server-sdk5-unreal-getfleetrolecredentials-syntax"></a>

```
FGameLiftGetFleetRoleCredentialsOutcome FGameLiftServerSDKModule::GetFleetRoleCredentials(const FGameLiftGetFleetRoleCredentialsRequest &request)
```

### Parameters
<a name="integration-server-sdk5-unreal-getfleetrolecredentials-parameters"></a>

[FGameLiftGetFleetRoleCredentialsRequest](integration-server-sdk5-unreal-datatypes.md#integration-server-sdk5-unreal-dataypes-getfleetrolecredentialsrequest)

### Valeur renvoyée
<a name="integration-server-sdk5-unreal-getfleetrolecredentials-return"></a>

Renvoie un objet [FGameLiftGetFleetRoleCredentialsOutcome](integration-server-sdk5-unreal-datatypes.md#integration-server-sdk5-unreal-dataypes-getfleetrolecredentialsoutcome).

### Exemple
<a name="integration-server-sdk5-unreal-getfleetrolecredentials-example"></a>

```
FGameLiftGetFleetRoleCredentialsOutcome FGameLiftServerSDKModule::GetFleetRoleCredentials(const FGameLiftGetFleetRoleCredentialsRequest &request)
{
  #if WITH_GAMELIFT
  Aws::GameLift::Server::Model::GetFleetRoleCredentialsRequest sdkRequest;
  sdkRequest.SetRoleArn(TCHAR_TO_UTF8(*request.m_roleArn));
  sdkRequest.SetRoleSessionName(TCHAR_TO_UTF8(*request.m_roleSessionName));

  auto outcome = Aws::GameLift::Server::GetFleetRoleCredentials(sdkRequest);

  if (outcome.IsSuccess()) {
    auto& outres = outcome.GetResult();
    FGameLiftGetFleetRoleCredentialsResult result;
    result.m_assumedUserRoleArn = UTF8_TO_TCHAR(outres.GetAssumedUserRoleArn());
    result.m_assumedRoleId = UTF8_TO_TCHAR(outres.GetAssumedRoleId());
    result.m_accessKeyId = UTF8_TO_TCHAR(outres.GetAccessKeyId());
    result.m_secretAccessKey = UTF8_TO_TCHAR(outres.GetSecretAccessKey());
    result.m_sessionToken = UTF8_TO_TCHAR(outres.GetSessionToken());
    result.m_expiration = FDateTime::FromUnixTimestamp(outres.GetExpiration());
    return FGameLiftGetFleetRoleCredentialsOutcome(result);
  }
  else {
    return FGameLiftGetFleetRoleCredentialsOutcome(FGameLiftError(outcome.GetError()));
  }
  #else
  return FGameLiftGetFleetRoleCredentialsOutcome(FGameLiftGetFleetRoleCredentialsResult());
  #endif
}
```

## Détruire ()
<a name="integration-server-sdk5-unreal-ref-destroy"></a>

Libère de la mémoire le SDK du serveur de Amazon GameLift Servers jeu. Il est recommandé d'appeler cette méthode après `ProcessEnding()` et avant de terminer le processus. Si vous utilisez une flotte Anywhere et que vous n'interrompez pas les processus du serveur après chaque session de jeu, appelez `Destroy()` puis `InitSDK()` réinitialisez avant de signaler Amazon GameLift Servers que le processus est prêt à héberger une session de jeu avec. `ProcessReady()`

### Syntaxe
<a name="integration-server-sdk5-unreal-ref-destroy-syntax"></a>

```
FGameLiftGenericOutcome Destroy();
```

### Parameters
<a name="integration-server-sdk5-unreal-ref-destroy-parameter"></a>

Il n'y a aucun paramètre.

### Valeur renvoyée
<a name="integration-server-sdk5-unreal-ref-destroy-return"></a>

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

### Exemple
<a name="integration-server-sdk5-unreal-ref-destroy-example"></a>

```
// First call ProcessEnding()
FGameLiftGenericOutcome processEndingOutcome = GameLiftSdkModule->ProcessEnding();
  
// Then call Destroy() to free the SDK from memory
FGameLiftGenericOutcome destroyOutcome = GameLiftSdkModule->Destroy();
  
// Exit the process with success or failure
if (processEndingOutcome.IsSuccess() && destroyOutcome.IsSuccess()) 
    {
    UE_LOG(GameServerLog, Log, TEXT("Server process ending successfully"));
}
else {
    if (!processEndingOutcome.IsSuccess()) {
        const FGameLiftError& error = processEndingOutcome.GetError();
        UE_LOG(GameServerLog, Error, TEXT("ProcessEnding() failed. Error: %s"),
        error.m_errorMessage.IsEmpty() ? TEXT("Unknown error") : *error.m_errorMessage);
    }
    if (!destroyOutcome.IsSuccess()) {
        const FGameLiftError& error = destroyOutcome.GetError();
        UE_LOG(GameServerLog, Error, TEXT("Destroy() failed. Error: %s"),
        error.m_errorMessage.IsEmpty() ? TEXT("Unknown error") : *error.m_errorMessage);
    }
}
```