View a markdown version of this page

SDK 5.x du serveur C++ pour GameLift Serveurs Amazon -- Types de données - GameLift Serveurs Amazon
LogParametersMetricsParametersCustomLoggerConfigurationProcessParametersUpdateGameSessionGameSessionServerParametersStartMatchBackfillRequestJoueurDescribePlayerSessionsRequestStopMatchBackfillRequestAttributeValueGetFleetRoleCredentialsRequestAwsLongOutcomeAwsStringOutcomeDescribePlayerSessionsOutcomeDescribePlayerSessionsResultGenericOutcomeGenericOutcomeCallablePlayerSessionStartMatchBackfillOutcomeStartMatchBackfillResultGetComputeCertificateOutcomeGetComputeCertificateResultGetFleetRoleCredentialsOutcomeGetFleetRoleCredentialsResultListContainersNetworkInfoOutcomeListContainersNetworkInfoResultContainerNetworkInfoDans son résultat en matière de SDKGameLiftErrorEnums

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 5.x du serveur C++ pour GameLift Serveurs Amazon -- Types de données

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

Note

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

SDK 5.x du serveur C++ pour GameLift Serveurs Amazon -- Actions

LogParameters

Objet identifiant les fichiers générés pendant une session de jeu que vous souhaitez télécharger et stocker Amazon GameLift Servers à 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() appel.

Propriétés

 Description
LogPaths

La liste des chemins d'accès aux fichiers journaux du serveur de jeu que vous Amazon GameLift Servers souhaitez stocker pour y accéder ultérieurement. Le processus serveur génère ces fichiers à 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 de construction du jeu.

Les chemins de journalisation doivent être absolus. Par exemple, si la version de votre jeu stocke les journaux de session de jeu dans un chemin tel queMyGame\sessionLogs\, alors le chemin se trouverait c:\game\MyGame\sessionLogs sur une instance Windows.

Type : std:vector<std::string>

Obligatoire : non

MetricsParameters

Utilisez ce type de données pour configurer la collecte de métriques et les rapports d'erreur pour le serveur de jeu. Le serveur de jeu communique avec MetricsParameters Amazon GameLift Servers lors d'un 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 Crash Reporter.

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 des métriques vers le serveur.

Type : int

Obligatoire : non
MaxPacketSize

Taille maximale en octets pour les paquets de métriques envoyés au serveur.

Type : int

Obligatoire : non

CustomLoggerConfiguration

Utilisez ce type de données pour acheminer la sortie du journal du SDK du serveur vers un rappel de journal personnalisé. Le serveur de jeu communique avec CustomLoggerConfiguration Amazon GameLift Servers lors d'un InitCustomLogger() appel.

Propriétés

 Description
rappel

Amazon GameLift Serversinvoque cette fonction de rappel pour chaque message de journal. La fonction reçoit le niveau de journalisation, la chaîne de message préformatée et le pointeur de userData contexte. Le pointeur de message n'est valide que pendant la durée de l'appel de rappel ; copiez le message si vous souhaitez le conserver. Le SDK sérialise les appels de rappel, mais n'importe quel thread peut invoquer le rappel. Cette valeur ne doit pas être null ; l'opération rejette un null rappel avecBAD_REQUEST_EXCEPTION.

Tapez : Aws::GameLift::Server::LogCallback (void(*)(LogLevel level, const char* message, void* userData))

Obligatoire : oui
userData

Un pointeur de contexte fourni par l'utilisateur qui Amazon GameLift Servers passe au rappel à chaque appel. Le SDK ne gère pas sa durée de vie. Ce pointeur doit rester valide jusqu'à la fin du processus.

Type : void*

Obligatoire : non
minimum LogLevel

Le niveau de journalisation minimum pour le SDK. Amazon GameLift Serversn'invoquera pas le rappel fourni pour les journaux inférieurs à ce niveau. La valeur par défaut est LogLevel::Info. Pour désactiver la journalisation, définissez cette valeur surLogLevel::Off.

