

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

# SDK 5.x del servidor de C\$1\$1 para Amazon GameLift Servers: acciones
<a name="integration-server-sdk5-cpp-actions"></a>

Utilice la referencia del SDK 5.x del servidor para integrar su juego multijugador para el alojamiento con Amazon GameLift Servers. Para obtener ayuda con el proceso de integración, consulte [Adición de Amazon GameLift Servers al servidor de juegos con el SDK del servidor](gamelift-sdk-server-api.md).

**nota**  
En este tema se describe la API de C\$1\$1 de Amazon GameLift Servers que puede utilizar al realizar la compilación con la biblioteca estándar de C\$1\$1 (`std`). En concreto, esta documentación se aplica al código que se compila con la opción `-DDGAMELIFT_USE_STD=1`. 

# SDK 5.x del servidor de C\$1\$1 para Amazon GameLift Servers: tipos de datos
<a name="integration-server-sdk5-cpp-datatypes"></a>

Utilice la referencia del SDK 5.x del servidor de C\$1\$1 de Amazon GameLift Servers para integrar su juego multijugador para el alojamiento con Amazon GameLift Servers. Para obtener ayuda con el proceso de integración, consulte [Adición de Amazon GameLift Servers al servidor de juegos con el SDK del servidor](gamelift-sdk-server-api.md).

**nota**  
En este tema se describe la API de C\$1\$1 de Amazon GameLift Servers que puede utilizar al realizar la compilación con la biblioteca estándar de C\$1\$1 (`std`). En concreto, esta documentación se aplica al código que se compila con la opción `-DDGAMELIFT_USE_STD=1`. 

