As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# SDK do servidor C\$1\$1 para Amazon GameLift Servers 5.x – Ações
<a name="integration-server-sdk5-cpp-actions"></a>

Use a referência do SDK 5.x do servidor para integrar o jogo multijogador à hospedagem com o Amazon GameLift Servers. Para obter orientação sobre o processo de integração, consulte [Integre o Amazon GameLift Servers ao seu servidor de jogos com o SDK do servidor.](gamelift-sdk-server-api.md).

**nota**  
Este tópico descreve a API C\$1\$1 do Amazon GameLift Servers que você pode usar ao criar com a Biblioteca padrão C\$1\$1 (`std`). Especificamente, essa documentação se aplica ao código que você compila com a opção `-DDGAMELIFT_USE_STD=1`. 

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

Use a referência de Amazon GameLift Servers C\$1\$1 do SDK 5.x do servidor para integrar o jogo multijogador à hospedagem com o Amazon GameLift Servers. Para obter orientação sobre o processo de integração, consulte [Integre o Amazon GameLift Servers ao seu servidor de jogos com o SDK do servidor.](gamelift-sdk-server-api.md).

**nota**  
Este tópico descreve a API C\$1\$1 do Amazon GameLift Servers que você pode usar ao criar com a Biblioteca padrão C\$1\$1 (`std`). Especificamente, essa documentação se aplica ao código que você compila com a opção `-DDGAMELIFT_USE_STD=1`. 