Type : valeur Aws::GameLift::Server::LogLevel d'énumération

Obligatoire : non

ProcessParameters

Ce type de données contient l'ensemble de paramètres envoyé à Amazon GameLift Servers dans ProcessReady() a.

Propriétés

 Description
LogParameters Un 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 ultérieur.

Type : Aws::GameLift::Server::LogParameters

Obligatoire : non
OnHealthCheck La fonction de rappel qui Amazon GameLift Servers permet de demander un rapport d'état de santé au processus serveur. Amazon GameLift Serversappelle cette fonction toutes les 60 secondes et attend 60 secondes pour obtenir une réponse. Le processus du serveur revient TRUE s'il est en bon état, FALSE sinon s'il n'est pas sain. Si aucune réponse n'est renvoyée, Amazon GameLift Servers enregistre le processus du serveur comme étant incorrect.

Type : std::function<bool()> onHealthCheck

Obligatoire : non
OnProcessTerminate La fonction de rappel Amazon GameLift Servers invoquée pour forcer l'arrêt du processus serveur. Après avoir appelé cette fonction, Amazon GameLift Servers attend 5 minutes que le processus serveur s'arrête et répond par un ProcessEnding() appel avant d'arrêter le processus serveur.

Type : std::function<void()> onProcessTerminate

Obligatoire : oui
OnStartGameSession La fonction de rappel qui Amazon GameLift Servers permet d'activer une nouvelle session de jeu. Amazon GameLift Serversappelle cette fonction en réponse à une demande du client CreateGameSession. La fonction de rappel transmet un GameSession objet.

Type : const std::function<void(Aws::GameLift::Model::GameSession)> onStartGameSession

Obligatoire : oui
OnUpdateGameSession Fonction de rappel qui Amazon GameLift Servers permet de transmettre un objet de session de jeu mis à jour au processus 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 objet, une mise à jour de statut (updateReason) et l'identifiant du ticket de remplacement correspondant.

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

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 remplacement associé si le remplissage est utilisé pour compléter les sessions des joueurs pendant la session de jeu.

Propriétés Description
GameSession Un objet 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

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

Propriétés Description
GameSessionId

Un 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

Une étiquette descriptive de la session de jeu.

Type : std::string

Obligatoire : non
FleetId

Un identifiant unique pour 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 qui a été utilisé pour créer la session de jeu, en syntaxe JSON, sous forme de chaîne. Outre la configuration de matchmaking utilisée, elle contient des données sur tous les joueurs assigné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

L'identifiant DNS attribué à l'instance qui exécute la session de jeu. Les valeurs ont le format suivant :

  • TLS-enabled flottes :<unique identifier>.<region identifier>.amazongamelift.com.

  • Non-TLS-enabled flottes :ec2-<unique identifier>.compute.amazonaws.com.

Lorsque vous vous connectez à une session de jeu exécutée sur une TLS-enabled flotte, vous devez utiliser le nom DNS et non l'adresse IP.

Type : std::string

Obligatoire : non

ServerParameters

Informations utilisées par un processus de serveur de jeu pour établir une connexion avec le Amazon GameLift Servers service. N'incluez ces paramètres lors des appels InitSDK() 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() sans paramètres.

Propriétés Description
web SocketUrl

Le GameLiftServerSdkEndpoint Amazon GameLift Servers résultat obtenu lorsque vous RegisterCompute recherchez une ressource de calcul Amazon GameLift Servers Anywhere.

Type : std::string

Obligatoire : oui

ID de processus

Un identifiant unique enregistré auprès du processus serveur hébergeant votre jeu.

Type : std::string

Obligatoire : oui
hostId HostIDC'est celui ComputeName utilisé lors de l'enregistrement de votre ordinateur. Pour plus d'informations, voir RegisterCompute.

Type : std::string

Obligatoire : oui
ID de flotte L'identifiant unique de la flotte dans laquelle le calcul est enregistré. Pour plus d'informations, voir RegisterCompute.

