本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
# 适用于 Amazon GameLift Servers 的 Go 服务器 SDK – 操作
使用服务器 SDK 5.x 参考，将要托管的多人游戏与 Amazon GameLift Servers 集成。有关集成过程的指南，请参阅[借助服务器 SDK 将 Amazon GameLift Servers 添加到游戏服务器](gamelift-sdk-server-api.md)。
`GameLiftServerAPI.go`定义了 Go 服务器软件开发工具包 操作。
# 适用于 Amazon GameLift Servers 的 Go 服务器 SDK – 数据类型
使用服务器 SDK 参考，将要托管的多人游戏与 Amazon GameLift Servers 集成。有关集成过程的指南，请参阅[借助服务器 SDK 将 Amazon GameLift Servers 添加到游戏服务器](gamelift-sdk-server-api.md)。
`GameLiftServerAPI.go`定义了 Go 服务器软件开发工具包 操作。
[适用于 Amazon GameLift Servers 的 Go 服务器 SDK – 操作](integration-server-sdk-go-actions.md)
**Topics**
+ [LogParameters](#integration-server-sdk-go-dataypes-log)
+ [MetricsParameters](#integration-server-sdk-go-dataypes-metrics)
+ [ProcessParameters](#integration-server-sdk-go-dataypes-process)
+ [UpdateGameSession](#integration-server-sdk-go-dataypes-updategamesession)
+ [GameSession](#integration-server-sdk-go-dataypes-gamesession)
+ [ServerParameters](#integration-server-sdk-go-dataypes-serverparameters)
+ [StartMatchBackfillRequest](#integration-server-sdk-go-dataypes-startmatchbackfillrequest)
+ [玩家](#integration-server-sdk-go-dataypes-player)
+ [DescribePlayerSessionsRequest](#integration-server-sdk-go-dataypes-playersessions)
+ [StopMatchBackfillRequest](#integration-server-sdk-go-dataypes-stopmatchbackfillrequest)
+ [GetFleetRoleCredentialsRequest](#integration-server-sdk-go-dataypes-getfleetrolecredentialsrequest)
## LogParameters
一个对象，用于标识游戏会话期间生成的文件，您希望 Amazon GameLift Servers 在游戏会话结束后上传和存储这些文件。游戏服务器在 [ProcessReady()](integration-server-sdk-go-actions.md#integration-server-sdk-go-processready) 调用中，作为 `ProcessParameters` 对象的一部分向 Amazon GameLift Servers 提供 `LogParameters`。
| | |
| --- |--- |
| **属性** | 描述 |
| LogPaths | 您希望 Amazon GameLift Servers 用于存储供以后访问的游戏服务器日志文件的目录路径列表。服务器进程在每个游戏会话期间生成这些文件。文件路径和名称在游戏服务器中定义并存储在根游戏构建目录中。 日志路径必须是绝对的。例如，如果您的游戏构建在类似于 `MyGame\sessionLogs\` 的路径中存储游戏会话日志，则日志路径将为 (在 Windows 实例上) 或 (在 Linux 实例上)。 **类型**：`[]string` **必需**：否 |
## MetricsParameters
用于初始化指标系统的配置参数通信对象。此配置用于设置 StatsD 报告、崩溃报告和指标处理行为。游戏服务器通过调用 [InitMetrics()](integration-server-sdk-go-actions.md#integration-server-sdk-go-initmetrics) 向 Amazon GameLift Servers 提供 `MetricsParameters`。
| | |
| --- |--- |
| **属性** | 描述 |
| StatsdHost | 用于指标报告的 StatsD 服务器主机（例如“localhost”）。 **类型**：`string` **是否必需**：是 |
| StatsdPort | 用于指标报告的 StatsD 服务器端口（例如 8125）。 **类型**：`int` **是否必需**：是 |
| CrashReporterHost | 用于崩溃跟踪和进程监控的崩溃报告器主机。 **类型**：`string` **是否必需**：是 |
| CrashReporterPort | 用于崩溃跟踪和进程监控的崩溃报告器端口。 **类型**：`int` **是否必需**：是 |
| FlushIntervalMs | 指标刷新间隔（以毫秒为单位）。控制将指标发送到 StatsD 的频率。 **类型**：`int` **是否必需**：是 |
| MaxPacketSize | 指标的最大数据包大小（以字节为单位）。限制发送到 StatsD 的 UDP 数据包的大小。 **类型**：`int` **是否必需**：是 |
## ProcessParameters
描述服务器进程与 Amazon GameLift Servers 之间通信的对象。服务器进程通过调用 [ProcessReady()](integration-server-sdk-go-actions.md#integration-server-sdk-go-processready) 向 Amazon GameLift Servers 提供此信息。
| | |
| --- |--- |
| **属性** | 描述 |
| LogParameters | 一个对象，其中包含游戏会话期间生成的文件的目录路径。Amazon GameLift Servers 会复制并存储这些文件，以便将来访问。**类型**：`LogParameters`**必需**：否 |
| OnHealthCheck | Amazon GameLift Servers 为向服务器进程请求运行状况报告而调用的回调函数。Amazon GameLift Servers 每隔 60 秒调用此函数一次，并等待 60 秒以获取响应。TRUE如果运行状况良好，则服务器进程会返回，FALSE如果不健康，则返回。如果没有返回任何响应，Amazon GameLift Servers 会将服务器进程记录为运行状况不佳。**类型**：`OnHealthCheck func() bool`**必需**：否 |
| OnProcessTerminate | Amazon GameLift Servers 为强制关闭服务器进程而调用的回调函数。调用此函数之后，Amazon GameLift Servers 会等待 5 分钟，以确保服务器进程关闭并通过 [ProcessEnding()](integration-server-sdk-go-actions.md#integration-server-sdk-go-processending) 调用作出响应，随后才会终止该服务器进程。**类型**：`OnProcessTerminate func()`**是否必需**：是 |
| OnStartGameSession | Amazon GameLift Servers 为向服务器进程传递更新的游戏会话对象而调用的回调函数。当对战回填请求处理完毕时，Amazon GameLift Servers 会调用此函数以提供更新的对战构建器数据。它将传递一个 [GameSession](#integration-server-sdk-go-dataypes-gamesession) 对象、一个状态更新（updateReason）以及对战回填票证 ID。**类型**：`OnStartGameSession func (model.GameSession )`**是否必需**：是 |
| OnUpdateGameSession | Amazon GameLift Servers 为向服务器进程传递更新的游戏会话信息而调用的回调函数。当对战回填请求处理完毕时，Amazon GameLift Servers 会调用此函数以提供更新的对战构建器数据。**类型**：`OnUpdateGameSession func (model.UpdateGameSession)`**必需**：否 |
| Port | 服务器进程用于侦听新玩家连接的端口号。该值必须在部署此游戏服务器构建的任意实例集上所配置的端口范围内。此端口号包含在游戏会话和玩家会话对象中，游戏会话在连接到服务器进程时会使用该端口号。**类型**：`int`**是否必需**：是 |
## UpdateGameSession
游戏会话对象的更新，包括更新游戏会话的原因，以及相关的回填票证 ID（如果使用回填填填填充游戏会话中的玩家会话）。
| Properties | **描述** |
| --- | --- |
| GameSession | 一个 [GameSession](#integration-server-sdk-go-dataypes-gamesession) 对象。该GameSession对象包含描述游戏会话的属性。**类型**：`GameSession GameSession()`**是否必需**：是 |
| UpdateReason | 更新游戏会话的原因。**类型**：`UpdateReason UpdateReason()`**是否必需**：是 |
| BackfillTicketId | 尝试更新游戏会话的回填票证的 ID。**类型**：`String`**必需**：否 |
## GameSession
游戏会话的详细信息。
| Properties | **描述** |
| --- | --- |
| GameSessionId | 会话的唯一标识符。`arn:aws:gamelift:::gamesession//` 事件具有以下 Amazon 资源名称 (ARN) 格式。 **类型**：`String` **必需**：否 |
| Name | 游戏会话的描述性标签。 **类型**：`String` **必需**：否 |
| FleetId | 运行游戏会话的集的唯一标识符。 **类型**：`String` **必需**：否 |
| MaximumPlayerSessionCount | 机群中已连接到游戏会话的玩家数量。 **类型**：`Integer` **必需**：否 |
| 端口： | 游戏会话的端口号。要连接到Amazon GameLift Servers游戏服务器，应用程序需要 IP 地址和端口号。 **类型**：`Integer` **必需**：否 |
| IpAddress | 游戏会话的 IP 地址。要连接到Amazon GameLift Servers游戏服务器，应用程序需要 IP 地址和端口号。 **类型**：`String` **必需**：否 |
| GameSessionData | 一组自定义游戏会话属性，采用单个字符串值格式。 **类型**：`String` **必需**：否 |
| MatchmakerData | 有关用于创建游戏会话的对战过程的信息，采用 JSON 语法，格式为字符串。除了使用的对战配置外，它还包含分配到对战的所有玩家的数据，包括玩家属性和队伍分配。 **类型**：`String` **必需**：否 |
| GameProperties | 游戏会话的一组自定义属性，采用键值对格式。这些属性将通过启动新游戏会话的请求传递到游戏服务器进程。 **类型**：`map[string] string` **必需**：否 |
| DnsName | 分配给正在运行游戏会话的实例的 DNS 标识符。CRL 采用以下格式： [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/gameliftservers/latest/developerguide/integration-server-sdk-go-datatypes.html) 连接到在支持 TLS 的队列上运行的游戏会话时，必须使用 DNS 名称，而不是 IP 地址。 **类型**：`String` **必需**：否 |
## ServerParameters
用于维护 Amazon GameLift Servers Anywhere 服务器与 Amazon GameLift Servers 服务之间连接的信息。使用启动新的服务器进程时会使用此信息[InitSDK()](integration-server-sdk-go-actions.md#integration-server-sdk-go-initsdk)。对于托管在 Amazon GameLift Servers 托管式 EC2 实例上的服务器，请使用空对象。
| Properties | **描述** |
| --- | --- |
| WebSocketURL | 当您为 Amazon GameLift Servers Anywhere 计算资源调用 [https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html) 时，`GameLiftServerSdkEndpoint` Amazon GameLift Servers 会返回结果。 **类型**：`string` **是否必需**：是 |
| ProcessID | 注册到托管游戏的服务器进程的唯一标识符。 **类型**：`string` **是否必需**：是 |
| HostID | 托管新服务器进程的计算资源的唯一标识符。 `HostID`是在您注册计算机时`ComputeName`使用的。有关更多信息，请参阅 [RegisterCompute](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html)。 **类型**：`string` **是否必需**：是 |
| FleetID | 计算注册到的实例集的唯一标识符。有关更多信息，请参阅 [RegisterCompute](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html)。**类型**：`string`**是否必需**：是 |
| AuthToken | 由 Amazon GameLift Servers 生成的身份验证令牌，用于向 Amazon GameLift Servers 对您的服务器进行身份验证。有关更多信息，请参阅 [GetComputeAuthToken](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_GetComputeAuthToken.html)。**类型**：`string`**是否必需**：是 |
## StartMatchBackfillRequest
用于创建对战回填请求的信息。游戏服务器通过调用 [StartMatchBackfill()](integration-server-sdk-go-actions.md#integration-server-sdk-go-startmatchbackfill) 将这些信息传达给 Amazon GameLift Servers。
| Properties | **描述** |
| --- | --- |
| GameSessionArn | 游戏会话的唯一标识符。此 API 操作 `[GetGameSessionId](https://docs.aws.amazon.com/gameliftservers/latest/developerguide/integration-server-sdk-go-actions.html#integration-server-sdk-go-getgamesessionid)` 返回采用 ARN 格式的标识符。 **类型**：`String` **是否必需**：是 |
| MatchmakingConfigurationArn | 采用 ARN 格式的唯一标识符，适用于用于此请求的对战构建器。要查找用于创建原始游戏会话的对战构建器，请查看对战构建器数据属性中的游戏会话对象。有关对战构建器数据的更多信息，请参阅[使用对战构建器数据](https://docs.aws.amazon.com/gameliftservers/latest/flexmatchguide/match-server.html#match-server-data.html)。 **类型**：`String` **是否必需**：是 |
| 玩家 | 一组表示当前正在游戏会话中的所有玩家的数据。对战构建器使用此信息搜索与当前玩家非常匹配的新玩家。 **类型**：`[]model.Player` **是否必需**：是 |
| TicketId | 对战或匹配回填请求票证的唯一标识符。如果不提供值，Amazon GameLift Servers 会生成值。使用此标识符可跟踪对战回填票证状态或取消请求（如需要）。 **类型**：`String` **必需**：否 |
## 玩家
表示对战中的玩家的对象。启动对战请求时，玩家会有玩家 ID、属性数据以及可能的延迟数据。对战结束后，Amazon GameLift Servers 会添加团队信息。
| Properties | **描述** |
| --- | --- |
| LatencyInMS | 一组以毫秒为单位的值，表示玩家在连接到某个位置时所经历的延迟量。 如果使用此属性，则仅匹配列出的位置的玩家。如果对战构建器具有评估玩家延迟的规则，玩家必须报告延迟才能进行匹配。 **类型**：`map[string] int` **必需**：否 |
| PlayerAttributes | 键/值对的集合，其中包含用于对战的玩家信息。玩家属性键必须与配对规则集中 PlayerAttributes 使用的密钥相匹配。 有关玩家属性的更多信息，请参阅[AttributeValue](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_AttributeValue.html)。 **类型**：`map[string] AttributeValue` **必需**：否 |
| PlayerId | 玩家的唯一标识符。 **类型**：`String` **必需**：否 |
| Team | 玩家在对战中被分配到的团队的名称。您可以在对战规则集中定义团队名称。 **类型**：`String` **必需**：否 |
## DescribePlayerSessionsRequest
一个对象，用于指定要检索哪些玩家会话。服务器进程通过向 Amazon GameLift Servers 调用 [DescribePlayerSessions()](integration-server-sdk-go-actions.md#integration-server-sdk-go-describeplayersessions) 来提供此信息。
| Properties | **描述** |
| --- | --- |
| GameSessionID | 游戏会话的唯一标识符。使用此参数可请求指定游戏会话的所有玩家会话。 游戏会话 ID 的格式为`arn:aws:gamelift:::gamesession/fleet-/`。`GameSessionID`是自定义 ID 字符串或生成的字符串。 **类型**：`String` **必需**：否 |
| PlayerSessionID | 玩家会话的唯一标识符。使用此参数请求单个特定的玩家会话。 **类型**：`String` **必需**：否 |
| PlayerID | 玩家的唯一标识符。使用此参数可请求指定游戏会话的所有玩家会话。请参阅[生成玩家 ID](player-sessions-player-identifiers.md)。 **类型**：`String` **必需**：否 |
| PlayerSessionStatusFilter | 用于筛选结果的玩家会话状态。可能的玩家会话状态包括以下内容： [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/gameliftservers/latest/developerguide/integration-server-sdk-go-datatypes.html) **类型**：`String` **必需**：否 |
| NextToken | 令牌指示结果的下一个连续页面的开头。要指定结果集的开始，请不要指定值。如果指定玩家会话 ID，将忽略此参数。 **类型**：`String` **必需**：否 |
| Limit | 要返回的最大结果数量。如果指定玩家会话 ID，将忽略此参数。 **类型**：`int` **必需**：否 |
## StopMatchBackfillRequest
用于取消对战回填请求的信息。游戏服务器通过调用 [StopMatchBackfill()](integration-server-sdk-go-actions.md#integration-server-sdk-go-stopmatchbackfill) 将此信息传达给 Amazon GameLift Servers 服务。
| Properties | **描述** |
| --- | --- |
| GameSessionArn | 与被取消的请求关联的唯一游戏会话标识符。 **类型**：`string` **必需**：否 |
| MatchmakingConfigurationArn | 此请求发送到的对战构建器的唯一标识符。 **类型**：`string` **必需**：否 |
| TicketId | 要取消的回填请求票证的唯一标识符。 **类型**：`string` **必需**：否 |
## GetFleetRoleCredentialsRequest
将对 AWS 资源的有限访问权限扩展到游戏服务器的角色证书。有关更多信息，请参阅[为 Amazon GameLift Servers 设置 IAM 服务角色](setting-up-role.md)。
| Properties | **描述** |
| --- | --- |
| RoleArn | 将有限访问权限扩展到您的 AWS 资源的服务角色的 ARN。**类型**：`string`**是否必需**：是 |
| RoleSessionName | 描述角色证书使用情况的会话名称。**类型**：`string`**是否必需**：是 |
[适用于 Amazon GameLift Servers 的 Go 服务器 SDK – 数据类型](integration-server-sdk-go-datatypes.md)
**Topics**
+ [适用于 Amazon GameLift Servers 的 Go 服务器 SDK – 数据类型](integration-server-sdk-go-datatypes.md)
+ [GetSdkVersion()](#integration-server-sdk-go-getsdkversion)
+ [InitMetrics()](#integration-server-sdk-go-initmetrics)
+ [InitMetricsFromEnvironment()](#integration-server-sdk-go-initmetricsfromenv)
+ [InitSDK()](#integration-server-sdk-go-initsdk)
+ [ProcessReady()](#integration-server-sdk-go-processready)
+ [ProcessEnding()](#integration-server-sdk-go-processending)
+ [ActivateGameSession()](#integration-server-sdk-go-activategamesession)
+ [UpdatePlayerSessionCreationPolicy()](#integration-server-sdk-go-updateplayersessioncreationpolicy)
+ [GetGameSessionId()](#integration-server-sdk-go-getgamesessionid)
+ [GetTerminationTime()](#integration-server-sdk-go-getterm)
+ [AcceptPlayerSession()](#integration-server-sdk-go-acceptplayersession)
+ [RemovePlayerSession()](#integration-server-sdk-go-removeplayersession)
+ [DescribePlayerSessions()](#integration-server-sdk-go-describeplayersessions)
+ [StartMatchBackfill()](#integration-server-sdk-go-startmatchbackfill)
+ [StopMatchBackfill()](#integration-server-sdk-go-stopmatchbackfill)
+ [GetComputeCertificate()](#integration-server-sdk-go-getcomputecertificate)
+ [GetFleetRoleCredentials()](#integration-server-sdk-go-getfleetrolecredentials)
+ [Destroy](#integration-server-sdk-go-destroy)
## GetSdkVersion()
返回当前内置到服务器进程中的开发工具包的版本号。
### 语法
```
func GetSdkVersion() (string, error)
```
### 返回值
如果成功，返回以 对象返回当前软件开发工具包的版本。返回的字符串仅包含版本号 (例如：如果不成功，将返回错误消息。
### 示例
```
version, err := server.GetSdkVersion()
```
## InitMetrics()
初始化 Amazon GameLift Servers SDK 的指标收集。此方法设置指标报告，有助于监控服务器性能和运行状况。请在 [InitSDK()](#integration-server-sdk-go-initsdk) 之后、[ProcessReady()](#integration-server-sdk-go-processready) 之前调用此方法。
### 语法
```
func InitMetrics() error
func InitMetrics(metricsParameters MetricsParameters) error
```
### 参数
MetricsParameters （可选）
用于配置指标收集的 `MetricsParameters` 对象。如果未提供，则使用默认指标配置。该 MetricsParameters结构包含以下字段：
+ `StatsdHost` – StatsD 服务器的主机名或 IP 地址。
+ `StatsdPort` – StatsD 服务器进程的端口号。
+ `CrashReporterHost` – 崩溃报告服务的主机名或 IP 地址。
+ `CrashReporterPort` – 崩溃报告服务的端口号。
+ `FlushIntervalMs` – 刷新指标数据的时间间隔（以毫秒为单位）。
+ `MaxPacketSize` – 指标数据包的最大大小（以字节为单位）。
有关 MetricsParameters 结构的更多信息，请参阅适用于 [C\$1 数据类型的服务器 SDK 5.x](https://docs.aws.amazon.com/gameliftservers/latest/developerguide/integration-server-sdk5-csharp-datatypes.html)。
### 返回值
如果成功，则返回 `nil` 错误，表示指标收集已成功初始化。
### 示例
使用默认配置初始化指标：
```
err := server.InitMetrics()
```
使用自定义配置初始化指标：
```
metricsParams := MetricsParameters{
StatsdHost: "localhost",
StatsdPort: 8125,
CrashReporterHost: "localhost",
CrashReporterPort: 9125,
FlushIntervalMs: 5000,
MaxPacketSize: 1024,
}
err := server.InitMetrics(metricsParams)
```
## InitMetricsFromEnvironment()
使用环境变量中的配置初始化 Amazon GameLift Servers SDK 的指标收集。此方法使用从运行时环境中派生的默认设置来设置指标报告。
请在 [InitSDK()](#integration-server-sdk-go-initsdk) 之后、[ProcessReady()](#integration-server-sdk-go-processready) 之前调用此方法。
### 语法
```
func InitMetricsFromEnvironment() error
```
### 返回值
如果成功，则返回 `nil` 错误，表示已使用环境配置成功初始化指标收集。
### 示例
```
err := server.InitMetricsFromEnvironment()
```
## InitSDK()
初始化 Amazon GameLift Servers 开发工具包。在与 Amazon GameLift Servers 相关的任何其他初始化发生之前，在启动时调用此方法。此方法在服务器和 Amazon GameLift Servers 服务之间设置通信。
### 语法
```
func InitSDK(params ServerParameters) error
```
### 参数
[ServerParameters](integration-server-sdk-go-datatypes.md#integration-server-sdk-go-dataypes-serverparameters)
要在 Amazon GameLift Servers Anywhere 实例集上初始化游戏服务器，请使用以下信息构造 `ServerParameters` 对象：
+ WebSocket 用于连接到游戏服务器的 URL。
+ 用于托管游戏服务器的进程的 ID。
+ 托管游戏服务器进程的计算的 ID。
+ 包含您的 Amazon GameLift Servers Anywhere 计算的 Amazon GameLift Servers 实例集的 ID。
+ Amazon GameLift Servers 操作生成的授权令牌。
要在 Amazon GameLift Servers 托管式 EC2 实例集上初始化游戏服务器，请构造一个不带参数的 `ServerParameters` 对象。通过此次调用，Amazon GameLift Servers 代理为您设置计算环境并自动连接到 Amazon GameLift Servers 服务。
### 返回值
如果成功，则返回`nil`错误，表示服务器进程已准备好调用[ProcessReady()](#integration-server-sdk-go-processready)。
**注意**
如果对部署到 `InitSDK()` Anywhere 队列的游戏版本调用失败，请检查创建编译资源时使用的`ServerSdkVersion`参数。您必须将此值明确设置为正在使用的服务器软件开发工具包 版本。此参数的默认值为 4.x，这不兼容。要解决此问题，请创建新版本并将其部署到新队列。
### 示例
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)
```
Amazon GameLift Servers 托管式 EC2 示例
```
//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()
通知 Amazon GameLift Servers，该服务器进程已准备好托管游戏会话。调用后调用[InitSDK()](#integration-server-sdk-go-initsdk)此方法。每个进程只能调用一次此方法。
### 语法
```
func ProcessReady(param ProcessParameters) error
```
### 参数
**ProcessParameters**
[ProcessParameters](integration-server-sdk-go-datatypes.md#integration-server-sdk-go-dataypes-process) 对象，用于传输有关服务器进程的以下信息：
+ 游戏服务器代码中实现的回调方法的名称，Amazon GameLift Servers 服务调用其与服务器进程通信。
+ 服务器进程正在侦听的端口号。
+ [LogParameters](integration-server-sdk-go-datatypes.md#integration-server-sdk-go-dataypes-log) 数据类型包含您希望 Amazon GameLift Servers 服务器捕获并存储的任何游戏会话特定文件的路径。
### 返回值
如果方法失败，则返回带有错误消息的错误。如果刷新成功，则返回 `nil`。
### 示例
此示例说明 [ProcessReady()](#integration-server-sdk-go-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()
通知 Amazon GameLift Servers，该服务器进程即将终止。请在已完成所有其他清理任务（包括关闭活动游戏会话）但尚未终止进程时调用此方法。根据的结果`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 Servers，该服务器进程已激活游戏会话，现在已准备好接收玩家连接。此操作应作为 `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\$1ALL - 接受所有新玩家会话。
+ DENY\$1ALL - 拒绝所有新玩家会话。
### 返回值
如果发生故障，则返回带有错误消息的错误。
### 示例
此示例将当前游戏会话的接入策略设为接受所有玩家。
```
err := server.UpdatePlayerSessionCreationPolicy(model.AcceptAll)
```
## GetGameSessionId()
检索当前由服务器进程托管的游戏会话的 ID (如果服务器进程处于活动状态)。
### 语法
```
func GetGameSessionID() (string, error)
```
### 参数
此操作没有参数。
### 返回值
如果成功，以 对象返回游戏会话 ID。对于尚未通过游戏会话激活的空闲进程，该调用会返回一个空字符串和`nil`错误。
### 示例
```
gameSessionID, err := server.GetGameSessionID()
```
## GetTerminationTime()
如果终止时间可用，则返回安排服务器进程关闭的时间。服务器进程在收到来自 Amazon GameLift Servers 的 `onProcessTerminate()` 回调后执行此操作。Amazon GameLift Servers 会出于以下原因调用 `onProcessTerminate()`：
+ 服务器进程报告运行状况不佳或未响应 Amazon GameLift Servers。
+ 在缩减事件期间终止实例时。
+ 当实例因竞价[型实例中断而终](spot-tasks.md)止时。
### 语法
```
func GetTerminationTime() (int64, error)
```
### 返回值
如果成功，则返回服务器进程计划关闭和`nil`错误终止的时间戳（以纪元秒为单位）。该值是终止时间，以经过的刻度表示。`0001 00:00:00`例如，日期时间值等`2020-09-13 12:26:40 -000Z`于`637355968000000000`刻度。如果没有可用的终止时间，将返回一条错误消息。
### 示例
```
terminationTime, err := server.GetTerminationTime()
```
## AcceptPlayerSession()
通知 Amazon GameLift Servers，具有所指定玩家会话 ID 的玩家已连接到服务器进程并且需要进行验证。Amazon GameLift Servers 将验证该玩家会话 ID 是否有效。玩家会话经过验证后，Amazon GameLift Servers 会将玩家位置的状态从 `RESERVED` 更改为 `ACTIVE`。
### 语法
```
func AcceptPlayerSession(playerSessionID string) error
```
### 参数
`playerSessionId`
创建新玩家会话时由 Amazon GameLift Servers 颁发的唯一 ID。
### 返回值
返回由成功或失败组成的通用结果，并显示错误消息。
### 示例
此示例处理的连接请求包括验证和拒绝无效的玩家会话。 IDs
```
func ReceiveConnectingPlayerSessionID(conn Connection, playerSessionID string) {
err := server.AcceptPlayerSession(playerSessionID)
if err != nil {
connection.Accept()
} else {
connection.Reject(err.Error())
}
}
```
## RemovePlayerSession()
通知 Amazon GameLift Servers，有玩家已断开与服务器进程的连接。作为回应，Amazon GameLift Servers 会将玩家位置更改为可用。
### 语法
```
func RemovePlayerSession(playerSessionID string) error
```
### 参数
**`playerSessionId`**
创建新玩家会话时由 Amazon GameLift Servers 颁发的唯一 ID。
### 返回值
返回由成功或失败组成的通用结果，并显示错误消息。
### 示例
```
err := server.RemovePlayerSession(playerSessionID)
```
## DescribePlayerSessions()
检索玩家会话数据，包括设置、会话元数据和玩家数据。使用此方法获取有关以下内容的信息：
+ 单人游戏会话
+ 游戏会话中的所有玩家会话
+ 与单个玩家 ID 关联的所有玩家会话
### 语法
```
func DescribePlayerSessions(req request.DescribePlayerSessionsRequest) (result.DescribePlayerSessionsResult, error) {
return srv.describePlayerSessions(&req)
}
```
### 参数
**[DescribePlayerSessionsRequest](integration-server-sdk-go-datatypes.md#integration-server-sdk-go-dataypes-playersessions)**
`DescribePlayerSessionsRequest` 对象描述要检索的玩家会话。
### 返回值
如果成功，将返回一个 `DescribePlayerSessionsResult` 对象，包含一组与请求参数相匹配的玩家会话对象。
### 示例
此示例演示了将所有玩家会话主动连接到指定游戏会话的请求。省略*NextToken*并将 L *im* it 值设置为 10，即可Amazon GameLift Servers返回与请求匹配的前 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 回填功能](https://docs.aws.amazon.com/gameliftservers/latest/flexmatchguide/match-backfill.html)。
此操作为异步操作。如果成功匹配了新玩家，则 Amazon GameLift Servers 会使用回调函数 `OnUpdateGameSession()` 提供更新的对战构建器数据。
服务器进程每次只能具有一个活动的对战回填请求。要发送新请求，请先调用 [StopMatchBackfill()](#integration-server-sdk-go-stopmatchbackfill) 以取消原始请求。
### 语法
```
func StartMatchBackfill(req request.StartMatchBackfillRequest) (result.StartMatchBackfillResult, error)
```
### 参数
**[StartMatchBackfillRequest](integration-server-sdk-go-datatypes.md#integration-server-sdk-go-dataypes-startmatchbackfillrequest)**
StartMatchBackfillRequest 对象传达以下信息：
+ 要分配给回填请求的票证 ID。此信息是可选的；如果未提供任何 ID，则 Amazon GameLift Servers 将自动生成一个 ID。
+ 要将请求发送到的对战构建器。需要完整的配置 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 回填功能](https://docs.aws.amazon.com/gameliftservers/latest/flexmatchguide/match-backfill.html)。
### 语法
```
func StopMatchBackfill(req request.StopMatchBackfillRequest) error
```
### 参数
**[StopMatchBackfillRequest](integration-server-sdk-go-datatypes.md#integration-server-sdk-go-dataypes-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 Servers Anywhere 实例集时，您可以使用该证书路径。有关更多信息，请参阅 [RegisterCompute](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html)。
### 语法
```
func GetComputeCertificate() (result.GetComputeCertificateResult, error)
```
### 返回值
返回包含以下内容的`GetComputeCertificateResult`对象：
+ CertificatePath：计算资源上 TLS 证书的路径。使用 Amazon GameLift Servers 托管式实例集时，此路径包含：
+ `certificate.pem`：最终用户证书。完整的证书链是`certificateChain.pem`附加到此证书的组合。
+ `certificateChain.pem`：包含根证书和中间证书的证书链。
+ 根证书。
+ `privateKey.pem`：最终用户证书的私钥。
+ ComputeName：您的计算资源的名称。
### 示例
```
tlsCertificate, err := server.GetFleetRoleCredentials(getFleetRoleCredentialsRequest)
```
## GetFleetRoleCredentials()
检索您创建的用于将权限扩展 AWS 服务 到Amazon GameLift Servers其他角色的服务角色证书。这些凭据允许您的游戏服务器使用您的 AWS 资源。有关更多信息，请参阅 [为 Amazon GameLift Servers 设置 IAM 服务角色](setting-up-role.md)。
### 语法
```
func GetFleetRoleCredentials(
req request.GetFleetRoleCredentialsRequest,
) (result.GetFleetRoleCredentialsResult, error) {
return srv.getFleetRoleCredentials(&req)
}
```
### 参数
[GetFleetRoleCredentialsRequest](integration-server-sdk-go-datatypes.md#integration-server-sdk-go-dataypes-getfleetrolecredentialsrequest)
角色证书，用于将有限的 AWS 资源访问权限扩展到游戏服务器。
### 返回值
返回包含以下内容的`GetFleetRoleCredentialsResult`对象：
+ AssumedRoleUserArn -服务角色所属用户的亚马逊资源名称 (ARN)。
+ AssumedRoleId -服务角色所属用户的 ID。
+ AccessKeyId -用于对您的 AWS 资源进行身份验证和提供访问权限的访问密钥 ID。
+ SecretAccessKey -用于身份验证的私有访问密钥 ID。
+ SessionToken -用于识别与您的 AWS 资源交互的当前活动会话的令牌。
+ 过期-您的会话凭证到期之前的时间。
### 示例
```
// 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 Servers 游戏服务器 SDK。作为最佳实操，请在终止进程之后`ProcessEnding()`和之前调用此方法。如果您使用的是 Anywhere 实例集，并且没有在每次游戏会话后终止服务器进程，请先调用 `Destroy()`，再通过 `InitSDK()` 重新初始化，最后使用 `ProcessReady()` 通知 Amazon GameLift Servers 该进程已准备好托管游戏会话。
### 语法
```
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)
}
}
```