SDK del servidor de Go para Amazon GameLift Servers: acciones

Utilice la referencia del SDK 5.x del servidor para integrar su juego multijugador para el alojamiento con Amazon GameLift Servers. Para obtener ayuda con el proceso de integración, consulte Adición de Amazon GameLift Servers al servidor de juegos con el SDK del servidor.

GameLiftServerAPI.go define las acciones del SDK del servidor de Go.

SDK del servidor de Go para Amazon GameLift Servers: tipos de datos

GetSdkVersion()

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

Sintaxis

func GetSdkVersion() (string, error)

Valor devuelto

Si funciona correctamente, devuelve la versión del SDK actual como una cadena. La cadena devuelta solo incluye el número de versión (por ejemplo, 5.0.0). Si no funciona, devuelve un mensaje de error, como common.SdkVersionDetectionFailed.

Ejemplo

version, err := server.GetSdkVersion()

InitMetrics()

Inicializa la recopilación de métricas para el SDK de Amazon GameLift Servers. Este método configura los informes de métricas para ayudar a supervisar el rendimiento y el estado de los servidores. Llame a este método después de InitSDK(), pero antes de ProcessReady().

Sintaxis

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

Parámetros

Valor devuelto

Si se realiza correctamente, devuelve un error nil para indicar que la recopilación de métricas se ha inicializado correctamente.

Ejemplo

Inicialización de las métricas con la configuración predeterminada:

err := server.InitMetrics()

Inicialización de las métricas con una configuración personalizada:

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

err := server.InitMetrics(metricsParams)

InitMetricsFromEnvironment()

Inicializa la recopilación de métricas para el SDK de Amazon GameLift Servers utilizando la configuración de las variables de entorno. Este método configura los informes de métricas utilizando la configuración predeterminada derivada del entorno de tiempo de ejecución.

Llame a este método después de InitSDK(), pero antes de ProcessReady().

Sintaxis

func InitMetricsFromEnvironment() error

Valor devuelto

Si se realiza correctamente, devuelve un error nil para indicar que la recopilación de métricas se ha inicializado correctamente con la configuración del entorno.

Ejemplo

err := server.InitMetricsFromEnvironment()

InitSDK()

Inicializa el SDK de Amazon GameLift Servers. Llame a este método en el lanzamiento, antes de cualquier otra inicialización relacionada con Amazon GameLift Servers. Este método establece la comunicación entre el servidor y el servicio Amazon GameLift Servers.

Sintaxis

func InitSDK(params ServerParameters) error 

Parámetros

Valor devuelto

Si funciona correctamente, devuelve el error nil para indicar que el proceso del servidor está listo para llamar a ProcessReady().

Ejemplo

Ejemplo de Amazon GameLift Servers Anywhere

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

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

Ejemplo de EC2 administrado por Amazon GameLift Servers

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

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

ProcessReady()

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

Sintaxis

func ProcessReady(param ProcessParameters) error

Parámetros

Valor devuelto

Devuelve un error con un mensaje de error si el método falla. Devuelve nil si el método se realiza correctamente.

Ejemplo

Este ejemplo ilustra las implementaciones tanto de la función de llamada ProcessReady() como de la función de delegación.

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

err := server.ProcessReady(processParams)

ProcessEnding()

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

Sintaxis

func ProcessEnding() error

Valor devuelto

Devuelve un código de error 0 o un código de error definido.

Ejemplo

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

ActivateGameSession()

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

Sintaxis

func ActivateGameSession() error

Valor devuelto

Devuelve un error con un mensaje de error si el método falla.

Ejemplo

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

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

UpdatePlayerSessionCreationPolicy()

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

Sintaxis

func UpdatePlayerSessionCreationPolicy(policy model.PlayerSessionCreationPolicy) error

Parámetros

Valor devuelto

Devuelve un error con un mensaje de error si se produce un error.

Ejemplo

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

err := server.UpdatePlayerSessionCreationPolicy(model.AcceptAll)

GetGameSessionId()

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

Sintaxis

func GetGameSessionID() (string, error)

Parámetros

Esta acción no tiene parámetros.

Valor devuelto

Si funciona correctamente, devuelve el ID de sesión del juego y el error nil. En el caso de los procesos inactivos que no se han activado aún con una sesión de juego, la llamada devuelve una cadena vacía y el error nil.