Type : std::string

Obligatoire : oui
Jeton d'authentification Le jeton d'authentification généré permet Amazon GameLift Servers d'authentifier votre serveur auprès deAmazon GameLift Servers. Pour plus d'informations, voir GetComputeAuthToken.

Type : std::string

Obligatoire : oui

StartMatchBackfillRequest

Informations utilisées pour créer une demande de remplissage de matchmaking. Le serveur de jeu communique ces informations Amazon GameLift Servers lors d'un StartMatchBackfill() appel.

Propriétés Description
GameSessionArn

Un identifiant de session de jeu unique. L'opération d'API GetGameSessionId renvoie l'identifiant au format ARN.

Type : std::string

Obligatoire : oui
MatchmakingConfigurationArn

Un identifiant unique, sous la forme d'un ARN, que le matchmaker doit utiliser pour cette demande. L'ARN du matchmaker pour la session de jeu d'origine se trouve dans l'objet de session de jeu de la propriété de données du matchmaker. Pour en savoir plus sur les données de matchmaking, consultez la section Travailler avec les données de matchmaker.

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 pas de valeur, Amazon GameLift Servers générez-en 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

Ce type de données représente un joueur en matchmaking. Lors du lancement d'une demande de matchmaking, un joueur possède un identifiant de joueur, des attributs et éventuellement des 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 la quantité de latence subie par un joueur lorsqu'il est connecté à un lieu.

Si cette propriété est utilisée, le joueur est sélectionné uniquement pour les 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 des joueurs doivent correspondre à celles PlayerAttributes utilisées dans un ensemble de règles de matchmaking.

Pour plus d'informations sur les attributs des joueurs, consultez AttributeValue.

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 assigné lors d'un match. Vous définissez le nom de l'équipe dans l'ensemble de règles de matchmaking.

Type : std::string

Obligatoire : non

DescribePlayerSessionsRequest

Un objet qui spécifie les sessions de joueur à récupérer. Le processus serveur fournit ces informations en 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'ID de session de jeu estarn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>. GameSessionIDIl s'agit d'une chaîne d'identification personnalisée ou d'un

Type : std::string

Obligatoire : non
PlayerSessionId

L'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.

Type : std::string

Obligatoire : non
PlayerSessionStatusFilter

L'état de la session du joueur sur lequel filtrer les résultats. Les statuts de session de joueur possibles incluent :

  • RÉSERVÉ — La demande de session du joueur a été reçue, mais le joueur ne s'est pas connecté au processus du serveur ou n'a pas été validé.

  • ACTIF — Le joueur a été validé par le processus du serveur et est connecté.

  • TERMINÉ — La connexion du joueur a été interrompue.

  • TIMEDOUT — Une demande de session de joueur a été reçue, mais le joueur ne s'est pas connecté ou n'a pas été validé dans le délai imparti (60 secondes).

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

Informations utilisées pour annuler une demande de remplacement de matchmaking. Le serveur de jeu communique ces informations au Amazon GameLift Servers service lors d'un StopMatchBackfill() appel.

Propriétés Description
GameSessionArn

Un identifiant de session de jeu unique correspondant à la demande en cours d'annulation.

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 remplacement à annuler.

Type : char[]

Obligatoire : non

AttributeValue

Utilisez ces valeurs dans des paires Joueur clé-valeur d'attribut. Cet objet vous permet de spécifier une valeur d'attribut à l'aide de l'un des types de données valides : chaîne, nombre, tableau de chaînes ou carte de données. Chaque AttributeValue objet doit utiliser exactement l'une des propriétés disponibles : SN,SL, ouSDM.

Propriétés Description
AttrType

Spécifie le type de valeur d'attribut. Les types de valeurs d'attribut possibles sont les suivants :

  • NONE

  • FICELLE

  • DOUBLE

  • LISTE_CHAÎNES

  • STRING_DOUBLE_MAP

Obligatoire : non
S

