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.

GameLift Servidor Amazon SDK 4.x para C++: acciones

Usa la SDK referencia del servidor Amazon GameLift C++ para integrar tu juego multijugador y alojarlo en Amazon GameLift. Para obtener información sobre el proceso de integración, consulteAñade Amazon GameLift a tu servidor de juegos.

Amazon GameLift server SDK 4.x para C++: tipos de datos

AcceptPlayerSession()

Notifica al GameLift servicio de Amazon que un jugador con el identificador de sesión de jugador especificado se ha conectado al proceso del servidor y necesita ser validado. Amazon GameLift verifica que el identificador de sesión del jugador sea válido, es decir, que el identificador del jugador haya reservado un espacio de jugador en la sesión de juego. Una vez validada, Amazon GameLift cambia el estado de la tragaperras del jugador de RESERVED aACTIVE.

Sintaxis

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

Parámetros

Valor devuelto

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

Ejemplo

Este ejemplo ilustra una función para gestionar una solicitud de conexión, que incluye validar y rechazar 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();
    }       
}

ActivateGameSession()

Notifica al GameLift servicio Amazon de que el proceso del servidor ha iniciado una sesión de juego y ahora 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 completar la inicialización de todas las sesiones de juego.

Sintaxis

GenericOutcome ActivateGameSession();

Parámetros

Esta acción no tiene parámetros.

Valor devuelto

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

Ejemplo

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

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

DescribePlayerSessions()

Recupera datos de sesión de jugador, incluida la configuración, los metadatos de la sesión y los datos de jugador. Utilice esta acción para obtener información para una única sesión de jugador, para todas las sesiones de jugador de una sesión de juego o para todas las sesiones de jugador asociadas a un solo ID de jugador.

Sintaxis

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

Parámetros

Valor devuelto

Si funciona correctamente, devuelve un objeto DescribePlayerSessionsOutcome que contiene un conjunto de objetos de sesión de jugador que se ajusta a los parámetros de la solicitud. Los objetos de sesión del jugador tienen una estructura idéntica al tipo de GameLift API PlayerSessiondatos de AWS SDK Amazon.

Ejemplo

Este ejemplo muestra una solicitud de todas las sesiones de jugador conectadas activamente a una sesión de juego específica. Al omitir NextToken y establecer el Limit valor en 10, Amazon GameLift devuelve los registros de las primeras 10 sesiones de jugador que coinciden 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);

GetGameSessionId()

Recupera un identificador único de la sesión de juego alojada actualmente por el proceso del servidor, siempre que esté activo. El identificador se devuelve en el ARN formato:arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>.

En el caso de los procesos inactivos que no activados aún con una sesión de juego, la llamada devuelve Success=True y GameSessionId="" (una cadena vacía).

Sintaxis

AwsStringOutcome GetGameSessionId();

Parámetros

Esta acción no tiene parámetros.

Valor devuelto

Si funciona correctamente, devuelve el ID de sesión del juego como objeto AwsStringOutcome. Si no funciona, devuelve un mensaje de error.

Ejemplo

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

GetInstanceCertificate()

Recupera la ubicación del archivo de un TLS certificado codificado con PEM que está asociado a la flota y sus instancias. AWS Certificate Manager genera este certificado al crear una nueva flota con la configuración del certificado establecida en. GENERATED Utilice este certificado para establecer una conexión segura con un cliente de juego y para cifrar la comunicación cliente/servidor.

Sintaxis

GetInstanceCertificateOutcome GetInstanceCertificate();

Parámetros

Esta acción no tiene parámetros.

Valor devuelto

Si se ejecuta correctamente, devuelve un GetInstanceCertificateOutcome objeto que contiene la ubicación del archivo de TLS certificados y la cadena de certificados de la flota, que se almacenan en la instancia. En la instancia también se almacena un archivo de certificado raíz extraído de la cadena de certificados. Si no funciona, devuelve un mensaje de error.

Para obtener más información sobre el certificado y los datos de la cadena de certificados, consulte los elementos de GetCertificate respuesta en la AWS Certificate Manager API referencia.

Ejemplo

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

GetSdkVersion()

Devuelve el número de versión actual de la que SDK está en uso.

Sintaxis

AwsStringOutcome GetSdkVersion();

