Amazon GameLift 服务器 SDK (Go) 参考:操作 - Amazon GameLift
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

Amazon GameLift 服务器 SDK (Go) 参考:操作

您可以使用此 Amazon GameLift Go 服务器 SDK 参考来帮助您为多人游戏做好准备,以便在亚马逊上使用 GameLift。有关集成过程的详细信息,请参阅将 Amazon GameLift 添加到您的游戏服务器

GameLiftServerAPI.go定义了 Go 服务器软件开发工具包 操作。

GetSdkVersion()

返回当前内置到服务器进程中的开发工具包的版本号。

语法

func GetSdkVersion() (string, error)

返回值

如果成功,返回以 对象返回当前软件开发工具包的版本。返回的字符串仅包含版本号 (例如:如果不成功,将返回错误消息。

示例

version, err := server.GetSdkVersion()

InitSDK()

初始化 Amazon GameLift 软件开发工具包。在启动时调用此方法,然后再进行任何其他与 Amazon GameLift 相关的初始化。此方法在服务器和 Amazon GameLift 服务之间设置通信。

语法

func InitSDK(params ServerParameters) error

参数

ServerParameters

要在 Amazon GameLift Anywhere 舰队上初始化游戏服务器,请使用以下信息构造一个ServerParameters对象:

  • WebSocket 用于连接到您的游戏服务器的 URL。

  • 用于托管游戏服务器的进程的 ID。

  • 托管游戏服务器进程的计算的 ID。

  • 包含您的亚马逊 GameLift Anywhere计算的亚马逊 GameLift 舰队的 ID。

  • Amazon GameLift 操作生成的授权令牌。

要在 Amazon GameLift 托管 EC2 队列上初始化游戏服务器,请构造一个不带参数的ServerParameters对象。通过此次调用,Amazon GameLift 代理为您设置计算环境并自动连接到 Amazon GameLift 服务。

返回值

如果成功,则返回nil错误,表示服务器进程已准备好调用ProcessReady()

注意

如果对部署到 InitSDK() Anywhere 队列的游戏版本调用失败,请检查创建编译资源时使用的ServerSdkVersion参数。您必须将此值明确设置为正在使用的服务器软件开发工具包 版本。此参数的默认值为 4.x,这不兼容。要解决此问题,请创建新版本并将其部署到新队列。

示例

亚马逊 GameLift 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 GameLift agent to enable further communication. err := server.InitSDK(serverParameters)

亚马逊 GameLift 托管 EC2 示例

//Define the server parameters serverParameters := ServerParameters {} //Call InitSDK to establish a local connection with the GameLift agent to enable further communication. err := server.InitSDK(serverParameters)

ProcessReady()

通知 Amaz GameLift on 服务器进程已准备好托管游戏会话。调用后调用InitSDK()此方法。每个进程只能调用一次此方法。

语法

func ProcessReady(param ProcessParameters) error

参数

ProcessParameters

ProcessParameters 对象,用于传输有关服务器进程的以下信息:

  • 游戏服务器代码中实现的回调方法的名称,Amazon GameLift 服务调用这些方法与服务器进程进行通信。

  • 服务器进程正在侦听的端口号。

  • 包含您希望 Ama GameLift zon 捕获和存储的任何游戏会话特定文件的路径LogParameters的数据类型。

返回值

如果方法失败,则返回带有错误消息的错误。如果刷新成功,则返回 nil

示例

此示例说明 ProcessReady() 调用和委派函数实施。

// 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()

通知 Amaz GameLift on 服务器进程即将终止。在完成所有其他清理任务(包括关闭活动游戏会话)之后和终止该进程之前,调用此方法。根据的结果ProcessEnding(),进程以成功 (0) 或错误 (-1) 退出并生成队列事件。如果流程因错误而终止,则生成的舰队事件为SERVER_PROCESS_TERMINATED_UNHEALTHY

语法

func ProcessEnding() error

返回值

返回 0 错误代码或定义的错误代码。

示例

// 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()

通知 Amazon GameLift 服务器进程已激活游戏会话,现在可以接收玩家连接了。此操作应作为 onStartGameSession() 回调函数的一部分,在所有游戏会话初始化已完成之后调用。

语法

func ActivateGameSession() error

返回值

如果方法失败,则返回带有错误消息的错误。

示例

此示例显示了 ActivateGameSession() 作为 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()

更新当前游戏会话接受新玩家会话的能力。可将游戏会话设置为接受或拒绝所有新的玩家会话。

语法

func UpdatePlayerSessionCreationPolicy(policy model.PlayerSessionCreationPolicy) error

参数

playerSessionCreation政策

用于指示游戏会话是否接受新玩家的字符串值。

有效值包括:

  • ACCEPT_ALL - 接受所有新玩家会话。

  • DENY_ALL - 拒绝所有新玩家会话。

返回值

如果发生故障,则返回带有错误消息的错误。

示例

此示例将当前游戏会话的接入策略设为接受所有玩家。

err := server.UpdatePlayerSessionCreationPolicy(model.AcceptAll)

GetGameSessionId()

检索当前由服务器进程托管的游戏会话的 ID (如果服务器进程处于活动状态)。

语法

func GetGameSessionID() (string, error)

参数

此操作没有参数。

返回值

如果成功,以 对象返回游戏会话 ID。对于尚未通过游戏会话激活的空闲进程,该调用会返回一个空字符串和nil错误。

示例

gameSessionID, err := server.GetGameSessionID()

GetTerminationTime()

如果终止时间可用,则返回安排服务器进程关闭的时间。服务器进程在收到 Amazon 的onProcessTerminate()回调后采取此操作 GameLift。Amazon GameLift 打电话onProcessTerminate()的原因如下:

  • 当服务器进程报告运行状况不佳或没有响应 Amazon 时 GameLift。

  • 在缩减事件期间终止实例时。

  • 当实例因竞价型实例中断而终止时。

语法

func GetTerminationTime() (int64, error)

返回值

如果成功,则返回服务器进程计划关闭和nil错误终止的时间戳(以纪元秒为单位)。该值是终止时间,以经过的刻度表示。0001 00:00:00例如,日期时间值等2020-09-13 12:26:40 -000Z637355968000000000刻度。如果没有可用的终止时间,将返回一条错误消息。

示例

terminationTime, err := server.GetTerminationTime()

AcceptPlayerSession()

通知 Amazon GameLift 具有指定玩家会话 ID 的玩家已连接到服务器进程,需要验证。Amazon 会 GameLift 验证玩家会话 ID 是否有效。玩家会话经过验证后,Amazon 会将玩家位置的状态从 GameLift 更改RESERVEDACTIVE

语法

func AcceptPlayerSession(playerSessionID string) error

参数

playerSessionId

创建新玩家会话 GameLift 时由 Amazon 颁发的唯一 ID。

返回值

返回由成功或失败组成的通用结果,并显示错误消息。

示例

此示例处理的连接请求包括验证和拒绝无效的玩家会话 ID。

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

RemovePlayerSession()

通知 Amazon GameLift 有玩家已断开与服务器进程的连接。作为回应,Amazon将玩家位置 GameLift 更改为可用。

语法

func RemovePlayerSession(playerSessionID string) error

参数

playerSessionId

创建新玩家会话 GameLift 时由 Amazon 颁发的唯一 ID。

返回值

返回由成功或失败组成的通用结果,并显示错误消息。

示例

err := server.RemovePlayerSession(playerSessionID)

DescribePlayerSessions()

检索玩家会话数据,包括设置、会话元数据和玩家数据。使用此方法获取有关以下内容的信息:

  • 单人游戏会话

  • 游戏会话中的所有玩家会话

  • 与单个玩家 ID 关联的所有玩家会话

语法

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

参数

DescribePlayerSessionsRequest

DescribePlayerSessionsRequest 对象描述要检索的玩家会话。

返回值

如果成功,将返回一个 DescribePlayerSessionsResult 对象,包含一组与请求参数相匹配的玩家会话对象。

示例

此示例演示了将所有玩家会话主动连接到指定游戏会话的请求。通过省略限制NextToken并将其设置为 10,Amazon 会 GameLift 返回与请求匹配的前 10 条玩家会话记录。

// 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()

发送请求以为使用 FlexMatch 创建的游戏会话中的开放位置查找新玩家。有关更多信息,请参阅FlexMatch 回填功能

此操作为异步操作。如果匹配了新玩家,Amazon会使用回调函数 GameLift 提供更新的匹配器数据OnUpdateGameSession()

服务器进程每次只能具有一个活动的匹配回填请求。要发送新请求,请先调用 StopMatchBackfill() 以取消原始请求。

语法

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

参数

StartMatchBackfillRequest

StartMatchBackfillRequest 对象传达以下信息:

  • 要分配给回填请求的票证 ID。此信息是可选的;如果未提供身份证,Amazon GameLift 会生成一个。

  • 要将请求发送到的对战构建器。需要完整的配置 ARN。该值位于游戏会话的对战构建器数据中。

  • 要回填的游戏会话的 ID。

  • 游戏会话的当前玩家的可用对战数据。

返回值

返回带有匹配回填票证 ID 的 StartMatchBackfillOutcome 对象或包含错误消息的失败。

示例

// 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()

取消使用 创建的活动对战回填请求。有关更多信息,请参阅FlexMatch回填功能

语法

func StopMatchBackfill(req request.StopMatchBackfillRequest) error

参数

StopMatchBackfillRequest

标识要取消的配对门票的 StopMatchBackfillRequest 对象:

  • 要分配给回填请求的票证 ID

  • 回填请求所发送到的对战构建器

  • 与回填请求关联的游戏会话

返回值

返回由成功或失败组成的通用结果,并显示错误消息。

示例

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

检索用于加密游戏服务器和游戏客户端之间网络连接的 TLS 证书的路径。当您将计算设备注册到 Amazon GameLift Anywhere 队列时,您可以使用证书路径。有关更多信息,请参阅RegisterCompute

语法

func GetComputeCertificate() (result.GetComputeCertificateResult, error)

返回值

返回包含以下内容的GetComputeCertificateResult对象:

  • CertificatePath:计算资源上的 TLS 证书的路径。使用 Amazon GameLift 托管队列时,此路径包含:

    • certificate.pem:最终用户证书。完整的证书链是certificateChain.pem附加到此证书的组合。

    • certificateChain.pem:包含根证书和中间证书的证书链。

    • 根证书。

    • privateKey.pem:最终用户证书的私钥。

  • ComputeName:您的计算资源的名称。

示例

tlsCertificate, err := server.GetFleetRoleCredentials(getFleetRoleCredentialsRequest)

GetFleetRoleCredentials()

检索您创建的服务角色证书,这些证书用于将权限扩展到您的其他角色Amazon Web Services以访问亚马逊 GameLift。这些凭据允许您的游戏服务器使用您的Amazon资源。有关更多信息,请参阅为亚马逊设置 IAM 服务角色 GameLift

语法

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

参数

GetFleetRoleCredentialsRequest

角色证书,用于将有限的Amazon资源访问权限扩展到游戏服务器。

返回值

返回包含以下内容的GetFleetRoleCredentialsResult对象:

  • AssumedRoleUserArn -服务角色所属用户的亚马逊资源名称 (ARN)。

  • AssumedRoleId -服务角色所属的用户的 ID。

  • AccessKeyId -用于对您的Amazon资源进行身份验证和提供访问权限的访问密钥 ID。

  • SecretAccessKey -用于身份验证的私有访问密钥 ID。

  • SessionToken -用于识别与您的Amazon资源交互的当前活动会话的令牌。

  • 过期-您的会话凭证到期之前的时间。

示例

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

Destroy

从内存中释放 Amazon GameLift 游戏服务器 SDK。作为最佳实操,请在终止进程之后ProcessEnding()和之前调用此方法。如果您使用的是 Anywhere 队列,并且没有在每次游戏会话后终止服务器进程,请先致电Destroy()然后InitSDK()重新初始化,然后再通知 A GameLift mazon 该进程已准备好与之托管游戏会话。ProcessReady()

语法

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

返回值

如果方法失败,则返回带有错误消息的错误。

示例

// 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) } }