Représente la valeur d'un 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 clés de chaîne et de valeurs doubles.

Type : std::map<std::string, double>

Obligatoire : non

GetFleetRoleCredentialsRequest

Ce type de données donne au serveur de jeu un accès limité à vos autres AWS ressources. Pour plus d'informations, voirConfigurer un rôle de service IAM pour Amazon GameLift Servers.

Propriétés Description
RoleArn Le nom de ressource Amazon (ARN) du rôle de service qui étend l'accès limité à vos AWS ressources.

Type : std::string

Obligatoire : non
RoleSessionName Le nom de session de rôle que vous pouvez utiliser pour identifier une AWS Security Token Service AssumeRole session de manière unique. Ce nom est affiché dans les journaux d'audit tels que ceux figurant dans CloudTrail.

Type : std::string

Obligatoire : non

AwsLongOutcome

Ce type de données résulte d'une action et produit un objet avec les 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 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

Obligatoire : non

AwsStringOutcome

Ce type de données résulte d'une action et produit un objet avec les 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 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

Obligatoire : non

DescribePlayerSessionsOutcome

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

Propriétés Description
Résultat

Le résultat de l'action.

Type : DescribePlayerSessionsResult

Obligatoire : non

ResultWithOwnership

Le résultat de l'action, converti en 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

Obligatoire : non

DescribePlayerSessionsResult

Une 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 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

Obligatoire : non

GenericOutcome

Ce type de données résulte d'une action et produit un objet avec 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

Obligatoire : non

GenericOutcomeCallable

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

Obligatoire : non

PlayerSession

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.

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.

Tapez : Une PlayerSessionStatus énumération. Les valeurs possibles sont notamment les suivantes :

  • ACTIF

  • TERMINÉ

  • NOT_SET

  • RÉSERVÉ

  • TEMPS EXPIRÉ

Obligatoire : non
TerminationTime

Type : long

Obligatoire : non
DnsName

Type : std::string

Obligatoire : non

StartMatchBackfillOutcome

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

Propriétés Description
Résultat

Le résultat de l'action.

Type : StartMatchBackfillResult

Obligatoire : non
ResultWithOwnership

Le résultat de l'action, converti en 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

Obligatoire : non

StartMatchBackfillResult

Ce type de données résulte d'une action et produit un objet avec les 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 des tickets de remplacement des matchs et récupérer les résultats des matchs.

Type : std::string

Obligatoire : non

GetComputeCertificateOutcome

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

Propriétés Description
Résultat

Le résultat de l'action.

Type : GetComputeCertificateResult

Obligatoire : non

ResultWithOwnership

Le résultat de l'action, converti en 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

Obligatoire : non

GetComputeCertificateResult

Le chemin d'accès au certificat TLS de 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 :

  • certificate.pem: le certificat d'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 du certificat d'utilisateur final.

Type : std::string

Obligatoire : non
ComputeName

Le nom de votre ressource de calcul.

Type : std::string

Obligatoire : non

GetFleetRoleCredentialsOutcome

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

Propriétés Description
Résultat

Le résultat de l'action.

Type : GetFleetRoleCredentialsResult

Obligatoire : non

ResultWithOwnership

Le résultat de l'action, converti en 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

Obligatoire : non

GetFleetRoleCredentialsResult

Propriétés Description
AccessKeyId

L'identifiant de la clé d'accès pour authentifier et donner 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

Le délai jusqu'à l'expiration des informations d'identification de votre 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

Obligatoire : non

ListContainersNetworkInfoOutcome

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

Propriétés Description
Résultat

Le résultat de l'action.

Type : ListContainersNetworkInfoResult

Obligatoire : non

ResultWithOwnership

Le résultat de l'action, converti en rvalue, afin que le code appelant puisse s'approprier l'objet.

Type : Aws::GameLift::Server::Model::ListContainersNetworkInfoResult&&

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

Obligatoire : non

ListContainersNetworkInfoResult