[SDK 5.x del servidor de C\$1\$1 para Amazon GameLift Servers: acciones](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)
+ [Jugador](#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)
+ [Iniciar 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>

Un objeto que identifica los archivos generados durante una sesión de juego que quiere que Amazon GameLift Servers cargue y almacene una vez finalizada la sesión de juego. El servidor de juegos proporciona `LogParameters` a Amazon GameLift Servers como parte de un objeto `ProcessParameters` en una llamada a [ProcessReady()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-processready).


|  |  | 
| --- |--- |
|  **Propiedades**  | Descripción | 
| LogPaths |  Lista de las rutas de directorio a archivos de registro del servidor de juegos que desea que Amazon GameLift Servers almacene para futuros accesos. El proceso del servidor genera esos archivos durante una sesión de juego. Defina los nombres y las rutas de los archivos en el servidor de juegos y almacénelos en el directorio raíz de compilación del juego.  Las rutas del registro deben ser absolutas. Por ejemplo, si la compilación del juego almacena los registros de sesión de juego en una ruta del tipo `MyGame\sessionLogs\`, la ruta sería `c:\game\MyGame\sessionLogs` en una instancia de Windows. **Tipo:** `std:vector<std::string>` **Obligatorio**: no  | 

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

Utilice este tipo de datos para configurar la recopilación de métricas y los informes de bloqueo del servidor del juego. El servidor de juegos comunica `MetricsParameters` a Amazon GameLift Servers en una llamada a [InitMetrics()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-initmetrics).


|  |  | 
| --- |--- |
|  **Propiedades**  | Descripción | 
| StatsdHost |  Nombre de host o dirección IP del servidor de StatsD para la recopilación de métricas. **Tipo:** `std::string` **Obligatorio**: no  | 
| StatsdPort |  Número de puerto del servidor de StatsD para la recopilación de métricas. **Tipo:** `int` **Obligatorio**: no  | 
| CrashReporterHost |  Nombre de host o dirección IP del servidor que notifica el bloqueo. **Tipo:** `std::string` **Obligatorio**: no  | 
| CrashReporterPort |  Número de puerto del servidor que notifica el bloqueo. **Tipo:** `int` **Obligatorio**: no  | 
| FlushIntervalMs |  Intervalo en milisegundos para vaciar los datos de las métricas al servidor. **Tipo:** `int` **Obligatorio**: no  | 
| MaxPacketSize |  Tamaño máximo en bytes de los paquetes de métricas enviados al servidor. **Tipo:** `int` **Obligatorio**: no  | 

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

Este tipo de datos contiene el conjunto de parámetros enviado a Amazon GameLift Servers en una [ProcessReady()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-processready).


|  |  | 
| --- |--- |
|  **Propiedades**  | Descripción | 
| LogParameters | Un objeto con rutas de directorio a los archivos que se generan durante una sesión de juego. Amazon GameLift Servers copia y almacena los archivos para accesos futuros.**Tipo:** `Aws::GameLift::Server::LogParameters`**Obligatorio**: no | 
| OnHealthCheck | Nombre de la función de devolución de llamada que invoca Amazon GameLift Servers para solicitar un informe de estado del proceso del servidor. Amazon GameLift Servers llama a esta función cada 60 segundos y espera otros 60 segundos para obtener una respuesta. El proceso del servidor devuelve TRUE si está en buen estado y FALSE si no. Si no se devuelve ninguna respuesta, Amazon GameLift Servers registra el proceso del servidor como defectuoso.**Tipo:** `std::function<bool()> onHealthCheck`**Obligatorio**: no | 
| OnProcessTerminate | La función de devolución de llamada que invoca Amazon GameLift Servers para forzar el cierre del proceso de servidor. Después de llamar a esta función, Amazon GameLift Servers espera 5 minutos hasta que el proceso del servidor se cierre y responde con una llamada a [ProcessEnding()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-processending) antes de cerrar el proceso del servidor.**Tipo:** `std::function<void()> onProcessTerminate`**Obligatorio**: sí | 
| OnStartGameSession | La función de devolución de llamada que se Amazon GameLift Servers invoca para activar una nueva sesión de juego. Amazon GameLift Serversllama a esta función en respuesta a una solicitud de un cliente. [CreateGameSession](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_CreateGameSession.html) La función de devolución de llamada pasa un objeto [GameSession](#integration-server-sdk5-cpp-dataypes-gamesession).**Tipo:** `const std::function<void(Aws::GameLift::Model::GameSession)> onStartGameSession`**Obligatorio**: sí | 
| OnUpdateGameSession | Nombre de la función de devolución de llamada que invoca Amazon GameLift Servers para proporcionar un objeto de sesión de juego actualizado. Amazon GameLift Servers llama a esta función una vez que se ha procesado una solicitud de reposición de emparejamiento para proporcionar datos actualizados del emparejador. Pasa un objeto [GameSession](#integration-server-sdk5-cpp-dataypes-gamesession), una actualización de estado (updateReason) y el ID del ticket de reposición de emparejamiento.**Tipo:** `std::function<void(Aws::GameLift::Server::Model::UpdateGameSession)> onUpdateGameSession`**Obligatorio**: no | 
| Puerto | El número de puerto en el que escucha el proceso del servidor para recibir conexiones de jugador nuevas. El valor debe estar en el rango de puertos configurado para cualquier flota que implemente esa compilación de servidor de juegos. Este número de puerto se incluye en los objetos de sesión de juego y de jugador, que las sesiones de juego utilizan a la hora de conectarse a un proceso del servidor.**Tipo:** `Integer`**Obligatorio**: sí | 

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

Este tipo de datos se actualiza a un objeto de sesión de juego, que incluye el motivo por el que se actualizó la sesión de juego y el ID del ticket de reposición correspondiente si la reposición se utiliza para reponer las sesiones de los jugadores en la sesión de juego.


| Propiedades | **Descripción** | 
| --- | --- | 
| GameSession | Un objeto [GameSession](#integration-server-sdk5-cpp-dataypes-gamesession). El objeto GameSession contiene propiedades que describen una sesión de juego. **Tipo:** `Aws::GameLift::Server::GameSession`**Obligatorio**: sí | 
| UpdateReason | El motivo por el que se actualiza la sesión de juego.**Tipo:** `Aws::GameLift::Server::UpdateReason`**Obligatorio**: sí | 
| BackfillTicketId | El ID de ticket de reposición que intenta actualizar la sesión de juego.**Tipo:** `std::string`**Obligatorio**: no | 

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

Este tipo de datos proporciona detalles de una sesión de juego. 


| Propiedades | **Descripción** | 
| --- | --- | 
| GameSessionId |  Un identificador único de la sesión de juego. El ARN de una sesión de juego tiene el siguiente formato: `arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>`. **Tipo:** `std::string` **Obligatorio**: no  | 
| Name |  Una etiqueta descriptiva de la sesión de juego.  **Tipo:** `std::string` **Obligatorio**: no  | 
| FleetId |  Un identificador único para la flota en la que se ejecuta la sesión de juego. **Tipo:** `std::string` **Obligatorio**: no  | 
| MaximumPlayerSessionCount |  El número máximo de conexiones de jugadores a la sesión de juego. **Tipo:** `int` **Obligatorio**: no  | 
| Puerto |  El número de puerto de la sesión de juego. Para conectarse a un servidor de Amazon GameLift Servers juegos, la aplicación necesita tanto la dirección IP como el número de puerto. **Tipo:** `in` **Obligatorio**: no  | 
| IpAddress |  La dirección IP del servidor de la sesión de juego. Para conectarse a un servidor de Amazon GameLift Servers juegos, la aplicación necesita tanto la dirección IP como el número de puerto. **Tipo:** `std::string` **Obligatorio**: no  | 
| GameSessionData |  Un conjunto de propiedades de sesión de juego personalizadas, formateadas como un valor de una sola cadena.  **Tipo:** `std::string` **Obligatorio**: no  | 
| MatchmakerData |  Información sobre el proceso de emparejamiento que se utilizó para crear la sesión de juego, en sintaxis JSON, con formato como cadena. Además de la configuración de emparejamiento utilizada, contiene datos sobre todos los jugadores asignados al emparejamiento, incluidos los atributos de los jugadores y las asignaciones de los equipos. **Tipo:** `std::string` **Obligatorio**: no  | 
| GameProperties |  Un conjunto de propiedades personalizadas de una sesión de juego, con formato como pares clave-valor. Estas propiedades se pasan a una solicitud de iniciar una nueva sesión de juego. **Tipo:** `std :: vector < GameProperty >` **Obligatorio**: no  | 
| DnsName |  El identificador de DNS asignado a la instancia que ejecuta la sesión de juego. Los valores tienen formato siguiente: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/es_es/gameliftservers/latest/developerguide/integration-server-sdk5-cpp-datatypes.html) Cuando se conecte a una sesión de juego que se ejecute en una flota habilitada de TLS, debe utilizar el nombre de DNS, no la dirección IP. **Tipo:** `std::string` **Obligatorio**: no  | 

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

Información utilizada por el proceso del servidor de juegos para establecer una conexión con el servicio de Amazon GameLift Servers. Incluya estos parámetros al llamar a [InitSDK()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-initsdk-anywhere) solo si la compilación del servidor de juegos se va a implementar en una flota de Anywhere o en una flota de contenedores sin el agente de Amazon GameLift Servers. Para todos los demás escenarios de implementación, llame a [InitSDK()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-initsdk) sin parámetros.


| Propiedades | **Descripción** | 
| --- | --- | 
| webSocketUrl |  El `GameLiftServerSdkEndpoint` que devuelve Amazon GameLift Servers cuando se invoca [https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html) para un recurso de computación de Amazon GameLift Servers Anywhere. **Tipo:** `std::string` **Obligatorio**: sí   | 
| processId |  Un identificador único registrado en el proceso de servidor que aloja el juego. **Tipo:** `std::string` **Obligatorio**: sí  | 
| hostId | El HostID es el ComputeName utilizado cuando registró el recurso informático. Para obtener más información, consulte, [RegisterCompute](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html).**Tipo:** `std::string`**Obligatorio**: sí | 
| fleetId | El identificador único de la flota en la que está registrado el recurso informático. Para obtener más información, consulte, [RegisterCompute](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html).**Tipo:** `std::string`**Obligatorio**: sí | 
| authToken | El token de autenticación generado por Amazon GameLift Servers que autentica el servidor en Amazon GameLift Servers. Para obtener más información, consulte, [GetComputeAuthToken](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_GetComputeAuthToken.html).**Tipo:** `std::string`**Obligatorio**: sí | 

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

Información utilizada para crear una solicitud de reposición de emparejamiento. El servidor de juegos comunica esa información a Amazon GameLift Servers en una llamada a [StartMatchBackfill()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-startmatchbackfill).


| Propiedades | **Descripción** | 
| --- | --- | 
| GameSessionArn |  Un identificador único de la sesión de juegos. El `[GetGameSessionId](https://docs.aws.amazon.com/gameliftservers/latest/developerguide/integration-server-sdk5-cpp-actions.html#integration-server-sdk5-cpp-getgamesessionid)` de la operación de la API devuelve el identificador en formato de ARN. **Tipo:** `std::string` **Obligatorio**: sí  | 
| MatchmakingConfigurationArn |  Un identificador único, con formato de ARN, que el emparejador utiliza para esta solicitud. El ARN del emparejador para la sesión de juego original se encuentra en el objeto de sesión de juego en la propiedad de datos del emparejador. Puede obtener más información sobre los datos del emparejador en [Trabajo con datos del emparejador](https://docs.aws.amazon.com/gameliftservers/latest/flexmatchguide/match-server.html#match-server-data.html). **Tipo:** `std::string` **Obligatorio**: sí  | 
| Players |  Un conjunto de datos que representa a todos los jugadores que están en la sesión de juego. El creador de emparejamientos utiliza esta información para buscar nuevos jugadores que son idóneos para los jugadores actuales. **Tipo:** `std::vector<Player>` **Obligatorio**: sí  | 
| TicketId |  Un identificador único para un ticket de solicitud de emparejamiento o reposición de emparejamiento. Si no proporciona un valor, Amazon GameLift Servers generará uno. Use este identificador para realizar un seguimiento del estado del ticket de reposición de emparejamiento o cancelar la solicitud si es necesario.  **Tipo:** `std::string` **Obligatorio**: no  | 

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

Este tipo de datos representa a un jugador en el sistema de emparejamiento. Al iniciar una solicitud de emparejamiento, un jugador tiene un ID de jugador, atributos y, posiblemente, datos de latencia. Amazon GameLift Servers añada la información de los equipos tras realizar un emparejamiento.


| Propiedades | **Descripción** | 
| --- | --- | 
| LatencyInMS |  Un conjunto de valores expresados en milisegundos que indican la cantidad de latencia que experimenta un jugador cuando se conecta a una ubicación.  Si se utiliza esta propiedad, el jugador solo se empareja con las ubicaciones que aparecen. Si un creador de emparejamientos tiene una regla que evalúa la latencia de los jugadores, estos deben informar de la latencia para ser emparejados. **Tipo:** `Dictionary<string,int>` **Obligatorio**: no  | 
| PlayerAttributes |  Una colección de pares de clave-valor que contienen información del jugador para su uso en el emparejamiento. Las claves de atributos del jugador deben coincidir con las PlayerAttributes utilizadas en un conjunto de reglas de emparejamiento. Para obtener más información sobre los atributos de los jugadores, consulte [AttributeValue](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_AttributeValue.html). **Tipo:** `std::map<std::string,AttributeValue>` **Obligatorio**: no  | 
| PlayerId |  Un identificador único de un jugador. **Tipo:** `std::string` **Obligatorio**: no  | 
| Equipo |  El nombre del equipo al que está asignado el jugador en un emparejamiento. Defina el nombre del equipo se define en el conjunto de reglas de emparejamiento. **Tipo:** `std::string` **Obligatorio**: no  | 

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

Un objeto que especifica las sesiones de jugador que recuperar. El proceso del servidor proporciona esta información con una llamada [DescribePlayerSessions()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-describeplayersessions) a Amazon GameLift Servers.


| Propiedades | **Descripción** | 
| --- | --- | 
| GameSessionId |  Un identificador único de la sesión de juegos. Use este parámetro para solicitar todas las sesiones de jugador de la sesión de juego especificada.  El formato de ID de sesión de juego es `arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>`. El `GameSessionID` es una cadena de ID personalizada o una **Tipo:** `std::string` **Obligatorio**: no  | 
| PlayerSessionId |  El identificador único de una sesión de jugador. Utilice este parámetro para solicitar una sesión de jugador específica. **Tipo:** `std::string` **Obligatorio**: no  | 
| PlayerId |  El identificador único de un jugador. Utilice este parámetro para solicitar todas las sesiones de jugador para un jugador específico. Consulte [Generación de ID de jugador](player-sessions-player-identifiers.md). **Tipo:** `std::string` **Obligatorio**: no  | 
| PlayerSessionStatusFilter |  El estado de la sesión de jugador para filtrar los resultados. Los posibles estados de sesión de jugador son los siguientes: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/es_es/gameliftservers/latest/developerguide/integration-server-sdk5-cpp-datatypes.html) **Tipo:** `std::string` **Obligatorio**: no  | 
| NextToken |  El token que indica el inicio de la siguiente página de resultados. Para especificar el inicio del conjunto de resultados, no indique ningún valor. Si se especifica un ID de sesión de jugador, este parámetro se ignora. **Tipo:** `std::string` **Obligatorio**: no  | 
| Límite |  El número máximo de resultados que devolver. Si se especifica un ID de sesión de jugador, este parámetro se ignora. **Tipo:** `int` **Obligatorio**: no  | 

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

Información utilizada para cancelar una solicitud de reposición de emparejamiento. El servidor de juegos comunica esa información al servicio Amazon GameLift Servers en una llamada a [StopMatchBackfill()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-stopmatchbackfill).


| Propiedades | **Descripción** | 
| --- | --- | 
| GameSessionArn |  Un identificador único de sesión de juego de la solicitud que se va a cancelar. **Tipo:** `char[]` **Obligatorio**: no  | 
| MatchmakingConfigurationArn |  Un identificador único del emparejador al que se envió esta solicitud. **Tipo:** `char[]` **Obligatorio**: no  | 
| TicketId |  Un identificador único del ticket de solicitud de reposición que se va a cancelar. **Tipo:** `char[]` **Obligatorio**: no  | 

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

Utilice estos valores en pares de clave-valor de atributo [Jugador](#integration-server-sdk5-cpp-dataypes-player). Este objeto le permite especificar un valor de atributo mediante cualquiera de los tipos de datos válidos: cadena, número, matriz de cadenas o mapa de datos. Cada objeto `AttributeValue` debe utilizar exactamente una de las propiedades disponibles: `S`, `N`, `SL` o `SDM`.


| Propiedades | Description (Descripción) | 
| --- | --- | 
| AttrType |  Especifica el tipo de valor del atributo. Entre los posibles tipos de valores de atributo se incluyen:  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/es_es/gameliftservers/latest/developerguide/integration-server-sdk5-cpp-datatypes.html) **Obligatorio**: no  | 
| S |  Representa un valor de atributo de cadena. **Tipo:** `std::string` **Obligatorio**: no  | 
| N |  Representa un valor de atributo numérico. **Tipo:** `double` **Obligatorio**: no  | 
| SL |  Representa una matriz de valores de atributos de cadena. **Tipo:** `std::vector<std::string>` **Obligatorio**: no  | 
| SDM |  Representa un diccionario de claves de cadena y valores dobles. **Tipo:** `std::map<std::string, double>` **Obligatorio**: no  | 

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

Este tipo de datos proporciona al servidor del juego un acceso limitado al resto de tus AWS recursos. Para obtener más información, consulte, [Configuración de un rol de servicio de IAM para Amazon GameLift Servers](setting-up-role.md).


| Propiedades | **Descripción** | 
| --- | --- | 
| RoleArn | El nombre de recurso de Amazon (ARN) de la función de servicio que amplía el acceso limitado a sus AWS recursos.**Tipo:** `std::string`**Obligatorio**: no | 
| RoleSessionName | El nombre de sesión del rol que puede usar para identificar de forma exclusiva una AWS Security Token Service [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)sesión. Este nombre aparece en los registros de auditoría, como los de CloudTrail. **Tipo:** `std::string`  **Obligatorio**: no  | 

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

Este tipo de datos es el resultado de una acción y produce un objeto con las siguientes propiedades:


| Propiedades | Description (Descripción) | 
| --- | --- | 
| Resultado |  El resultado de la acción. **Tipo:** `long` **Obligatorio**: no  | 
| ResultWithOwnership |   El resultado de la acción, expresado como un valor r, para que el código de llamada pueda tomar posesión del objeto.  **Tipo:** `long&&` **Obligatorio**: no  | 
| Success |  Si la acción se realizó correctamente o no. **Tipo:** `bool` **Obligatorio**: sí  | 
| Error |  El error que se genera si la acción no se ha realizado correctamente. **Tipo:** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obligatorio**: no  | 

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

Este tipo de datos es el resultado de una acción y produce un objeto con las siguientes propiedades:


| Propiedades | Description (Descripción) | 
| --- | --- | 
| Resultado |  El resultado de la acción. **Tipo:** `std::string` **Obligatorio**: no  | 
| ResultWithOwnership |   El resultado de la acción, expresado como un valor r, para que el código de llamada pueda tomar posesión del objeto.  **Tipo:** `long&&` **Obligatorio**: no  | 
| Success |  Si la acción se realizó correctamente o no. **Tipo:** `bool` **Obligatorio**: sí  | 
| Error |  El error que se genera si la acción no se ha realizado correctamente. **Tipo:** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obligatorio**: no  | 

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

Este tipo de datos es el resultado de una acción y produce un objeto con las siguientes propiedades:


| Propiedades | Description (Descripción) | 
| --- | --- | 
| Resultado |  El resultado de la acción. **Tipo:** [DescribePlayerSessionsResult](#integration-server-sdk5-cpp-datatypes-describeplayersessionsresult) **Obligatorio**: no   | 
| ResultWithOwnership |   El resultado de la acción, expresado como un valor r, para que el código de llamada pueda tomar posesión del objeto.  **Tipo:** `Aws::GameLift::Server::Model::DescribePlayerSessionsResult&&` **Obligatorio**: no  | 
| Success |  Si la acción se realizó correctamente o no. **Tipo:** `bool` **Obligatorio**: sí  | 
| Error |  El error que se genera si la acción no se ha realizado correctamente. **Tipo:** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obligatorio**: no  | 

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

Una colección de objetos que contiene propiedades para cada sesión de jugador que se empareja con la solicitud. 


| Propiedades | Description (Descripción) | 
| --- | --- | 
| NextToken |  Un token que indica el inicio de la siguiente página de resultados secuencial. Utilice el token devuelto con una llamada anterior a esta operación. Para especificar el inicio del conjunto de resultados, no especifique ningún valor. Si se especifica un ID de sesión de jugador, este parámetro se ignora.  **Tipo:** `std::string` **Obligatorio**: sí  | 
| PlayerSessions |  **Tipo:** `IList<PlayerSession>` **Obligatorio:**   | 
| ResultWithOwnership |   El resultado de la acción, expresado como un valor r, para que el código de llamada pueda tomar posesión del objeto.  **Tipo:** `std::string&&` **Obligatorio**: no  | 
| Success |  Si la acción se realizó correctamente o no. **Tipo:** `bool` **Obligatorio**: sí  | 
| Error |  El error que se genera si la acción no se ha realizado correctamente. **Tipo:** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obligatorio**: no  | 

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

Este tipo de datos es el resultado de una acción y produce un objeto con las siguientes propiedades:


| Propiedades | Description (Descripción) | 
| --- | --- | 
| Success |  Si la acción se realizó correctamente o no. **Tipo:** `bool` **Obligatorio**: sí  | 
| Error |  El error que se genera si la acción no se ha realizado correctamente. **Tipo:** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obligatorio**: no  | 

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

Este tipo de datos es un resultado genérico asíncrono. Tiene las siguientes propiedades: 


| Propiedades | Description (Descripción) | 
| --- | --- | 
| Success |  Si la acción se realizó correctamente o no. **Tipo:** `bool` **Obligatorio**: sí  | 
| Error |  El error que se genera si la acción no se ha realizado correctamente. **Tipo:** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obligatorio**: no  | 

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

Este tipo de datos representa la sesión de un jugador que Amazon GameLift Servers transfiere al servidor de juegos. Para obtener más información, consulte [PlayerSession](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_PlayerSession.html). 


| Propiedades | Description (Descripción) | 
| --- | --- | 
| CreationTime |  **Tipo:** `long` **Obligatorio**: no  | 
| FleetId |  **Tipo:** `std::string` **Obligatorio**: no  | 
| GameSessionId |  **Tipo:** `std::string` **Obligatorio**: no  | 
| IpAddress |  **Tipo:** `std::string` **Obligatorio**: no  | 
| PlayerData |  **Tipo:** `std::string` **Obligatorio**: no  | 
| PlayerId |  **Tipo:** `std::string` **Obligatorio**: no  | 
| PlayerSessionId |  **Tipo:** `std::string` **Obligatorio**: no  | 
| Puerto |  **Tipo:** `int` **Obligatorio**: no  | 
| Status |  Estado de la sesión de juego para filtrar los resultados. Cuando PlayerId se proporciona una PlayerSessionId o, no PlayerSessionStatusFilter tiene ningún efecto en la respuesta.  **Tipo:** una enumeración de `PlayerSessionStatus`. Entre los valores posibles se incluyen:  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/es_es/gameliftservers/latest/developerguide/integration-server-sdk5-cpp-datatypes.html) **Obligatorio**: no  | 
| TerminationTime |  **Tipo:** `long` **Obligatorio**: no  | 
| DnsName |  **Tipo:** `std::string` **Obligatorio**: no  | 

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

Este tipo de datos es el resultado de una acción y produce un objeto con las siguientes propiedades:


| Propiedades | Description (Descripción) | 
| --- | --- | 
| Resultado |  El resultado de la acción. **Tipo:** [StartMatchBackfillResult](#integration-server-sdk5-cpp-datatypes-startmatchbackfillresult) **Obligatorio**: no  | 
| ResultWithOwnership |   El resultado de la acción, expresado como un valor r, para que el código de llamada pueda tomar posesión del objeto.  **Tipo:** `StartMatchBackfillResult&&` **Obligatorio**: no  | 
| Success |  Si la acción se realizó correctamente o no. **Tipo:** `bool` **Obligatorio**: sí  | 
| Error |  El error que se genera si la acción no se ha realizado correctamente. **Tipo:** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obligatorio**: no  | 

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

Este tipo de datos es el resultado de una acción y produce un objeto con las siguientes propiedades:


| Propiedades | Description (Descripción) | 
| --- | --- | 
| TicketId |  Un identificador único de un ticket de emparejamiento Si no se especifica ningún ID de ticket aquí, Amazon GameLift Servers generará uno en forma de UUID. Utilice este identificador para realizar un seguimiento del estado del ticket de relleno del emparejamiento y recuperar los resultados del emparejamiento.  **Tipo:** `std::string` **Obligatorio**: no  | 

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

Este tipo de datos es el resultado de una acción y produce un objeto con las siguientes propiedades:


| Propiedades | Description (Descripción) | 
| --- | --- | 
| Resultado |  El resultado de la acción. **Tipo:** [GetComputeCertificateResult](#integration-server-sdk5-cpp-datatypes-getcomputecertificateresult) **Obligatorio**: no   | 
| ResultWithOwnership |   El resultado de la acción, expresado como un valor r, para que el código de llamada pueda tomar posesión del objeto.  **Tipo:** `Aws::GameLift::Server::Model::GetComputeCertificateResult&&` **Obligatorio**: no  | 
| Success |  Si la acción se realizó correctamente o no. **Tipo:** `bool` **Obligatorio**: sí  | 
| Error |  El error que se genera si la acción no se ha realizado correctamente. **Tipo:** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obligatorio**: no  | 

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

La ruta al certificado TLS de su recurso informático y el nombre de host del equipo.


| Propiedades | Description (Descripción) | 
| --- | --- | 
| CertificatePath |  La ruta al certificado TLS de su recurso informático. Cuando se utiliza una flota administrada por Amazon GameLift Servers, la ruta contiene los siguientes elementos:  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/es_es/gameliftservers/latest/developerguide/integration-server-sdk5-cpp-datatypes.html) **Tipo:** `std::string` **Obligatorio**: no  | 
| ComputeName |  El nombre del recurso informático. **Tipo:** `std::string` **Obligatorio**: no  | 

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

Este tipo de datos es el resultado de una acción y produce un objeto con las siguientes propiedades:


| Propiedades | Description (Descripción) | 
| --- | --- | 
| Resultado |  El resultado de la acción. **Tipo:** [GetFleetRoleCredentialsResult](#integration-server-sdk5-cpp-datatypes-getfleetrolecredentialsresult) **Obligatorio**: no   | 
| ResultWithOwnership |   El resultado de la acción, expresado como un valor r, para que el código de llamada pueda tomar posesión del objeto.  **Tipo:** `Aws::GameLift::Server::Model::GetFleetRoleCredentialsResult` **Obligatorio**: no  | 
| Success |  Si la acción se realizó correctamente o no. **Tipo:** `bool` **Obligatorio**: sí  | 
| Error |  El error que se genera si la acción no se ha realizado correctamente. **Tipo:** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obligatorio**: no  | 

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


| Propiedades | Description (Descripción) | 
| --- | --- | 
| AccessKeyId |  El ID de la clave de acceso para autenticar y proporcionar acceso a los recursos de AWS . **Tipo:** `string` **Obligatorio**: no  | 
| AssumedRoleId |  El ID del usuario al que pertenece el rol de servicio. **Tipo:** `string` **Obligatorio**: no  | 
| AssumedRoleUserArn |  El nombre de recurso de Amazon (ARN) del usuario al que pertenece el rol de servicio. **Tipo:** `string` **Obligatorio**: no  | 
| Expiration |  El tiempo que queda hasta que caduquen las credenciales de la sesión. **Tipo:** `DateTime` **Obligatorio**: no  | 
| SecretAccessKey |  El ID de clave de acceso secreta para la autenticación. **Tipo:** `string` **Obligatorio**: no  | 
| SessionToken |  Un token para identificar la sesión activa actual que interactúa con tus AWS recursos. **Tipo:** `string` **Obligatorio**: no  | 
| Success |  Si la acción se realizó correctamente o no. **Tipo:** `bool` **Obligatorio**: sí  | 
| Error |  El error que se genera si la acción no se ha realizado correctamente. **Tipo:** [GameLiftError](integration-server-sdk5-csharp-datatypes.md#integration-server-sdk5-csharp-datatypes-gamelifterror) **Obligatorio**: no  | 

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

**nota**  
`InitSDKOutcome` se devuelve solo cuando compila el SDK con la marca `std`. Si realiza la compilación con la marca `nostd`, se devuelve [GenericOutcome](#integration-server-sdk5-cpp-datatypes-genericoutcome) en su lugar.


| Propiedades | Description (Descripción) | 
| --- | --- | 
| Success |  Si la acción se realizó correctamente o no. **Tipo:** `bool` **Obligatorio**: sí  | 
| Error |  El error que se genera si la acción no se ha realizado correctamente. **Tipo:** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obligatorio**: no  | 

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


| Propiedades | Description (Descripción) | 
| --- | --- | 
| ErrorType |  Tipo de error. **Tipo:** una [enumeración](#integration-server-sdk5-cpp-dataypes-enums) de `GameLiftErrorType`. **Obligatorio**: no   | 
| ErrorName |  El nombre del error.  **Tipo:** `std::string`  **Obligatorio**: no   | 
| ErrorMessage |  Mensaje de error.  **Tipo:** `std::string`  **Obligatorio**: no   | 

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

Las enumeraciones definidas para el SDK del servidor para Amazon GameLift Servers (C\$1\$1) se definen de la siguiente manera: 

**GameLiftErrorType**  
Valor de cadena que indica el tipo de error. Los valores válidos son:  
+ **BAD\$1REQUEST\$1EXCEPTION** 
+ **GAMESESSION\$1ID\$1NOT\$1SET**: no se ha establecido el ID de sesión de juego. 
+ **INTERNAL\$1SERVICE\$1EXCEPTION** 
+ **LOCAL\$1CONNECTION\$1FAILED**: se ha producido un error en la conexión local a Amazon GameLift Servers. 
+ **NETWORK\$1NOT\$1INITIALIZED**: la red no se ha inicializado. 
+ **SERVICE\$1CALL\$1FAILED: se produjo** un error en una llamada a un servicio. AWS 
+ **WEBSOCKET\$1CONNECT\$1FAILURE** 
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1FORBIDDEN** 
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1INVALID\$1URL** 
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1TIMEOUT** 
+ **ALREADY\$1INITIALIZED**: el servidor o cliente de Amazon GameLift Servers ya se inicializó con Initialize(). 
+ **FLEET\$1MISMATCH**: la flota de destino no coincide con la flota de gameSession o playerSession. 
+ **GAMELIFT\$1CLIENT\$1NOT\$1INITIALIZED**: el cliente de Amazon GameLift Servers no se ha inicializado. 
+ **GAMELIFT\$1SERVER\$1NOT\$1INITIALIZED**: el servidor de Amazon GameLift Servers no se ha inicializado. 
+ **GAME\$1SESSION\$1ENDED\$1FAILED**: el SDK del servidor de Amazon GameLift Servers no pudo ponerse en contacto con el servicio para informar de que la sesión de juego había finalizado. 
+ **GAME\$1SESSION\$1NOT\$1READY**: no se activó la sesión de juego del servidor de Amazon GameLift Servers. 
+ **GAME\$1SESSION\$1READY\$1FAILED**: el SDK del servidor de Amazon GameLift Servers no pudo ponerse en contacto con el servicio para informar de que la sesión de juego estaba lista. 
+ **INITIALIZATION\$1MISMATCH**: se llamó a un método de cliente después de Server::Initialize() o viceversa. 
+ **NOT\$1INITIALIZED**: el servidor o el cliente de Amazon GameLift Servers no se han iniciado con Initialize(). 
+ **NO\$1TARGET\$1ALIASID\$1SET**: no se ha establecido un aliasId de destino. 
+ **NO\$1TARGET\$1FLEET\$1SET**: no se ha establecido una flota de destino. 
+ **PROCESS\$1ENDING\$1FAILED**: el SDK del servidor de Amazon GameLift Servers no pudo contactar con el servicio para informar de que el proceso está finalizando. 
+ **PROCESS\$1NOT\$1ACTIVE** — El proceso del servidor aún no está activo, no está vinculado a un y no puede aceptarlo ni procesarlo. GameSession PlayerSessions 
+ **PROCESS\$1NOT\$1READY**: el proceso de servidor aún no está listo para activarse. 
+ **PROCESS\$1READY\$1FAILED**: el SDK del servidor de Amazon GameLift Servers no pudo contactar con el servicio para informar de que el proceso está listo. 
+ **SDK\$1VERSION\$1DETECTION\$1FAILED**: no se pudo detectar la versión del SDK. 
+ **STX\$1CALL\$1FAILED: no se pudo realizar una llamada** al componente de backend del servidor. XStx 
+ **STX\$1INITIALIZATION\$1FAILED: el componente de backend del servidor no se pudo inicializar**. XStx 
+ **UNEXPECTED\$1PLAYER\$1SESSION**: el servidor ha detectado una sesión de jugador no registrada. 
+ **WEBSOCKET\$1CONNECT\$1FAILURE** 
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1FORBIDDEN** 
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1INVALID\$1URL** 
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1TIMEOUT** 
+ **WEBSOCKET\$1RETRIABLE\$1SEND\$1MESSAGE\$1FAILURE**: error recuperable al enviar un mensaje al servicio. GameLift WebSocket 
+ **WEBSOCKET\$1SEND\$1MESSAGE\$1FAILURE**: error al enviar un mensaje al GameLift servicio. WebSocket 
+ **MATCH\$1BACKFILL\$1REQUEST\$1VALIDATION**: se ha producido un error en la validación de la solicitud. 
+ **PLAYER\$1SESSION\$1REQUEST\$1VALIDATION**: se ha producido un error en la validación de la solicitud. 

**PlayerSessionCreationPolicy**  
Valor de cadena que indica si la sesión de juego acepta jugadores nuevos. Los valores válidos son:   
+ **ACCEPT\$1ALL**: se aceptan todas las sesiones de jugador nuevas. 
+ **DENY\$1ALL**: se rechazan todas las sesiones de jugador nuevas. 
+ **NOT\$1SET**: la sesión de juego no está configurada para aceptar o denegar sesiones de nuevos jugadores. 

[SDK 5.x del servidor de C\$1\$1 para Amazon GameLift Servers: tipos de datos](integration-server-sdk5-cpp-datatypes.md)

**Topics**
+ [SDK 5.x del servidor de C\$1\$1 para Amazon GameLift Servers: tipos de datos](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)
+ [Destroy()](#integration-server-sdk5-cpp-ref-destroy)

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

Devuelve el número de versión actual del SDK integrado en el proceso del servidor.

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

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

### Valor devuelto
<a name="integration-server-sdk5-cpp-getsdkversion-return"></a>

Si funciona correctamente, devuelve la versión del SDK actual como objeto [AwsStringOutcome](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-awsstringoutcome). El objeto devuelto incluye el número de versión (por ejemplo, `5.0.0`). Si no funciona, devuelve un mensaje de error.

### Ejemplo
<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>

Inicializa el sistema de métricas para recopilar los datos de rendimiento del servidor e informar sobre ellos. Para obtener unos resultados óptimos, llame a este método antes que [InitSDK()](#integration-server-sdk5-cpp-initsdk) para habilitar la recopilación de métricas durante la inicialización del SDK.

### Sintaxis
<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) (opcional)  
Parámetros de configuración de la recopilación de métricas. Si no se proporciona, utiliza valores predeterminados que pueden ser anulados por variables de entorno.

### Valor devuelto
<a name="integration-server-sdk5-cpp-initmetrics-return"></a>

Si se ejecuta correctamente, devuelve un objeto [GenericOutcome](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-genericoutcome) que indica un resultado correcto. Si no funciona, devuelve un mensaje de error.

### Ejemplo
<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>

Inicializa el SDK de Amazon GameLift Servers. Llame a este método en el lanzamiento, antes de cualquier otro paso de inicialización relacionado con Amazon GameLift Servers. Esta acción lee los parámetros del servidor desde el entorno de host para configurar la comunicación entre el proceso del servidor de juegos y el servicio Amazon GameLift Servers. Utiliza un token de idempotencia, por lo que puede volver a intentar esta llamada de forma segura cuando falle.

Si la compilación del servidor de juegos se va a implementar sin el agente de Amazon GameLift Servers en una flota de Amazon GameLift Servers Anywhere o flota de contenedores, llame a [InitSDK()](#integration-server-sdk5-cpp-initsdk-anywhere) y especifique un conjunto de parámetros de servidor.

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

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

### Valor devuelto
<a name="integration-server-sdk5-cpp-initsdk-return"></a>

Devuelve un objeto [Iniciar SDKOutcome](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-initsdkoutcome) que indica si el proceso del servidor está listo para llamar a [ProcessReady()](#integration-server-sdk5-cpp-processready). 

### Ejemplo
<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>

Inicializa el SDK de Amazon GameLift Servers. Llame a este método en el lanzamiento, antes de cualquier otro paso de inicialización relacionado con Amazon GameLift Servers. Para esta acción, es necesario que un conjunto de parámetros del servidor establezca la comunicación entre el proceso del servidor de juegos y el servicio Amazon GameLift Servers. Utiliza un token de idempotencia, por lo que puede volver a intentar esta llamada de forma segura cuando falle.

Si la compilación del servidor de juegos se va a implementar en una flota de EC2 administrada por Amazon GameLift Servers o en una flota de Amazon GameLift Servers Anywhere o flota de contenedores con el agente de Amazon GameLift Servers, llame a [InitSDK()](#integration-server-sdk5-cpp-initsdk) sin especificar los parámetros del servidor.

### Sintaxis
<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)  
Para inicializar un servidor de juegos en una flota de Amazon GameLift Servers Anywhere, cree un objeto `ServerParameters` con la siguiente información:  
+ La URL WebSocket utilizada para conectarse a tu servidor de juegos. 
+ El ID del proceso utilizado para alojar su servidor de juegos. 
+ El ID del proceso utilizado para alojar los procesos del servidor de juegos. 
+ El ID de la flota de Amazon GameLift Servers que contiene su recurso de computación de Amazon GameLift Servers Anywhere.
+ El token de autorización generado por la operación de Amazon GameLift Servers. 

### Valor devuelto
<a name="integration-server-sdk5-cpp-initsdk-anywhere-return"></a>

Devuelve un objeto [Iniciar SDKOutcome](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-initsdkoutcome) que indica si el proceso del servidor está listo para llamar a [ProcessReady()](#integration-server-sdk5-cpp-processready). 

**nota**  
Si las llamadas a `InitSDK()` no funcionan en las compilaciones de juegos implementadas en las flotas de Anywhere, compruebe el parámetro `ServerSdkVersion` que se utiliza al crear el recurso de compilación. Debe establecer este valor de forma explícita en la versión del SDK del servidor en uso. El valor predeterminado de este parámetro es 4.x, que no es compatible. Para resolver este problema, cree una compilación nueva e impleméntela en una flota nueva.

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

Ejemplo de Amazon GameLift Servers Anywhere

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

Notifica a Amazon GameLift Servers que el proceso del servidor de juegos está listo para alojar sesiones de juego. Llame a este método después de invocar [InitSDK()](#integration-server-sdk5-cpp-initsdk). Se debe llamar a este método solo una vez por proceso.

### Sintaxis
<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**  
Es un objeto [ProcessParameters](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-dataypes-process) que comunica la siguiente información acerca del proceso del servidor:  
+ Nombres de métodos de devolución de llamada, implementados en el código de servidor de juegos, que el servicio Amazon GameLift Servers invoca para comunicarse con el proceso del servidor.
+ Número de puerto de escucha del servidor de proceso.
+ Ruta a cualquier archivo específico de la sesión de juego que desea que Amazon GameLift Servers capture y almacene.

### Valor devuelto
<a name="integration-server-sdk5-cpp-processready-return"></a>

Devuelve un resultado genérico correcto o erróneo con un mensaje de error.

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

Este ejemplo ilustra las implementaciones tanto de la función de llamada [ProcessReady()](#integration-server-sdk5-cpp-processready) como de la función de delegación.

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

Notifica al servicio Amazon GameLift Servers que el proceso del servidor está listo para alojar sesiones de juego. Este método debe llamarse después de que el proceso del servidor esté listo para alojar una sesión de juego. Los parámetros especifican los nombres de funciones de devolución de llamada para que Amazon GameLift Servers llame en determinadas circunstancias. El código de servidor de juegos debe implementar estas funciones.

La llamada es asíncrona. Para realizar una llamada síncrona, utilice [ProcessReady()](#integration-server-sdk5-cpp-processready). Consulte [Inicialización del proceso del servidor](gamelift-sdk-server-api.md#gamelift-sdk-server-initialize) para obtener más detalles.

### Sintaxis
<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**  
Es un objeto [ProcessParameters](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-dataypes-process) que comunica la siguiente información acerca del proceso del servidor:  
+ Nombres de métodos de devolución de llamada, implementados en el código de servidor de juegos, que el servicio Amazon GameLift Servers invoca para comunicarse con el proceso del servidor.
+ Número de puerto de escucha del servidor de proceso.
+ Ruta a cualquier archivo específico de la sesión de juego que desea que Amazon GameLift Servers capture y almacene.
Obligatorio: sí

### Valor devuelto
<a name="integration-server-sdk5-cpp-processreadyasync-return"></a>

Devuelve un resultado genérico correcto o erróneo con un mensaje de error.

### Ejemplo
<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>

Informa a Amazon GameLift Servers de que el proceso del servidor está finalizando. Llame a este método después de realizar todas las demás tareas de limpieza (lo que incluye el cierre de la sesión de juegos activa) y antes de finalizar el proceso. Según el resultado de `ProcessEnding()`, el proceso finaliza con éxito (0) o error (-1) y genera un evento de flota. Si el proceso finaliza con un error, el evento de flota generado será `SERVER_PROCESS_TERMINATED_UNHEALTHY`.

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

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

### Valor devuelto
<a name="integration-server-sdk5-cpp-processending-return"></a>

Devuelve un resultado genérico correcto o erróneo con un mensaje de error.

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

En este ejemplo, se llama a `ProcessEnding()` y `Destroy()` antes de finalizar el proceso del servidor con un código de salida correcto o erróneo.

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

Notifica a Amazon GameLift Servers que el proceso del servidor ha iniciado una sesión de juego y que está listo para recibir las conexiones de los jugadores. Esta acción debe llamarse como parte de la función de devolución de llamada `onStartGameSession()`, después de la inicialización de todas las sesiones de juego.

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

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

### Valor devuelto
<a name="integration-server-sdk5-cpp-activategamesession-return"></a>

Devuelve un resultado genérico correcto o erróneo con un mensaje de error.

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

Este ejemplo muestra cómo se llama a `ActivateGameSession()` como parte de la función de delegación `onStartGameSession()`. 

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

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

Actualiza la capacidad de la sesión de juego actual para aceptar sesiones de jugador nuevas. Una sesión de juego se puede configurar para que acepte o deniegue todas las sesiones nuevas de los jugadores.

### Sintaxis
<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>

**playerCreationSessionPolítica**  
Tipo: valor de `PlayerSessionCreationPolicy` [enumeración](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-dataypes-enums).  
Obligatorio: sí

### Valor devuelto
<a name="integration-server-sdk5-cpp-updateplayersessioncreationpolicy-return"></a>

Devuelve un resultado genérico correcto o erróneo con un mensaje de error.

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

Este ejemplo establece la política de participación en la sesión de juego actual para aceptar todos los jugadores.

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

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

Recupera el ID de la sesión de juego alojada por el proceso del servidor. 

En el caso de los procesos inactivos que no se activan con una sesión de juego, la llamada devuelve [GameLiftError](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-gamelifterror).

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

```
AwsStringOutcome GetGameSessionId()
```

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

Esta acción no tiene parámetros.

### Valor devuelto
<a name="integration-server-sdk5-cpp-getgamesessionid-return"></a>

Si funciona correctamente, devuelve el ID de sesión del juego como objeto [AwsStringOutcome](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-awsstringoutcome). Si no funciona, devuelve un mensaje de error.

En el caso de los procesos inactivos que no se activan con una sesión de juego, la llamada devuelve `Success`=`True` y `GameSessionId`=`""`.

### Ejemplo
<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>

Devuelve la hora a la que está programada el cierre de un proceso de servidor, si hay una hora de terminación disponible. Un proceso del servidor realiza esta acción después de recibir una devolución de llamada `onProcessTerminate()` desde Amazon GameLift Servers. Amazon GameLift Servers llama a `onProcessTerminate()` por los motivos siguientes: 
+ Cuando el proceso del servidor informa de un mal estado o no responde a Amazon GameLift Servers.
+ Al finalizar la instancia durante un evento de reducción vertical.
+ [Cuando se finaliza una instancia debido a la interrupción de una instancia de spot](spot-tasks.md).

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

```
AwsDateTimeOutcome GetTerminationTime()
```

### Valor devuelto
<a name="integration-server-sdk5-cpp-getterm-return"></a>

Si el proceso se realiza correctamente, devuelve la hora de terminación como un objeto `AwsDateTimeOutcome`. El valor es la hora de terminación expresado en ciclos transcurridos desde `0001 00:00:00`. Por ejemplo, el valor de la fecha y hora `2020-09-13 12:26:40 -000Z` es igual a `637355968000000000` ciclos. Si no hay una hora de terminación disponible, devuelve un mensaje de error.

Si el proceso no ha recibido un ProcessParameters. OnProcessTerminate() devolución de llamada, se devuelve un mensaje de error. Para obtener más información sobre cómo cerrar un proceso de servidor, consulte [Respuesta a una notificación de cierre del proceso del servidor](gamelift-sdk-server-api.md#gamelift-sdk-server-terminate).

### Ejemplo
<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>

Notifica a Amazon GameLift Servers que un jugador con el ID de sesión de jugador especificado se ha conectado al proceso del servidor y requiere validación. Amazon GameLift Servers verifica que el ID de sesión de jugador es válido. Una vez validada la sesión del jugador, Amazon GameLift Servers cambia el estado del espacio de jugador de RESERVADO a ACTIVO. 

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

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

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

playerSessionId  
ID único emitido por Amazon GameLift Servers cuando se crea una nueva sesión de jugador.

### Valor devuelto
<a name="integration-server-sdk5-cpp-acceptplayersession-return"></a>

Devuelve un resultado genérico correcto o erróneo con un mensaje de error. 

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

Este ejemplo gestiona una solicitud de conexión que incluye la validación y el rechazo de una sesión de jugador no válida. 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>

Informa a Amazon GameLift Servers de que un jugador se ha desconectado del proceso del servidor. Como respuesta, Amazon GameLift Servers cambia el espacio del jugador para que esté disponible. 

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

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

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

**`playerSessionId`**  
ID único emitido por Amazon GameLift Servers cuando se crea una nueva sesión de jugador.

### Valor devuelto
<a name="integration-server-sdk5-cpp-removeplayersession-return"></a>

Devuelve un resultado genérico correcto o erróneo con un mensaje de error.

### Ejemplo
<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>

Recupera datos de sesión de jugador, incluida la configuración, los metadatos de la sesión y los datos de jugador. Utilice este método para obtener información sobre los siguientes elementos:
+ Una sesión para un jugador
+ Todas las sesiones del jugador en una sesión de juego
+ Todas las sesiones de jugador están asociadas a un único ID de jugador

### Sintaxis
<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)**  
Un objeto [DescribePlayerSessionsRequest](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-dataypes-playersessions) que describe las sesiones de jugador que recuperar.

### Valor devuelto
<a name="integration-server-sdk5-cpp-describeplayersessions-return"></a>

Si funciona correctamente, devuelve un objeto [DescribePlayerSessionsOutcome](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-describeplayersessionsoutcome) que contiene un conjunto de objetos de sesión de jugador que se ajusta a los parámetros de la solicitud.

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

En este ejemplo se solicitan todas las sesiones de jugador conectadas activamente a una sesión de juego específica. Al omitir *NextToken*y establecer el valor *límite* en 10, Amazon GameLift Servers devuelve los registros de las sesiones de los primeros 10 jugadores que coincidan con la solicitud.

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

Envía una solicitud para encontrar nuevos jugadores para ranuras abiertas en una sesión de juego creada con FlexMatch. Para obtener más información, consulte [Característica de reposición de FlexMatch](https://docs.aws.amazon.com/gameliftservers/latest/flexmatchguide/match-backfill.html).

Esta acción es asíncrona. Si se emparejan nuevos jugadores, Amazon GameLift Servers ofrece datos actualizados del emparejador mediante la función de devolución de llamada `OnUpdateGameSession()`.

Un proceso del servidor solo puede tener una solicitud de reposición de emparejamiento activa a la vez. Para enviar una nueva solicitud, en primer lugar llame a [StopMatchBackfill()](#integration-server-sdk5-cpp-stopmatchbackfill) para cancelar la solicitud original.

### Sintaxis
<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)**  
 StartMatchBackfillRequest Objeto que comunica la siguiente información:  
+ Un ID de ticket que se asignará a la solicitud de reposición. Esta información es opcional; si no se proporciona ningún ID, Amazon GameLift Servers generará uno.
+ El creador de emparejamientos al que se enviará la solicitud. El ARN de configuración completo es obligatorio. Este valor se encuentra en los datos del emparejador de la sesión de juego.
+ El ID de la sesión de juego que se va a reponer.
+ Datos del emparejador disponibles para los jugadores actuales de la sesión de juego.

### Valor devuelto
<a name="integration-server-sdk5-cpp-startmatchbackfill-return"></a>

Devuelve un objeto [StartMatchBackfillOutcome](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-startmatchbackfilloutcome) con el ID del ticket de reposición de emparejamiento o un error con un mensaje de error. 

### Ejemplo
<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>

Cancela una solicitud de reposición de emparejamiento activa. Para obtener más información, consulte [Característica de reposición de FlexMatch](https://docs.aws.amazon.com/gameliftservers/latest/flexmatchguide/match-backfill.html).

### Sintaxis
<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 objeto que identifique el billete de emparejamiento que se va a cancelar:   
+ ID del ticket que se asignará a la solicitud de reposición
+ El emparejador al que se envió la solicitud de reposición
+ La sesión de juego asociada a la solicitud de reposición.

### Valor devuelto
<a name="integration-server-sdk5-cpp-stopmatchbackfill-return"></a>

Devuelve un resultado genérico correcto o erróneo con un mensaje de error.

### Ejemplo
<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>

Recupera la ruta al certificado TLS utilizado para cifrar la conexión de red entre el recurso de computación de Amazon GameLift Servers Anywhere y Amazon GameLift Servers. Puede utilizar la ruta del certificado al registrar el dispositivo informático en una flota de Amazon GameLift Servers Anywhere. Para obtener más información, consulte, [RegisterCompute](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html).

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

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

### Valor devuelto
<a name="integration-server-sdk5-cpp-getcomputecertificate-return"></a>

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

### Ejemplo
<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>

Recupera las credenciales del rol de IAM que autorizan a Amazon GameLift Servers a interactuar con otros Servicios de AWS. Para obtener más información, consulte [Conecta tu servidor de juegos Amazon GameLift Servers alojado a otros AWS recursos](gamelift-sdk-server-resources.md).

### Sintaxis
<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)

### Valor devuelto
<a name="integration-server-sdk5-cpp-getfleetrolecredentials-return"></a>

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

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

En este ejemplo, se muestra el uso del valor `RoleSessionName` opcional para asignar un nombre a la sesión de credenciales con fines de auditoría. Si no proporciona un nombre de sesión de rol, se utilizará el valor predeterminado *[host-id]* "*[fleet-id]*-».

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

Aws::GameLift::GetFleetRoleCredentialsOutcome credentials = Aws::GameLift::Server::GetFleetRoleCredentials(getFleetRoleCredentialsRequest);
```

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

Libera de la memoria el SDK del servidor de juegos de Amazon GameLift Servers. Como práctica recomendada, llame a este método después de `ProcessEnding()` y antes de finalizar el proceso. Si utiliza una flota de Anywhere y no va a finalizar los procesos del servidor después de cada sesión de juego, llame a `Destroy()` y, a continuación, a `InitSDK()` para reinicializar antes de informar a Amazon GameLift Servers de que el proceso está listo para organizar una sesión de juego con `ProcessReady()`.

### Sintaxis
<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>

No hay parámetros.

### Valor devuelto
<a name="integration-server-sdk5-cpp-ref-destroy-return"></a>

Devuelve un resultado genérico correcto o erróneo con un mensaje de error.

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