[SDK do servidor C\$1\$1 para Amazon GameLift Servers 5.x – Ações](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)
+ [Jogador](#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)
+ [Inicializar SDKOutcome](#integration-server-sdk5-cpp-datatypes-initsdkoutcome)
+ [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror)
+ [Enumerações](#integration-server-sdk5-cpp-dataypes-enums)

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

Um objeto que identifica arquivos gerados durante uma sessão de jogo que você deseja que o Amazon GameLift Servers carregue e armazene após o término da sessão de jogo. O servidor do jogo fornece `LogParameters` ao Amazon GameLift Servers como parte de um objeto `ProcessParameters` em uma chamada [ProcessReady()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-processready).


|  |  | 
| --- |--- |
|  **Properties**  | Descrição | 
| LogPaths |  A lista de caminhos de diretório para arquivos de log do servidor de jogo que você deseja que o Amazon GameLift Servers armazene para acesso futuro. O processo do servidor gera esses arquivos durante cada sessão de jogo. Você define caminhos e nomes de arquivos em seu servidor de jogo e os armazena no diretório raiz de construção do jogo.  Os caminhos de log devem ser absolutos. Por exemplo, se a compilação do jogo armazenasse logs de sessão de jogo em um caminho como `MyGame\sessionLogs\`, o caminho estará `c:\game\MyGame\sessionLogs` em uma instância do Windows. **Digite**: `std:vector<std::string>` **Obrigatório**: não  | 

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

Use esse tipo de dados para configurar a coleta de métricas e relatórios de falhas para o servidor do jogo. O servidor do jogo comunica `MetricsParameters` ao Amazon GameLift Servers em uma chamada [InitMetrics()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-initmetrics).


|  |  | 
| --- |--- |
|  **Properties**  | Descrição | 
| StatsdHost |  O nome do host ou endereço IP do servidor do StatsD para a coleta de métricas. **Digite**: `std::string` **Obrigatório**: não  | 
| StatsdPort |  O número da porta do servidor StatsD para coleta de métricas. **Digite**: `int` **Obrigatório**: não  | 
| CrashReporterHost |  O endereço IP ou o nome do host do servidor de relatório de falhas. **Digite**: `std::string` **Obrigatório**: não  | 
| CrashReporterPort |  O número da porta do servidor de relatório de falhas. **Digite**: `int` **Obrigatório**: não  | 
| FlushIntervalMs |  O intervalo em milissegundos para limpar os dados das métricas para o servidor. **Digite**: `int` **Obrigatório**: não  | 
| MaxPacketSize |  O tamanho máximo em bytes dos pacotes para métricas enviados ao servidor. **Digite**: `int` **Obrigatório**: não  | 

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

Este tipo de dados contém o conjunto de parâmetros enviado para o Amazon GameLift Servers em uma [ProcessReady()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-processready).


|  |  | 
| --- |--- |
|  **Properties**  | Descrição | 
| LogParameters | Um objeto com caminhos de diretório para arquivos que são gerados durante uma sessão de jogo. O Amazon GameLift Servers copia e armazena para acessos futuros.**Digite**: `Aws::GameLift::Server::LogParameters`**Obrigatório**: não | 
| OnHealthCheck | A função de retorno de chamada que o Amazon GameLift Servers invoca para solicitar um relatório de status de integridade do processo de servidor. O Amazon GameLift Servers chama essa função a cada 60 segundos e espera 60 segundos por uma resposta. O processo do servidor retorna TRUE se estiver íntegro, FALSE se não estiver íntegro. Se nenhuma resposta for retornada, o Amazon GameLift Servers registra o processo do servidor como não íntegro.**Digite**: `std::function<bool()> onHealthCheck`**Obrigatório**: não | 
| OnProcessTerminate | A função de retorno de chamada que o Amazon GameLift Servers invoca para forçar o encerramento do processo do servidor. Depois de chamar essa função, o Amazon GameLift Servers aguardará 5 minutos para o processo de servidor desligar e responder com uma chamada [ProcessEnding()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-processending) antes do desligamento do processo de servidor.**Digite**: `std::function<void()> onProcessTerminate`**Obrigatório**: Sim | 
| OnStartGameSession | A função de retorno de chamada que Amazon GameLift Servers invoca para ativar uma nova sessão de jogo. Amazon GameLift Serverschama essa função em resposta a uma solicitação do cliente [CreateGameSession](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_CreateGameSession.html). A função de retorno de chamada transmite um objeto [GameSession](#integration-server-sdk5-cpp-dataypes-gamesession).**Digite**: `const std::function<void(Aws::GameLift::Model::GameSession)> onStartGameSession`**Obrigatório**: Sim | 
| OnUpdateGameSession | O nome da função de retorno de chamada que o Amazon GameLift Servers invoca para passar um objeto de sessão de jogo atualizado ao processo do jogo. O Amazon GameLift Servers chama essa função quando uma solicitação de alocação de correspondência foi processada para fornecer dados de combinador atualizados. Ele transmite um objeto [GameSession](#integration-server-sdk5-cpp-dataypes-gamesession), uma atualização de status (updateReason) e o ID do tíquete de alocação de correspondência.**Digite**: `std::function<void(Aws::GameLift::Server::Model::UpdateGameSession)> onUpdateGameSession`**Obrigatório**: não | 
| Porta | O número da porta em que o processo de servidor escuta para novas conexões de jogador. O valor deve estar dentro do intervalo de portas configurado para qualquer frota que implanta essa compilação do servidor de jogo. Esse número de porta está incluído nos objetos das sessões de jogo e jogador, que as sessões de jogo usam ao se conectar a um processo de servidor.**Digite**: `Integer`**Obrigatório**: Sim | 

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

Esse tipo de dados é atualizado para um objeto de sessão de jogo, o que inclui o motivo pelo qual a sessão de jogo foi atualizada e o ID do tíquete de alocação relacionada, se a alocação for usada para preencher as sessões dos jogadores na sessão do jogo.


| Propriedades | **Descrição** | 
| --- | --- | 
| GameSession | Um objeto [GameSession](#integration-server-sdk5-cpp-dataypes-gamesession). O objeto GameSession contém propriedades que descrevem uma sessão de jogo. **Digite**: `Aws::GameLift::Server::GameSession`**Obrigatório**: Sim | 
| UpdateReason | O motivo pelo qual a sessão do jogo está sendo atualizada.**Digite**: `Aws::GameLift::Server::UpdateReason`**Obrigatório**: Sim | 
| BackfillTicketId | O ID do tíquete de alocação que está tentando atualizar a sessão do jogo.**Digite**: `std::string`**Obrigatório**: não | 

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

Esse tipo de dados fornece detalhes de uma sessão de jogo. 


| Propriedades | **Descrição** | 
| --- | --- | 
| GameSessionId |  Um identificador exclusivo da sessão de jogo. Um ARN de sessão de jogo tem o seguinte formato: `arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>`. **Digite**: `std::string` **Obrigatório**: não  | 
| Nome |  Um rótulo descritivo da sessão do jogo.  **Digite**: `std::string` **Obrigatório**: não  | 
| FleetId |  Um identificador exclusivo da frota em que a sessão de jogo está sendo executada. **Digite**: `std::string` **Obrigatório**: não  | 
| MaximumPlayerSessionCount |  O número máximo de conexões do jogador com a sessão do jogo. **Digite**: `int` **Obrigatório**: não  | 
| Porta |  O número da porta da sessão de jogo. Para se conectar a um servidor de Amazon GameLift Servers jogos, um aplicativo precisa do endereço IP e do número da porta. **Digite**: `in` **Obrigatório**: não  | 
| IpAddress |  O endereço IP da sessão de jogo. Para se conectar a um servidor de Amazon GameLift Servers jogos, um aplicativo precisa do endereço IP e do número da porta. **Digite**: `std::string` **Obrigatório**: não  | 
| GameSessionData |  Um conjunto de propriedades de sessão de jogo personalizadas, formatadas como um único valor de string.  **Digite**: `std::string` **Obrigatório**: não  | 
| MatchmakerData |  Informações sobre o processo de criação de partidas usado para criar a sessão do jogo, na sintaxe JSON, formatado como uma string. Além da configuração de criação de partidas usada, ele contém dados sobre todos os jogadores atribuídos à partida, incluindo atributos do jogador e atribuições da equipe. **Digite**: `std::string` **Obrigatório**: não  | 
| GameProperties |  Um conjunto de propriedades personalizadas para uma sessão de jogo, formatado como pares de chave:valor. Essas propriedades são passadas com uma solicitação de início de uma nova sessão de jogo. **Digite**: `std :: vector < GameProperty >` **Obrigatório**: não  | 
| DnsName |  O identificador DNS atribuído à instância que está executando a sessão do jogo. Os valores têm o formato a seguir: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/gameliftservers/latest/developerguide/integration-server-sdk5-cpp-datatypes.html) Ao se conectar a uma sessão de jogo que está sendo executada em uma frota compatível com TLS, você deve usar o nome DNS, não o endereço IP. **Digite**: `std::string` **Obrigatório**: não  | 

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

Informações que um processo de servidor de jogos usa para estabelecer uma conexão com o serviço do Amazon GameLift Servers. Inclua esses parâmetros ao chamar [InitSDK()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-initsdk-anywhere) somente se a compilação do servidor de jogos for implantada em uma frota Anywhere ou uma frota de contêineres sem o Amazon GameLift Servers Agent. Para todos os outros cenários de implantação, chame [InitSDK()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-initsdk) sem parâmetros.


| Propriedades | **Descrição** | 
| --- | --- | 
| webSocketUrl |  Os retornos `GameLiftServerSdkEndpoint` Amazon GameLift Servers quando você [https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html) para um recurso de computação Amazon GameLift Servers Anywhere. **Digite**: `std::string` **Obrigatório**: Sim   | 
| processId |  Um identificador exclusivo registrado no processo do servidor que hospeda seu jogo. **Digite**: `std::string` **Obrigatório**: Sim  | 
| hostId | O HostID é o ComputeName usado quando você registrou seu computador. Para obter mais informações, consulte, [RegisterCompute](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html).**Digite**: `std::string`**Obrigatório**: Sim | 
| fleetId | O identificador exclusivo da frota na qual o computador está registrado. Para obter mais informações, consulte, [RegisterCompute](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html).**Digite**: `std::string`**Obrigatório**: Sim | 
| authToken | O token de autenticação gerado pelo Amazon GameLift Servers que autentica seu servidor no Amazon GameLift Servers. Para obter mais informações, consulte, [GetComputeAuthToken](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_GetComputeAuthToken.html).**Digite**: `std::string`**Obrigatório**: Sim | 

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

Informações usadas para criar uma solicitação de alocação de criação de partidas. O servidor do jogo comunica essas informações ao Amazon GameLift Servers em uma chamada [StartMatchBackfill()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-startmatchbackfill).


| Propriedades | **Descrição** | 
| --- | --- | 
| GameSessionArn |  Um identificador da sessão de jogo exclusivo. A operação de API retorna `[GetGameSessionId](https://docs.aws.amazon.com/gameliftservers/latest/developerguide/integration-server-sdk5-cpp-actions.html#integration-server-sdk5-cpp-getgamesessionid)` o identificador no formato de ARN. **Digite**: `std::string` **Obrigatório**: Sim  | 
| MatchmakingConfigurationArn |  um identificador exclusivo, no formato de ARN, para o marcador de jogos a ser usado para essa solicitação. O marcador de jogos ARN da sessão de jogo original está no objeto de sessão de jogo na propriedade de dados do marcador de jogos. Saiba mais sobre os dados do marcador de jogos em [Trabalhar com dados do marcador de jogos](https://docs.aws.amazon.com/gameliftservers/latest/flexmatchguide/match-server.html#match-server-data.html). **Digite**: `std::string` **Obrigatório**: Sim  | 
| Jogadores |  Um conjunto de dados que representa todos os jogadores que estão na sessão do jogo. O marcador de jogos usa essas informações para pesquisar novos jogadores que sejam correspondências ideais para os jogadores atuais. **Digite**: `std::vector<Player>` **Obrigatório**: Sim  | 
| TicketId |  Um identificador exclusivo de um tíquete de solicitação de marcação de jogo ou de alocação de correspondência. Se você não fornecer um valor, o Amazon GameLift Servers gerará um. Use esse identificador para acompanhar o status do tíquete de alocação de correspondência ou cancelar a solicitação, se necessário.  **Digite**: `std::string` **Obrigatório**: não  | 

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

Esse tipo de dados representa um jogador em criação de partidas. Quando iniciar uma solicitação de criação de partidas começa, um jogador tem um ID de jogador, atributos, e possivelmente dados de latência. O Amazon GameLift Servers adiciona as informações de equipe após uma combinação ter sido feita.


| Propriedades | **Descrição** | 
| --- | --- | 
| LatencyInMS |  Um conjunto de valores expressos em milissegundos que indicam a quantidade de latência que um jogador experimenta quando conectado a um local.  Se essa propriedade for usada, o player só será correspondido aos locais listados. Se um marcador de jogos tiver uma regra que avalie a latência do jogador, os jogadores deverão reportar a latência a ser correspondida. **Digite**: `Dictionary<string,int>` **Obrigatório**: não  | 
| PlayerAttributes |  Uma coleção de pares de chave:valor contendo informações de jogadores para uso em criação de partidas. As chaves de atributos do jogador devem corresponder às PlayerAttributes usadas em um conjunto de regras de matchmaking. Para obter mais informações sobre os atributos do jogador, consulte [AttributeValue](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_AttributeValue.html). **Digite**: `std::map<std::string,AttributeValue>` **Obrigatório**: não  | 
| PlayerId |  Um identificador exclusivo para um jogador. **Digite**: `std::string` **Obrigatório**: não  | 
| Equipe |  O nome da equipe à qual o jogador está designado em uma partida. Você define o nome da equipe no conjunto de regras de criação de partidas. **Digite**: `std::string` **Obrigatório**: não  | 

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

Um objeto que especifica quais sessões de jogador devem ser recuperadas. O processo do servidor fornece essas informações com uma chamada [DescribePlayerSessions()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-describeplayersessions) para o Amazon GameLift Servers.


| Propriedades | **Descrição** | 
| --- | --- | 
| GameSessionId |  Um identificador da sessão de jogo exclusivo. Use esse parâmetro para solicitar todas as sessões de jogador da sessão de jogo especificada.  O formato do ID da sessão do jogo é `arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>`. O `GameSessionID` é uma string de ID personalizada ou uma **Digite**: `std::string` **Obrigatório**: não  | 
| PlayerSessionId |  Um identificador exclusivo para uma sessão de jogador. Use esse parâmetro para solicitar uma única sessão de jogador específica. **Digite**: `std::string` **Obrigatório**: não  | 
| PlayerId |  Um identificador exclusivo para um jogador. Use este parâmetro para solicitar todas as sessões de jogador para um jogador específico. Consulte [Gerar IDs de jogador](player-sessions-player-identifiers.md). **Digite**: `std::string` **Obrigatório**: não  | 
| PlayerSessionStatusFilter |  O status da sessão de jogador para filtrar resultados. Entre os status da sessão de jogador possíveis incluem: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/gameliftservers/latest/developerguide/integration-server-sdk5-cpp-datatypes.html) **Digite**: `std::string` **Obrigatório**: não  | 
| NextToken |  O token que indica o início da próxima página de resultados. Para especificar o início do conjunto de resultados, não forneça um valor. Se fornecer um ID de sessão do jogador, esse parâmetro será ignorado. **Digite**: `std::string` **Obrigatório**: não  | 
| Limite |  O número máximo de resultados a serem retornados. Se fornecer um ID de sessão do jogador, esse parâmetro será ignorado. **Digite**: `int` **Obrigatório**: não  | 

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

Informações usadas para cancelar uma solicitação de alocação de criação de partidas. O servidor do jogo comunica essas informações ao serviço Amazon GameLift Servers em uma chamada [StopMatchBackfill()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-stopmatchbackfill).


| Propriedades | **Descrição** | 
| --- | --- | 
| GameSessionArn |  Um identificador exclusivo da sessão de jogo da solicitação que está sendo cancelada. **Digite**: `char[]` **Obrigatório**: não  | 
| MatchmakingConfigurationArn |  Um identificador exclusivo do marcador de jogos para o qual essa solicitação foi enviada. **Digite**: `char[]` **Obrigatório**: não  | 
| TicketId |  Um identificador exclusivo do tíquete de solicitação de alocação a ser cancelado. **Digite**: `char[]` **Obrigatório**: não  | 

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

Use esses valores em pares de chave-valor de atributo [Jogador](#integration-server-sdk5-cpp-dataypes-player). Esse objeto permite especificar um valor de atributo usando qualquer um dos tipos de dados válidos: string, número, matriz de string ou mapa de dados. Cada objeto `AttributeValue` deve usar exatamente uma das propriedades disponíveis: `S`, `N`, `SL` ou `SDM`.


| Propriedades | Description | 
| --- | --- | 
| AttrType |  Especifica o tipo de valor do atributo. Os possíveis tipos de valor de atributo incluem:  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/gameliftservers/latest/developerguide/integration-server-sdk5-cpp-datatypes.html) **Obrigatório**: não  | 
| S |  Representa um valor de atributo de string. **Digite**: `std::string` **Obrigatório**: não  | 
| N |  Representa um valor de atributo numérico. **Digite**: `double` **Obrigatório**: não  | 
| SL |  Representa uma matriz de valores de atributos de string. **Digite**: `std::vector<std::string>` **Obrigatório**: não  | 
| SDM |  Representa um dicionário de chaves de string e valores duplos. **Digite**: `std::map<std::string, double>` **Obrigatório**: não  | 

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

Esse tipo de dados dá ao servidor do jogo acesso limitado aos seus outros AWS recursos. Para obter mais informações, consulte, [Configurar um perfil de serviço do IAM para o Amazon GameLift Servers](setting-up-role.md).


| Propriedades | **Descrição** | 
| --- | --- | 
| RoleArn | O Amazon Resource Name (ARN) da função de serviço que estende o acesso limitado aos seus AWS recursos.**Digite**: `std::string`**Obrigatório**: não | 
| RoleSessionName | O nome da sessão da função que você pode usar para identificar uma AWS Security Token Service [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)sessão de forma exclusiva. Esse nome é exposto em registros de auditoria, como os de CloudTrail. **Digite**: `std::string`  **Obrigatório**: não  | 

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

Esse tipo de dados resulta de uma ação e produz um objeto com as seguintes propriedades:


| Propriedades | Description | 
| --- | --- | 
| Resultado |  O resultado da ação. **Digite**: `long` **Obrigatório**: não  | 
| ResultWithOwnership |   O resultado da ação, convertido como um rvalue, para que o código de chamada possa se apropriar do objeto.  **Digite**: `long&&` **Obrigatório**: não  | 
| Bem-sucedida |  Se a ação foi bem-sucedida ou não. **Digite**: `bool` **Obrigatório**: Sim  | 
| Erro |  O erro que ocorreu se a ação não foi bem-sucedida. **Digite**: [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obrigatório**: não  | 

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

Esse tipo de dados resulta de uma ação e produz um objeto com as seguintes propriedades:


| Propriedades | Description | 
| --- | --- | 
| Resultado |  O resultado da ação. **Digite**: `std::string` **Obrigatório**: não  | 
| ResultWithOwnership |   O resultado da ação, convertido como um rvalue, para que o código de chamada possa se apropriar do objeto.  **Digite**: `long&&` **Obrigatório**: não  | 
| Bem-sucedida |  Se a ação foi bem-sucedida ou não. **Digite**: `bool` **Obrigatório**: Sim  | 
| Erro |  O erro que ocorreu se a ação não foi bem-sucedida. **Digite**: [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obrigatório**: não  | 

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

Esse tipo de dados resulta de uma ação e produz um objeto com as seguintes propriedades:


| Propriedades | Description | 
| --- | --- | 
| Resultado |  O resultado da ação. **Digite**: [DescribePlayerSessionsResult](#integration-server-sdk5-cpp-datatypes-describeplayersessionsresult) **Obrigatório**: não   | 
| ResultWithOwnership |   O resultado da ação, convertido como um rvalue, para que o código de chamada possa se apropriar do objeto.  **Digite**: `Aws::GameLift::Server::Model::DescribePlayerSessionsResult&&` **Obrigatório**: não  | 
| Bem-sucedida |  Se a ação foi bem-sucedida ou não. **Digite**: `bool` **Obrigatório**: Sim  | 
| Erro |  O erro que ocorreu se a ação não foi bem-sucedida. **Digite**: [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obrigatório**: não  | 

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

Uma coleção de objetos contendo propriedades para cada sessão de jogador que corresponde à solicitação. 


| Propriedades | Description | 
| --- | --- | 
| NextToken |  Um token que indica o início da próxima página sequencial de resultados. Use o token retornado com uma chamada anterior para essa operação. Para começar no início do conjunto de resultados, não especifique um valor. Se um ID de sessão de jogador for especificado, esse parâmetro será ignorado.  **Digite**: `std::string` **Obrigatório**: Sim  | 
| PlayerSessions |  **Digite**: `IList<PlayerSession>` **Obrigatório:**   | 
| ResultWithOwnership |   O resultado da ação, convertido como um rvalue, para que o código de chamada possa se apropriar do objeto.  **Digite**: `std::string&&` **Obrigatório**: não  | 
| Bem-sucedida |  Se a ação foi bem-sucedida ou não. **Digite**: `bool` **Obrigatório**: Sim  | 
| Erro |  O erro que ocorreu se a ação não foi bem-sucedida. **Digite**: [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obrigatório**: não  | 

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

Esse tipo de dados resulta de uma ação e produz um objeto com as seguintes propriedades:


| Propriedades | Description | 
| --- | --- | 
| Bem-sucedida |  Se a ação foi bem-sucedida ou não. **Digite**: `bool` **Obrigatório**: Sim  | 
| Erro |  O erro que ocorreu se a ação não foi bem-sucedida. **Digite**: [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obrigatório**: não  | 

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

Esse tipo de dados é um resultado genérico assíncrono. Ele tem as seguintes propriedades: 


| Propriedades | Description | 
| --- | --- | 
| Bem-sucedida |  Se a ação foi bem-sucedida ou não. **Digite**: `bool` **Obrigatório**: Sim  | 
| Erro |  O erro que ocorreu se a ação não foi bem-sucedida. **Digite**: [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obrigatório**: não  | 

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

Esse tipo de dados representa uma sessão de jogador que o Amazon GameLift Servers passa para o servidor do jogo. Para obter mais informações, consulte [PlayerSession](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_PlayerSession.html). 


| Propriedades | Description | 
| --- | --- | 
| CreationTime |  **Digite**: `long` **Obrigatório**: não  | 
| FleetId |  **Digite**: `std::string` **Obrigatório**: não  | 
| GameSessionId |  **Digite**: `std::string` **Obrigatório**: não  | 
| IpAddress |  **Digite**: `std::string` **Obrigatório**: não  | 
| PlayerData |  **Digite**: `std::string` **Obrigatório**: não  | 
| PlayerId |  **Digite**: `std::string` **Obrigatório**: não  | 
| PlayerSessionId |  **Digite**: `std::string` **Obrigatório**: não  | 
| Porta |  **Digite**: `int` **Obrigatório**: não  | 
| Status |  Status da sessão de jogador para filtrar resultados. Quando um PlayerSessionId ou PlayerId é fornecido, o não PlayerSessionStatusFilter tem efeito na resposta.  **Tipo:** Um `PlayerSessionStatus` enum. Os valores possíveis incluem o seguinte:  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/gameliftservers/latest/developerguide/integration-server-sdk5-cpp-datatypes.html) **Obrigatório**: não  | 
| TerminationTime |  **Digite**: `long` **Obrigatório**: não  | 
| DnsName |  **Digite**: `std::string` **Obrigatório**: não  | 

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

Esse tipo de dados resulta de uma ação e produz um objeto com as seguintes propriedades:


| Propriedades | Description | 
| --- | --- | 
| Resultado |  O resultado da ação. **Digite**: [StartMatchBackfillResult](#integration-server-sdk5-cpp-datatypes-startmatchbackfillresult) **Obrigatório**: não  | 
| ResultWithOwnership |   O resultado da ação, convertido como um rvalue, para que o código de chamada possa se apropriar do objeto.  **Digite**: `StartMatchBackfillResult&&` **Obrigatório**: não  | 
| Bem-sucedida |  Se a ação foi bem-sucedida ou não. **Digite**: `bool` **Obrigatório**: Sim  | 
| Erro |  O erro que ocorreu se a ação não foi bem-sucedida. **Digite**: [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obrigatório**: não  | 

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

Esse tipo de dados resulta de uma ação e produz um objeto com as seguintes propriedades:


| Propriedades | Description | 
| --- | --- | 
| TicketId |  Um identificador exclusivo para um tíquete de marcação de jogo. Se nenhum ID de ticket for especificado aqui, o Amazon GameLift Servers gerará um no formato de UUID. Use esse identificador para rastrear o status do ticket de alocação da partida e recuperar os resultados da partida.  **Digite**: `std::string` **Obrigatório**: não  | 

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

Esse tipo de dados resulta de uma ação e produz um objeto com as seguintes propriedades:


| Propriedades | Description | 
| --- | --- | 
| Resultado |  O resultado da ação. **Digite**: [GetComputeCertificateResult](#integration-server-sdk5-cpp-datatypes-getcomputecertificateresult) **Obrigatório**: não   | 
| ResultWithOwnership |   O resultado da ação, convertido como um rvalue, para que o código de chamada possa se apropriar do objeto.  **Digite**: `Aws::GameLift::Server::Model::GetComputeCertificateResult&&` **Obrigatório**: não  | 
| Bem-sucedida |  Se a ação foi bem-sucedida ou não. **Digite**: `bool` **Obrigatório**: Sim  | 
| Erro |  O erro que ocorreu se a ação não foi bem-sucedida. **Digite**: [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obrigatório**: não  | 

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

O caminho para o certificado TLS em seu computador e o nome do host do computador.


| Propriedades | Description | 
| --- | --- | 
| CertificatePath |  O caminho para o certificado TLS em seu recurso computacional. Ao usar uma frota gerenciada do Amazon GameLift Servers, esse caminho contém:  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/gameliftservers/latest/developerguide/integration-server-sdk5-cpp-datatypes.html) **Digite**: `std::string` **Obrigatório**: não  | 
| ComputeName |  O nome do seu recurso computacional. **Digite**: `std::string` **Obrigatório**: não  | 

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

Esse tipo de dados resulta de uma ação e produz um objeto com as seguintes propriedades:


| Propriedades | Description | 
| --- | --- | 
| Resultado |  O resultado da ação. **Digite**: [GetFleetRoleCredentialsResult](#integration-server-sdk5-cpp-datatypes-getfleetrolecredentialsresult) **Obrigatório**: não   | 
| ResultWithOwnership |   O resultado da ação, convertido como um rvalue, para que o código de chamada possa se apropriar do objeto.  **Digite**: `Aws::GameLift::Server::Model::GetFleetRoleCredentialsResult` **Obrigatório**: não  | 
| Bem-sucedida |  Se a ação foi bem-sucedida ou não. **Digite**: `bool` **Obrigatório**: Sim  | 
| Erro |  O erro que ocorreu se a ação não foi bem-sucedida. **Digite**: [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obrigatório**: não  | 

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


| Propriedades | Description | 
| --- | --- | 
| AccessKeyId |  O ID da chave de acesso para autenticar e fornecer acesso aos seus recursos AWS . **Digite**: `string` **Obrigatório**: não  | 
| AssumedRoleId |  O ID do usuário ao qual o perfil de serviço pertence. **Digite**: `string` **Obrigatório**: não  | 
| AssumedRoleUserArn |  O nome do recurso da Amazon (ARN) do usuário ao qual pertence o perfil de serviço. **Digite**: `string` **Obrigatório**: não  | 
| Expiração |  A quantidade de tempo até que suas credenciais de sessão expirem. **Digite**: `DateTime` **Obrigatório**: não  | 
| SecretAccessKey |  O ID da chave de acesso secreta para autenticação. **Digite**: `string` **Obrigatório**: não  | 
| SessionToken |  Um token para identificar a sessão ativa atual interagindo com seus AWS recursos. **Digite**: `string` **Obrigatório**: não  | 
| Bem-sucedida |  Se a ação foi bem-sucedida ou não. **Digite**: `bool` **Obrigatório**: Sim  | 
| Erro |  O erro que ocorreu se a ação não foi bem-sucedida. **Digite**: [GameLiftError](integration-server-sdk5-csharp-datatypes.md#integration-server-sdk5-csharp-datatypes-gamelifterror) **Obrigatório**: não  | 

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

**nota**  
`InitSDKOutcome` é retornado somente quando você cria o SDK com a bandeira `std`. Se você construir com a `nostd` bandeira, ela será [GenericOutcome](#integration-server-sdk5-cpp-datatypes-genericoutcome) retornada em vez disso.


| Propriedades | Description | 
| --- | --- | 
| Bem-sucedida |  Se a ação foi bem-sucedida ou não. **Digite**: `bool` **Obrigatório**: Sim  | 
| Erro |  O erro que ocorreu se a ação não foi bem-sucedida. **Digite**: [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Obrigatório**: não  | 

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


| Propriedades | Description | 
| --- | --- | 
| ErrorType |  O tipo de erro. **Tipo:** Um `GameLiftErrorType` [enum.](#integration-server-sdk5-cpp-dataypes-enums). **Obrigatório**: não   | 
| ErrorName |  O nome do erro.  **Digite**: `std::string`  **Obrigatório**: não   | 
| ErrorMessage |  A mensagem de erro.  **Digite**: `std::string`  **Obrigatório**: não   | 

## Enumerações
<a name="integration-server-sdk5-cpp-dataypes-enums"></a>

As enumerações definidas para o SDK do servidor para Amazon GameLift Servers (C\$1\$1) são definidas da seguinte forma: 

**GameLiftErrorType**  
Valor da string indicando o tipo de erro. Os valores válidos são:  
+ **BAD\$1REQUEST\$1EXCEPTION** 
+ **GAMESESSION\$1ID\$1NOT\$1SET** – O ID da sessão do jogo não foi definido. 
+ **INTERNAL\$1SERVICE\$1EXCEPTION** 
+ **LOCAL\$1CONNECTION\$1FAILED** – A conexão local com o Amazon GameLift Servers falhou. 
+ **NETWORK\$1NOT\$1INITIALIZED** – A rede não foi inicializada. 
+ **SERVICE\$1CALL\$1FAILED — Uma chamada para um serviço falhou**. AWS 
+ **WEBSOCKET\$1CONNECT\$1FAILURE** 
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1FORBIDDEN** 
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1INVALID\$1URL** 
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1TIMEOUT** 
+ **ALREADY\$1INITIALIZED** – O servidor ou cliente Amazon GameLift Servers já foi inicializado com Initialize(). 
+ **FLEET\$1MISMATCH** – A frota de destino não corresponde à frota de uma GameSession ou PlayerSession. 
+ **GAMELIFT\$1CLIENT\$1NOT\$1INITIALIZED** – O cliente Amazon GameLift Servers não foi inicializado. 
+ **GAMELIFT\$1SERVER\$1NOT\$1INITIALIZED** – O servidor Amazon GameLift Servers não foi inicializado. 
+ **GAME\$1SESSION\$1ENDED\$1FAILED** – O servidor de SDK para o Amazon GameLift Servers não foi capaz de contatar o serviço para reportar que a sessão de jogo terminou. 
+ **GAME\$1SESSION\$1ENDED\$1FAILED** – A sessão de jogo do Amazon GameLift Servers Server não foi ativada. 
+ **GAME\$1SESSION\$1READY\$1FAILED** – O Server SDK do Amazon GameLift Servers não conseguiu entrar em contato com o serviço para informar que a sessão do jogo está pronta. 
+ **INITIALIZATION\$1MISMATCH** – Um método de cliente foi chamado depois de Server::Initialize(), ou vice-versa. 
+ **NOT\$1INITIALIZED** – O Amazon GameLift Servers Server ou Client não foi inicializado com Initialize(). 
+ **NO\$1TARGET\$1ALIASID\$1SET** – Um aliasID de destino não foi definido. 
+ **NO\$1TARGET\$1FLEET\$1SET** – Uma frota alvo não foi definida. 
+ **PROCESS\$1ENDING\$1FAILED** – O Server SDK do Amazon GameLift Servers não conseguiu entrar em contato com o serviço para informar que o processo está sendo encerrado. 
+ **PROCESS\$1NOT\$1ACTIVE** — O processo do servidor ainda não está ativo, não está vinculado a um e não pode GameSession aceitar ou processar. PlayerSessions 
+ **PROCESS\$1NOT\$1READY** – O processo do servidor ainda não está pronto para ser ativado. 
+ **PROCESS\$1READY\$1FAILED** – O Server SDK do Amazon GameLift Servers não conseguiu entrar em contato com o serviço para informar que o processo está pronto. 
+ **SDK\$1VERSION\$1DETECTION\$1FAILED** – Falha na detecção da versão do SDK. 
+ **STX\$1CALL\$1FAILED — Uma chamada para o componente de back-end do XStx servidor falhou**. 
+ **STX\$1INITIALIZATION\$1FAILED — O componente de back-end do XStx servidor falhou** ao inicializar. 
+ **UNEXPECTED\$1PLAYER\$1SESSION** – Uma sessão de jogador não registrada foi encontrada pelo servidor. 
+ **WEBSOCKET\$1CONNECT\$1FAILURE** 
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1FORBIDDEN** 
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1INVALID\$1URL** 
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1TIMEOUT** 
+ **WEBSOCKET\$1RETRIABLE\$1SEND\$1MESSAGE\$1FAILURE — Falha recuperável ao enviar uma mensagem** ao Serviço. GameLift WebSocket 
+ **WEBSOCKET\$1SEND\$1MESSAGE\$1FAILURE — Falha ao enviar uma mensagem para o serviço**. GameLift WebSocket 
+ **MATCH\$1BACKFILL\$1REQUEST\$1VALIDATION** – A validação da solicitação falhou. 
+ **PLAYER\$1SESSION\$1REQUEST\$1VALIDATION** – A validação da solicitação falhou. 

**PlayerSessionCreationPolicy**  
Valor de string que indica se a sessão do jogo aceita novos jogadores. Os valores válidos são:   
+ **ACCEPT\$1ALL** – Aceite todas as novas sessões de jogador. 
+ **DENY\$1ALL** – Recuse todas as novas sessões de jogador. 
+ **NOT\$1SET** – A sessão do jogo não está configurada para aceitar ou negar sessões de novos jogadores. 

[SDK do servidor C\$1\$1 5.x para Amazon GameLift Servers -- Tipos de dados](integration-server-sdk5-cpp-datatypes.md)

**Topics**
+ [SDK do servidor C\$1\$1 5.x para Amazon GameLift Servers -- Tipos de dados](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>

Retorna o número da versão atual do SDK compilado no processo de servidor.

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

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

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

Se bem-sucedido, retornará a versão do SDK atual como um objeto [AwsStringOutcome](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-awsstringoutcome). O objeto retornada inclui apenas o número da versão (exemplo, `5.0.0`). Se não for bem-sucedido, retornará uma mensagem de erro.

### Exemplo
<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 o sistema de métricas para coletar e reportar dados de desempenho do servidor. Para obter melhores resultados, chame esse método antes de [InitSDK()](#integration-server-sdk5-cpp-initsdk) para ativar a coleta de métricas durante a inicialização do SDK.

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

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

### Parâmetros
<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 configuração para coleta de métricas. Se não for fornecido, usa valores padrão que podem ser substituídos por variáveis de ambiente.

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

Se for bem-sucedido, retornará um objeto [GenericOutcome](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-genericoutcome) indicando sucesso. Se não for bem-sucedido, retornará uma mensagem de erro.

### Exemplo
<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 o Amazon GameLift Servers SDK. Chame esse método na inicialização, antes de quaisquer outros passos de inicialização relacionados ao Amazon GameLift Servers. Esta ação lê os parâmetros do servidor do ambiente host para definir a comunicação entre o processo do servidor de jogos e o serviço do Amazon GameLift Servers. Ele usa um token de idempotência, então você repete essa chamada com segurança quando ela falhar.

Se a compilação do servidor de jogos for implantada sem o Amazon GameLift Servers Agent em uma frota do Amazon GameLift Servers Anywhere ou uma frota de contêineres, chame [InitSDK()](#integration-server-sdk5-cpp-initsdk-anywhere) e especifique um conjunto de parâmetros do servidor.

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

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

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

Retorna um objeto [Inicializar SDKOutcome](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-initsdkoutcome) que indica se o processo do servidor está pronto para ser chamado [ProcessReady()](#integration-server-sdk5-cpp-processready). 

### Exemplo
<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 o Amazon GameLift Servers SDK. Chame esse método na inicialização, antes de quaisquer outros passos de inicialização relacionados ao Amazon GameLift Servers. Essa ação exige um conjunto de parâmetros do servidor para configurar a comunicação entre o processo do servidor de jogo e o serviço do Amazon GameLift Servers. Ele usa um token de idempotência, então você repete essa chamada com segurança quando ela falhar.

Se a compilação do servidor de jogo for implantada em uma frota do EC2 gerenciada pelo Amazon GameLift Servers, em uma frota do Amazon GameLift Servers Anywhere ou em uma frota de contêineres com o Amazon GameLift Servers Agent, chame [InitSDK()](#integration-server-sdk5-cpp-initsdk) sem os parâmetros do servidor.

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

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

### Parâmetros
<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 um servidor de jogos em uma frota do Amazon GameLift Servers Anywhere, construa um objeto `ServerParameters` com as seguintes informações:  
+ O URL do WebSocket usado para se conectar ao seu servidor de jogo. 
+ O ID do processo usado para hospedar o servidor de jogos. 
+ O ID do computador que hospeda os processos do seu servidor de jogos. 
+ O ID da frota do Amazon GameLift Servers que contém sua computação Amazon GameLift Servers Anywhere.
+ O token de autorização gerado pela operação do Amazon GameLift Servers. 

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

Retorna um objeto [Inicializar SDKOutcome](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-initsdkoutcome) que indica se o processo do servidor está pronto para ser chamado [ProcessReady()](#integration-server-sdk5-cpp-processready). 

**nota**  
Se as chamadas para `InitSDK()` estiverem falhando para compilações de jogos implantadas em frotas do Anywhere, verifique o parâmetro `ServerSdkVersion` usado ao criar o recurso de compilação. Você deve definir explicitamente esse valor para a versão do SDK do servidor em uso. O valor padrão desse parâmetro é 4.x, o que não é compatível. Para resolver esse problema, crie uma nova versão e implante-a em uma nova frota.

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

Exemplo 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 o Amazon GameLift Servers de que o processo do servidor está pronto para hospedar sessões do jogo. Chame esse método após invocar [InitSDK()](#integration-server-sdk5-cpp-initsdk). Esse método deve ser chamado somente uma vez por processo.

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

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

### Parâmetros
<a name="integration-server-sdk5-cpp-processready-parameter"></a>

**processParameters**  
Um objeto [ProcessParameters](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-dataypes-process) que fornece as seguintes informações sobre o processo do servidor:  
+ Nomes de métodos de retorno de chamada, implementados no código do servidor de jogos, que o serviço Amazon GameLift Servers invoca para se comunicar com o processo de servidor.
+ Número da porta em que o processo de servidor está escutando.
+ Caminho de qualquer arquivo específico da sessão do jogo que você deseja que o Amazon GameLift Servers capture e armazene.

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

Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro.

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

Este exemplo ilustra as implementações das funções de chamada e delegação [ProcessReady()](#integration-server-sdk5-cpp-processready).

```
// Set parameters and call ProcessReady
std::string serverLog("serverOut.log");        // Example of a log file written by the game server
std::vector<std::string> logPaths;
logPaths.push_back(serverLog);
int listenPort = 9339;

Aws::GameLift::Server::ProcessParameters processReadyParameter = 
  Aws::GameLift::Server::ProcessParameters(
    std::bind(&Server::onStartGameSession, this, std::placeholders::_1),
    std::bind(&Server::onProcessTerminate, this), 
    std::bind(&Server::OnHealthCheck, this), 
    std::bind(&Server::OnUpdateGameSession, this), 
    listenPort, 
    Aws::GameLift::Server::LogParameters(logPaths)
  ); 

Aws::GameLift::GenericOutcome outcome = 
  Aws::GameLift::Server::ProcessReady(processReadyParameter);

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

void Server::onProcessTerminate()
{
  // game-specific tasks required to gracefully shut down a game session, 
  // such as notifying players, preserving game state data, and other cleanup
  GenericOutcome outcome = Aws::GameLift::Server::ProcessEnding();
}

bool Server::onHealthCheck()
{
  bool health;
  // complete health evaluation within 60 seconds and set health
  return health;
}
```

## ProcessReadyAsync()
<a name="integration-server-sdk5-cpp-processreadyasync"></a>

Notifica o serviço Amazon GameLift Servers de que o processo do servidor está pronto para hospedar sessões do jogo. Este método deve ser chamado depois que o processo do servidor estiver pronto para hospedar uma sessão de jogo. Os parâmetros especificam os nomes das funções de retorno do Amazon GameLift Servers para chamar determinadas circunstâncias. O código do servidor de jogos deve implementar essas funções.

Essa chamada é assíncrona. Para fazer uma chamada síncrona, use [ProcessReady()](#integration-server-sdk5-cpp-processready). Consulte [Inicializar o processo do servidor](gamelift-sdk-server-api.md#gamelift-sdk-server-initialize) para obter mais detalhes.

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

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

### Parâmetros
<a name="integration-server-sdk5-cpp-processreadyasync-parameter"></a>

**processParameters**  
Um objeto [ProcessParameters](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-dataypes-process) que fornece as seguintes informações sobre o processo do servidor:  
+ Nomes de métodos de retorno de chamada, implementados no código do servidor de jogos, que o serviço Amazon GameLift Servers invoca para se comunicar com o processo de servidor.
+ Número da porta em que o processo de servidor está escutando.
+ Caminho de qualquer arquivo específico da sessão do jogo que você deseja que o Amazon GameLift Servers capture e armazene.
Obrigatório: Sim

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

Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro.

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

Notifica o Amazon GameLift Servers de que o processo do servidor está sendo encerrado. Chame esse método depois de todas as outras tarefas de limpeza (incluindo o encerramento da sessão ativa do jogo) e antes de encerrar o processo. Dependendo do resultado `ProcessEnding()`, o processo sai com sucesso (0) ou erro (-1) e gera um evento de frota. Se o processo for encerrado com um erro, o evento de frota gerado será `SERVER_PROCESS_TERMINATED_UNHEALTHY`.

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

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

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

Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro.

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

Este exemplo chama `ProcessEnding()` e `Destroy()` antes de encerrar o processo do servidor com um código de saída bem-sucedido ou de erro.

```
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 o Amazon GameLift Servers de que o processo do servidor ativou uma sessão do jogo e já está pronto para receber as conexões do jogador. Essa ação deve ser chamada como parte da função de retorno de chamada `onStartGameSession()`, após toda inicialização da sessão do jogo.​

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

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

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

Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro.

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

Este exemplo mostra chamado `ActivateGameSession()` como parte da função de delegação `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>

Atualiza a capacidade da sessão do jogo atual para aceitar novas sessões de jogador. Atualiza a capacidade da sessão do jogo atual para aceitar novas sessões de jogador.

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

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

### Parâmetros
<a name="integration-server-sdk5-cpp-updateplayersessioncreationpolicy-parameter"></a>

**playerCreationSessionPolítica**  
Tipo: `PlayerSessionCreationPolicy` valor [enum](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-dataypes-enums).  
Obrigatório: Sim

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

Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro.

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

Este exemplo define a política de ingresso da sessão do jogo atual para aceitar todos os jogadores.

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

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

Recupera o ID da sessão de jogo hospedada pelo processo do servidor ativo. 

Para processos inativos que não são ativados com uma sessão de jogo, a chamada retorna um [GameLiftError](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-gamelifterror).

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

```
AwsStringOutcome GetGameSessionId()
```

### Parâmetros
<a name="integration-server-sdk5-cpp-getgamesessionid-parameter"></a>

Essa ação não tem um parâmetro.

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

Se bem-sucedido, retornará o ID da sessão de jogo como um objeto [AwsStringOutcome](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-awsstringoutcome). Se não for bem-sucedido, retornará uma mensagem de erro.

Para processos inativos que não são ativados com uma sessão de jogo, a chamada retorna `Success`=`True` e `GameSessionId`=`""`.

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

Retorna a hora em que um processo do servidor está programado para ser desligado, se essa informação estiver disponível. Um processo do servidor realiza a ação depois de receber um retorno de chamada `onProcessTerminate()` do serviço Amazon GameLift Servers. O Amazon GameLift Servers chama o `onProcessTerminate()` pelos seguintes motivos: 
+ Quando o processo do servidor relatou problemas de saúde ou não respondeu ao Amazon GameLift Servers.
+ Ao encerrar a instância durante um evento de redução.
+ Quando uma instância é encerrada devido a uma [interrupção na instância spot](spot-tasks.md).

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

```
AwsDateTimeOutcome GetTerminationTime()
```

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

Se for bem-sucedido, retornará o horário de término como um objeto `AwsDateTimeOutcome`. O valor é o tempo de rescisão, expresso em tiques decorridos desde então `0001 00:00:00`. Por exemplo, o valor da data e hora `2020-09-13 12:26:40 -000Z` é igual aos tiques `637355968000000000`. Se nenhum horário de encerramento estiver disponível, o retornará uma mensagem de erro.

Se o processo não tiver recebido um ProcessParameters. OnProcessTerminate() callback, uma mensagem de erro é retornada. Para obter mais informações sobre como desligar um processo do servidor, consulte [Responder a uma notificação de desligamento do processo do servidor](gamelift-sdk-server-api.md#gamelift-sdk-server-terminate).

### Exemplo
<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 o serviço Amazon GameLift Servers de que um jogador com o ID da sessão do jogador especificado se conectou ao processo do servidor e precisa de validação. O Amazon GameLift Servers confirma que o ID da sessão do jogador é válido. Depois que a sessão do jogador é validada, o Amazon GameLift Servers altera o status do slot do jogador de RESERVED para ACTIVE. 

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

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

### Parâmetros
<a name="integration-server-sdk5-cpp-acceptplayersession-parameter"></a>

playerSessionId  
ID exclusivo emitido pela Amazon GameLift Servers quando uma nova sessão de jogador é criada.

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

Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro. 

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

Este exemplo trata de uma solicitação de conexão que inclui a validação e a rejeição de uma sessão de jogador invá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>

Notifica o Amazon GameLift Servers de que um jogador se desconectou do processo do servidor. Em resposta, o Amazon GameLift Servers altera o espaço do jogador para disponível. 

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

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

### Parâmetros
<a name="integration-server-sdk5-cpp-removeplayersession-parameter"></a>

**`playerSessionId`**  
ID exclusivo emitido pela Amazon GameLift Servers quando uma nova sessão de jogador é criada.

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

Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro.

### Exemplo
<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 dados da sessão do jogador, que incluem configurações, metadados da sessão e dados do jogador. Use esse método para obter informações sobre o seguinte:
+ Uma sessão para um jogador
+ Todas as sessões de jogador em uma sessão de jogo
+ Todas as sessões de jogadores associadas a um único ID de jogador

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

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

### Parâmetros
<a name="integration-server-sdk5-cpp-describeplayersessions-parameter"></a>

**[DescribePlayerSessionsRequest](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-dataypes-playersessions)**  
Um objeto [DescribePlayerSessionsRequest](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-dataypes-playersessions) que descreve quais sessões de jogador recuperar.

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

Se bem-sucedido, retorna um objeto [DescribePlayerSessionsOutcome](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-describeplayersessionsoutcome) que contém um conjunto de objetos de sessão do jogador que atendem aos parâmetros de solicitação.

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

Este exemplo solicita todas as sessões de jogador conectadas ativamente a uma sessão de jogo especificada. Ao omitir *NextToken*e definir o valor *limite* como 10, Amazon GameLift Servers retorna os primeiros registros de sessão de 10 jogadores que correspondam à solicitação.

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

Envia uma solicitação para encontrar novos jogadores para os slots abertos em uma sessão de jogo criada com o FlexMatch. Para obter mais informações, consulte o [recurso de alocação do FlexMatch](https://docs.aws.amazon.com/gameliftservers/latest/flexmatchguide/match-backfill.html).

Esta ação é assíncrona. Se novos jogadores forem combinados, o Amazon GameLift Servers entregará os dados atualizados do marcador de jogos usando a função de retorno de chamada `OnUpdateGameSession()`.

Um processo de servidor pode ter apenas uma solicitação de alocação de correspondência ativa por vez. Para enviar uma nova solicitação, primeiro chame [StopMatchBackfill()](#integration-server-sdk5-cpp-stopmatchbackfill) para cancelar a solicitação original.

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

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

### Parâmetros
<a name="integration-server-sdk5-cpp-startmatchbackfill-parameter"></a>

**[StartMatchBackfillRequest](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-dataypes-startmatchbackfillrequest)**  
Um StartMatchBackfillRequest objeto que comunica as seguintes informações:  
+ ID do tíquete a ser atribuído à solicitação de alocação. Essas informações são opcionais; se nenhum ID for fornecido, o Amazon GameLift Servers gerará um.
+ O marcador de jogos para o qual a solicitação é enviada. O ARN completo da configuração é necessário. Esse valor está nos dados do marcador de jogos da sessão de jogo.
+ O ID da sessão de jogo a ser preenchida.
+ Os dados disponíveis de marcação para os jogadores atuais da sessão do jogo.

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

Retorna um objeto [StartMatchBackfillOutcome](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-datatypes-startmatchbackfilloutcome) com o ID do tíquete de alocação de correspondência ou um falha com uma mensagem de erro. 

### Exemplo
<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 uma solicitação de alocação de correspondência ativa. Para obter mais informações, consulte o [recurso de alocação do FlexMatch](https://docs.aws.amazon.com/gameliftservers/latest/flexmatchguide/match-backfill.html).

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

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

### Parâmetros
<a name="integration-server-sdk5-cpp-stopmatchbackfill-parameter"></a>

**[StopMatchBackfillRequest](integration-server-sdk5-cpp-datatypes.md#integration-server-sdk5-cpp-dataypes-stopmatchbackfillrequest)**  
Um StopMatchBackfillRequest objeto identificando o tíquete de matchmaking a ser cancelado:   
+ O ID do ticket atribuído à solicitação de alocação.
+ O marcador de jogo que recebeu a solicitação de alocação.
+ A sessão do jogo associada à solicitação de alocação.

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

Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro.

### Exemplo
<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 o caminho para o certificado TLS usado para criptografar a conexão de rede entre seu recurso de computação do Amazon GameLift Servers Anywhere e o Amazon GameLift Servers. Você poderá usar o caminho do certificado ao registrar seu dispositivo computacional em uma frota do Amazon GameLift Servers Anywhere. Para obter mais informações, consulte, [RegisterCompute](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html).

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

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

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

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

### Exemplo
<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 as credenciais do perfil do IAM que autorizam o Amazon GameLift Servers a interagir com outros Serviços da AWS. Para obter mais informações, consulte [Conecte seu servidor de jogos Amazon GameLift Servers hospedado a outros AWS recursos](gamelift-sdk-server-resources.md).

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

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

### Parâmetros
<a name="integration-server-sdk5-cpp-getfleetrolecredentials-parameters"></a>

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

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

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

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

Este exemplo mostra o uso do valor `RoleSessionName` opcional para atribuir um nome à sessão de credenciais para fins de auditoria. Se você não fornecer um nome de sessão de função, o valor padrão "*[fleet-id]*-*[host-id]*" será usado.

```
// 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 o SDK do servidor de jogos do Amazon GameLift Servers da memória. Como melhor prática, chame esse método antes `ProcessEnding()` e depois de encerrar o processo. Se você estiver usando uma frota Anywhere e não estiver encerrando os processos do servidor após cada sessão de jogo, chame `Destroy()` e reinicialize `InitSDK()` antes de notificar o Amazon GameLift Servers de que o processo está pronto para hospedar uma sessão de jogo com `ProcessReady()`.

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

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

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

Não há parâmetros.

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

Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro.

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