Informations réseau pour tous les conteneurs exécutés sur la même instance que le processus du serveur de jeu appelant.

Propriétés Description
ContainersNetworkInfo

La liste des informations réseau pour chaque conteneur exécuté sur l'instance.

Type : std::vector<ContainerNetworkInfo> when GAMELIFT_USE_STD est défini ; sinon, un tableau fixe avec un accesseur nomméGetContainersNetworkInfoCount().

Obligatoire : non

ContainerNetworkInfo

Informations réseau pour un seul conteneur exécuté sur l'instance.

Propriétés Description
ContainerName

Le nom du conteneur, tel que défini dans la définition du groupe de conteneurs.

Type : std::string quand GAMELIFT_USE_STD est défini ; sinonchar[].

Obligatoire : non
ContainerId

L'identifiant unique du conteneur.

Type : std::string quand GAMELIFT_USE_STD est défini ; sinonchar[].

Obligatoire : non
IpAddress

Adresse IPv4 locale du conteneur sur le réseau Docker Bridge.

Type : std::string quand GAMELIFT_USE_STD est défini ; sinonchar[].

Obligatoire : non
ContainerGroupType

Type de groupe de conteneurs auquel appartient le conteneur.

Tapez : Une ContainerGroupType énumération.

Obligatoire : non

Dans son résultat en matière de SDK

Note

InitSDKOutcomeest renvoyé uniquement lorsque vous créez le SDK avec le std drapeau. Si vous construisez avec le nostd drapeau, il 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

Obligatoire : non

GameLiftError

Propriétés Description
ErrorType

Type d'erreur.

Tapez : Une GameLiftErrorType énumération.

Obligatoire : non

ErrorName

Le nom de l'erreur.

Type : std::string

Obligatoire : non

ErrorMessage

Message d’erreur.

Type : std::string

Obligatoire : non

Enums

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

GameLiftErrorType