Ejemplo

gameSessionID, err := server.GetGameSessionID()

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 del servidor realiza esta acción después de recibir una devolución de llamada onProcessTerminate() desde Amazon GameLift Servers. Amazon GameLift Servers llama a onProcessTerminate() por los motivos siguientes:

Sintaxis

func GetTerminationTime() (int64, error)

Valor devuelto

Si se ejecuta correctamente, devuelve la marca temporal en segundos en la que está previsto que el proceso del servidor se cierre y finalice el error nil. El valor es la hora de terminación expresado en ciclos transcurridos desde 0001 00:00:00. Por ejemplo, el valor de la fecha y hora 2020-09-13 12:26:40 -000Z es igual a 637355968000000000 ciclos. Si no hay una hora de terminación disponible, devuelve un mensaje de error.

Ejemplo

terminationTime, err := server.GetTerminationTime()

AcceptPlayerSession()

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

Sintaxis

func AcceptPlayerSession(playerSessionID string) error

Parámetros

Valor devuelto

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

Ejemplo

En este ejemplo, se administra una solicitud de conexión que incluye la validación y el rechazo de los ID de sesión de los jugadores no válidos.

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

RemovePlayerSession()

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

Sintaxis

func RemovePlayerSession(playerSessionID string) error

Parámetros

Valor devuelto

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

Ejemplo

err := server.RemovePlayerSession(playerSessionID)

DescribePlayerSessions()

Recupera datos de sesión de jugador, incluida la configuración, los metadatos de la sesión y los datos de jugador. Utilice este método para obtener información sobre los siguientes elementos:

Sintaxis

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

Parámetros

Valor devuelto

Si funciona correctamente, devuelve un objeto DescribePlayerSessionsResult que contiene un conjunto de objetos de sesión de jugador que se ajusta a los parámetros de la solicitud.

Ejemplo

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

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

describePlayerSessionsResult, err := server.DescribePlayerSessions(describePlayerSessionsRequest)

StartMatchBackfill()

Envía una solicitud para encontrar nuevos jugadores para ranuras abiertas en una sesión de juego creada con FlexMatch. Para obtener más información, consulte Característica de reposición de FlexMatch.

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

Un proceso del servidor solo puede tener una solicitud de reposición de emparejamiento activa a la vez. Para enviar una nueva solicitud, en primer lugar llame a StopMatchBackfill() para cancelar la solicitud original.

Sintaxis

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

Parámetros

Valor devuelto

Devuelve un objeto StartMatchBackfillResult con el ID del ticket de reposición de emparejamiento o un error con un mensaje de error.

Ejemplo

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

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

StopMatchBackfill()

Cancela una solicitud de reposición de emparejamiento activa. Para obtener más información, consulte Característica de reposición de FlexMatch.

Sintaxis

func StopMatchBackfill(req request.StopMatchBackfillRequest) error

Parámetros

Valor devuelto

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

Ejemplo

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

GetComputeCertificate()

Recupera la ruta al certificado TLS utilizado para cifrar la conexión de red entre el servidor de juegos y el cliente de juego. Puede utilizar la ruta del certificado al registrar el dispositivo informático en una flota de Amazon GameLift Servers Anywhere. Para obtener más información, consulte RegisterCompute.

Sintaxis

func GetComputeCertificate() (result.GetComputeCertificateResult, error)

Valor devuelto

Devuelve un objeto GetComputeCertificateResult que contiene los siguientes elementos:

Ejemplo

tlsCertificate, err := server.GetFleetRoleCredentials(getFleetRoleCredentialsRequest)

GetFleetRoleCredentials()

Recupera las credenciales del rol de servicio que creó para extender los permisos a sus otros Servicios de AWS a Amazon GameLift Servers. Estas credenciales permiten que su servidor de juegos utilice sus recursos de AWS. Para obtener más información, consulte Configuración de un rol de servicio de IAM para Amazon GameLift Servers.

Sintaxis

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

Parámetros

Valor devuelto

Devuelve un objeto GetFleetRoleCredentialsResult que contiene los siguientes elementos:

Ejemplo

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

credentials, err := server.GetFleetRoleCredentials(getFleetRoleCredentialsRequest)

Destroy()

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

Sintaxis

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

Valor devuelto

Devuelve un error con un mensaje de error si el método falla.

Ejemplo

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