Parámetros

Esta acción no tiene parámetros.

Valor devuelto

Si tiene éxito, devuelve la SDK versión actual como un AwsStringOutcome objeto. La cadena devuelta solo incluye el número de versión (por ejemplo, («3.1.5»). Si no funciona, devuelve un mensaje de error.

Ejemplo

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

GetTerminationTime()

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 de servidor realiza esta acción después de recibir una onProcessTerminate() llamada del GameLift servicio de Amazon. Amazon GameLift puede llamar onProcessTerminate() por los siguientes motivos: (1) cuando el proceso del servidor ha informado de un mal estado o no ha respondido a Amazon GameLift, (2) cuando se termina la instancia durante un evento de reducción de escala o (3) cuando una instancia se cierra debido a una interrupción puntual.

Si el proceso ha recibido una devolución de llamada onProcessTerminate(), el devuelto es la hora de terminación estimada. Si el proceso no ha recibido ninguna devolución de llamada onProcessTerminate(), se devuelve un mensaje de error. Más información acerca del apagado de un proceso de servidor.

Sintaxis

AwsLongOutcome GetTerminationTime();

Parámetros

Esta acción no tiene parámetros.

Valor devuelto

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

Ejemplo

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

Init () SDK

Inicializa Amazon GameLift SDK. Se debe llamar a este método en el momento del lanzamiento, antes de que se produzca cualquier otra inicialización GameLift relacionada con Amazon.

Sintaxis

InitSDKOutcome InitSDK();

Parámetros

Esta acción no tiene parámetros.

Valor devuelto

Si se ejecuta correctamente, devuelve un InitSdkOutcome objeto que indica que el proceso del servidor está listo para la llamadaProcessReady().

Ejemplo

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

ProcessEnding()

Notifica al GameLift servicio de Amazon que el proceso del servidor se está cerrando. Este método debe llamarse después de realizar las demás tareas de limpieza, incluido el cierre de todas las sesiones de juego activas. Se debe salir de este método con un código de salida de 0; un código de salida que no sea 0 provoca un mensaje de evento que afirma que no se ha salido del proceso correctamente.

Después de que el método finalice con un código de 0, puede terminar el proceso con un código de salida correcto. También puede salir del proceso con un código de error. Si sale con un código de error, el evento de la flota indicará que el proceso ha finalizado incorrectamente (SERVER_PROCESS_TERMINATED_UNHEALTHY).

Sintaxis

GenericOutcome ProcessEnding();

Parámetros

Esta acción no tiene parámetros.

Valor devuelto

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

Ejemplo

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

ProcessReady()

Notifica al GameLift servicio de Amazon que el proceso del servidor está listo para albergar sesiones de juego. Llame a este método después de invocar correctamente a Init () SDK y completar las tareas de configuración necesarias antes de que el proceso del servidor pueda alojar una sesión de juego. Se debe llamar a este método solo una vez por proceso.

La llamada es síncrona. Para realizar una llamada asíncrona, utilice ProcessReadyAsync(). Consulte Inicialización del proceso del servidor para obtener más detalles.

Sintaxis

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

Parámetros

Valor devuelto

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

Ejemplo

Este ejemplo ilustra las implementaciones tanto de la función de llamada como de la función de devolución de llamada 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()

Notifica al GameLift servicio de Amazon que el proceso del servidor está listo para albergar sesiones de juego. Este método debe llamarse cuando el proceso del servidor esté listo para alojar una sesión de juego. Los parámetros especifican los nombres de las funciones de devolución de llamada GameLift a las que Amazon puede llamar 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(). Consulte Inicialización del proceso del servidor para obtener más detalles.

Sintaxis

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

Parámetros

Valor devuelto

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

Ejemplo

// Set parameters and call ProcessReady
std::string serverLog("serverOut.log");        // This is an example of a log file written by the game server
std::vector<std::string> logPaths;
logPaths.push_back(serverLog);

int listenPort = 9339;

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

Aws::GameLift::GenericOutcomeCallable outcome = 
   Aws::GameLift::Server::ProcessReadyAsync(processReadyParameter);

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

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

bool onHealthCheck()
{
    // perform health evaluation and complete within 60 seconds
    return health;
}        

RemovePlayerSession()

Notifica al GameLift servicio de Amazon que un jugador con el identificador de sesión de jugador especificado se ha desconectado del proceso del servidor. En respuesta, Amazon GameLift cambia el espacio del jugador a disponible, lo que permite asignarlo a un nuevo jugador.

Sintaxis

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

Parámetros

Valor devuelto

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

Ejemplo

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

StartMatchBackfill()

Envía una solicitud para encontrar nuevos jugadores en las tragaperras abiertas en una sesión de juego creada con FlexMatch. Véase también la AWS SDK acción StartMatchBackfill(). Con esta acción, un proceso del servidor de juegos que aloja la sesión de juego puede iniciar solicitudes de reposición de emparejamiento. Más información sobre la función FlexMatch de relleno.

Esta acción es asíncrona. Si los nuevos jugadores se emparejan correctamente, el GameLift servicio Amazon proporciona datos actualizados de los emparejadores invocando 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() para cancelar la solicitud original.

Sintaxis

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

Parámetros

Valor devuelto

Devuelve un StartMatchBackfillOutcome objeto con un mensaje de error que indica que no se ha completado el partido o que no lo ha conseguido. El estado de las entradas se puede rastrear mediante la AWS SDK acción DescribeMatchmaking().

Ejemplo

// Build a backfill request
std::vector<Player> players;
Aws::GameLift::Server::Model::StartMatchBackfillRequest startBackfillRequest;
startBackfillRequest.SetTicketId("a ticket ID");                                         //optional, autogenerated if not provided
startBackfillRequest.SetMatchmakingConfigurationArn("the matchmaker configuration ARN"); //from the game session matchmaker data
startBackfillRequest.SetGameSessionArn("the game session ARN");                          // can use GetGameSessionId()
startBackfillRequest.SetPlayers(players);                                                  //from the game session matchmaker data

// Send backfill request
Aws::GameLift::StartMatchBackfillOutcome backfillOutcome = 
    Aws::GameLift::Server::StartMatchBackfill(startBackfillRequest);

// Implement callback function for backfill
void Server::OnUpdateGameSession(Aws::GameLift::Server::Model::GameSession gameSession, Aws::GameLift::Server::Model::UpdateReason updateReason, std::string backfillTicketId)
{
   // handle status messages
   // perform game-specific tasks to prep for newly matched players
}

StopMatchBackfill()

Cancela una solicitud de reposición de emparejamiento activa que se creó con StartMatchBackfill(). Consulte también la AWS SDK acción StopMatchmaking(). Más información sobre la función FlexMatch de relleno.

Sintaxis

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

Parámetros

Valor devuelto

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

Ejemplo

// Set backfill stop request parameters

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

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

TerminateGameSession()

Este método está obsoleto con la versión 4.0.1. En su lugar, el proceso del servidor debería llamar a ProcessEnding() una vez finalizada la sesión de juego.

Notifica al GameLift servicio de Amazon que el proceso del servidor ha finalizado la sesión de juego actual. Se llama a esta acción cuando el proceso del servidor permanece activo y listo para alojar una nueva sesión de juego. Solo debes llamarlo después de completar el procedimiento de finalización de la sesión de juego, ya que indica a Amazon GameLift que el proceso del servidor está disponible inmediatamente para alojar una nueva sesión de juego.

No se llamará a esta acción si el proceso del servidor se interrumpe una vez finalizada la sesión de juego. En su lugar, se llamará a ProcessEnding() para indicar que tanto la sesión de juego como el proceso del servidor están finalizando.

Sintaxis

GenericOutcome TerminateGameSession();

Parámetros

Esta acción no tiene parámetros.

Valor devuelto

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

UpdatePlayerSessionCreationPolicy()

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. Véase también la AWS SDK acción UpdateGameSession().

Sintaxis

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

Parámetros

Valor devuelto

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

Ejemplo

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

Destroy()

Limpia la memoria asignada por init SDK () durante la inicialización del servidor del juego. Utilice este método después de finalizar un proceso de servidor de juegos para evitar desperdiciar memoria del servidor.

Sintaxis

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

Parámetros

No hay parámetros.

Valor devuelto

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

Ejemplo

Este ejemplo limpia la memoria asignada por init una vez finalizado el proceso SDK del servidor de juegos.

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