Valeur de chaîne indiquant le type d'erreur. Les valeurs valides sont les suivantes :

  • EXCEPTION_REQUÊTE_INCORRECTE

  • GAMESESSION_ID_NOT_SET — L'ID de session de jeu n'a pas été défini.

  • EXCEPTION DE SERVICE INTERNE

  • UNSUPPORTED_COMPUTE_TYPE_EXCEPTION — L'API qui a été appelée n'était pas prise en charge sur le type de calcul.

  • LOCAL_CONNECTION_FAILED — La connexion locale doit échouer. Amazon GameLift Servers

  • NETWORK_NOT_INITIALIZED — Le réseau n'a pas été initialisé.

  • SERVICE_CALL_FAILED — Un appel à un AWS service a échoué.

  • DÉFAILLANCE DE CONNEXION WEBSOCKET_DEFAILURE

  • WEBSOCKET_CONNECT_FAILURE_FORBIDDEN

  • WEBSOCKET_CONNECT_FAILURE_INVALID_URL

  • WEBSOCKET_CONNECT_FAILURE_TIMEOUT

  • ALREADY_INITIALIZED — Le Amazon GameLift Servers serveur ou le client a déjà été initialisé avec Initialize ().

  • FLEET_MISMATCH — La flotte cible ne correspond pas à la flotte d'une GameSession ou d'une PlayerSession.

  • GAMELIFT_CLIENT_NOT_INITIALIZED — Le client n'a pas été initialisé. Amazon GameLift Servers

  • GAMELIFT_SERVER_NOT_INITIALIZED — Le serveur n'a pas été initialisé. Amazon GameLift Servers

  • GAME_SESSION_ENDED_FAILED  : le SDK du serveur n'a pas Amazon GameLift Servers pu contacter le service pour signaler la fin de la session de jeu.

  • GAME_SESSION_NOT_READY — La Amazon GameLift Servers session de jeu du serveur n'a pas été activée.

  • GAME_SESSION_READY_FAILED  : 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_MISMATCH — Une méthode cliente a été appelée après Server : :Initialize (), ou vice versa.

  • NOT_INITIALIZED — Le Amazon GameLift Servers serveur ou le client n'a pas été initialisé avec Initialize ().

  • NO_TARGET_ALIASID_SET — Aucun alias cible n'a été défini.

  • NO_TARGET_FLEET_SET — Aucune flotte cible n'a été définie.

  • PROCESS_ENDING_FAILED  : le SDK du serveur n'a pas Amazon GameLift Servers pu contacter le service pour signaler la fin du processus.

  • PROCESS_NOT_ACTIVE — Le processus serveur n'est pas encore actif, n'est pas lié à un GameSession, et ne peut ni accepter ni traiter. PlayerSessions

  • PROCESS_NOT_READY — Le processus serveur n'est pas encore prêt à être activé.

  • PROCESS_READY_FAILED  : le SDK du serveur n'a pas Amazon GameLift Servers pu contacter le service pour signaler que le processus est prêt.

  • SDK_VERSION_DETECTION_FAILED — La détection de la version du SDK a échoué.

  • STX_CALL_FAILED — Un appel au composant principal du serveur xSTX a échoué.

  • STX_INITIALIZATION_FAILED — Le composant principal du serveur xSTX n'a pas pu s'initialiser.

  • UNEXPECTED_PLAYER_SESSION — Une session de joueur non enregistré a été détectée par le serveur.

  • DÉFAILLANCE DE CONNEXION WEBSOCKET_DEFAILURE

  • WEBSOCKET_CONNECT_FAILURE_FORBIDDEN

  • WEBSOCKET_CONNECT_FAILURE_INVALID_URL

  • WEBSOCKET_CONNECT_FAILURE_TIMEOUT

  • WEBSOCKET_RETRIABLE_SEND_MESSAGE_FAILURE — Échec récupérable de l'envoi d'un message au Service. GameLift WebSocket

  • WEBSOCKET_SEND_MESSAGE_FAILURE — Impossible d'envoyer un message au service. GameLift WebSocket

  • MATCH_BACKFILL_REQUEST_VALIDATION — La validation de la demande a échoué.

  • PLAYER_SESSION_REQUEST_VALIDATION — La validation de la demande a échoué.

ContainerGroupType

Type de groupe de conteneurs auquel appartient un conteneur. Les valeurs valides sont les suivantes :

  • GAME_SERVER — Un groupe de conteneurs de répliques de serveurs de jeu. Une instance peut avoir plusieurs groupes de conteneurs de serveurs de jeu.

  • PER_INSTANCE — Un groupe de conteneurs de démons par instance. Une instance possède exactement un groupe de conteneurs par instance.

PlayerSessionCreationPolicy

Valeur de chaîne indiquant si la session de jeu accepte ou non de nouveaux joueurs. Les valeurs valides sont les suivantes :

  • ACCEPT_ALL — Accepte toutes les sessions pour les nouveaux joueurs.

  • DENY_ALL — Interdit toutes les sessions aux nouveaux joueurs.

  • NOT_SET — La session de jeu n'est pas configurée pour accepter ou refuser les sessions de nouveaux joueurs.

LogLevel

Niveau de gravité d'un message de journal. La gravité des valeurs augmente de Trace (la plus verbeuse) à Fatal (la plus sévère). Offn'est pas une gravité de journalisation, mais vous pouvez l'utiliser comme niveau de journalisation minimum dans a CustomLoggerConfiguration pour désactiver la journalisation. Les valeurs valides sont les suivantes :

  • Trace  : niveau le plus détaillé, utilisé pour les messages de diagnostic précis.

  • Débogage  : informations détaillées utiles pour le débogage.

  • Info — Messages d'information générale. Il s'agit du niveau de journalisation minimum par défaut.

  • Avertissement : messages signalant un problème potentiel.

  • Erreur  : messages indiquant une erreur récupérable.

  • Fatal  : niveau le plus grave, utilisé pour les erreurs irrécupérables.

  • Désactivé  : désactive tous les envois de rappels de journaux.