亚马逊 GameLift 服务器 SDK (C++) 参考：数据类型 - Amazon GameLift
LogParametersProcessParametersUpdateGameSessionGameSessionServerParametersStartMatchBackfillRequest玩家DescribePlayerSessionsRequestStopMatchBackfillRequestAttributeValueGetFleetRoleCredentialsRequestAwsLongOutcomeAwsStringOutcomeDescribePlayerSessionsOutcomeDescribePlayerSessionsResultGenericOutcomeGenericOutcomeCallablePlayerSessionStartMatchBackfillOutcomeStartMatchBackfillResultGetComputeCertificateOutcomeGetComputeCertificateResultGetFleetRoleCredentialsOutcomeGetFleetRoleCredentialsResult我 nitSDKOutcomeGameLiftError枚举

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

亚马逊 GameLift 服务器 SDK (C++) 参考：数据类型

您可以使用此 Amazon GameLift C++ 服务器SDK参考来帮助您准备多人游戏以供亚马逊使用 GameLift。有关集成过程的详细信息，请参阅将 Amazon GameLift 添加到您的游戏服务器。

注意

本主题介绍在使用 GameLift C++ API 标准库 (std) 进行构建时可以使用的 Amazon C++。具体而言，本文档适用于使用该-DDGAMELIFT_USE_STD=1选项编译的代码。

LogParameters

一个对象，用于标识游戏会话期间生成的文件，您希望 Amazon GameLift 在游戏会话结束后上传和存储这些文件。游戏服务器在ProcessReady()调用中 GameLift 作为ProcessParameters对象的一部分提供LogParameters给 Amazon。

属性

 描述
LogPaths

您希望 Amazon GameLift 存储以备将来访问的游戏服务器日志文件的目录路径列表。服务器进程在每个游戏会话期间生成这些文件。文件路径和名称在游戏服务器中定义并存储在根游戏构建目录中。

日志路径必须是绝对的。例如，如果您的游戏构建在类似于 MyGame\sessionLogs\ 的路径中存储游戏会话日志，则日志路径将为 (在 Windows 实例上) 或 (在 Linux 实例上)。

类型：std:vector<std::string>

必需：否

ProcessParameters

此数据类型包含在 a 中发送给 Amazon GameLift 的一组参数ProcessReady()。

属性

 描述
LogParameters 一个对象，其中包含游戏会话期间生成的文件的目录路径。Amazon 会 GameLift 复制并存储文件以备将来访问。

类型：Aws::GameLift::Server::LogParameters

必需：否
OnHealthCheck Amazon 为向服务器 GameLift 进程请求健康状态报告而调用的回调函数。Amazon 每 60 秒 GameLift 调用一次此函数，并等待 60 秒等待响应。TRUE如果运行状况良好，则服务器进程会返回，FALSE如果不健康，则返回。如果未返回任何响应，Amazon 会将服务器进程 GameLift 记录为运行状况不佳。

类型：std::function<bool()> onHealthCheck

必需：否
OnProcessTerminate Amazon 为强制关闭服务器进程而 GameLift 调用的回调函数。调用此函数后，Amazon 会等待 5 分钟， GameLift 等待服务器进程关闭并通过ProcessEnding()调用进行响应，然后再关闭服务器进程。

类型：std::function<void()> onProcessTerminate

必需：是
OnRefreshConnection Amazon 为刷新与游戏 GameLift 服务器的连接而调用的回调函数的名称。

类型：void OnRefreshConnectionDelegate()

必需：是
OnStartGameSession Amazon 为激活新游戏 GameLift 会话而调用的回调函数。Amazon GameLift 调用此函数是为了响应客户请求CreateGameSession。回调函数传递一个GameSession对象。

类型：const std::function<void(Aws::GameLift::Model::GameSession)> onStartGameSession

必需：是
OnUpdateGameSession Amazon GameLift 调用的回调函数，用于将更新的游戏会话对象传递给服务器进程。当已处理匹配回填请求以提供更新的匹配器数据时，Amazon会 GameLift 调用此函数。它传递一个GameSession对象、一个状态更新 (updateReason) 和匹配回填票证 ID。

类型：std::function<void(Aws::GameLift::Server::Model::UpdateGameSession)> onUpdateGameSession

必需：否
端口 服务器进程用于侦听新玩家连接的端口号。该值必须在部署此游戏服务器构建的任意实例集上所配置的端口范围内。此端口号包含在游戏会话和玩家会话对象中，游戏会话在连接到服务器进程时使用。

类型：Integer

必需：是

UpdateGameSession

此数据类型更新为游戏会话对象，其中包括更新游戏会话的原因以及相关的回填票证 ID（如果使用回填来填充游戏会话中的玩家会话）。

属性 描述
GameSession 一个 GameSession 对象。该GameSession对象包含描述游戏会话的属性。

类型：Aws::GameLift::Server::GameSession

必需：是
UpdateReason 更新游戏会话的原因。

类型：Aws::GameLift::Server::UpdateReason

必需：是
BackfillTicketId 尝试更新游戏会话的回填票证的 ID。

类型：std::string

必需：否

GameSession

此数据类型提供游戏会话的详细信息。

属性 描述
GameSessionId

会话的唯一标识符。游戏会话ARN采用以下格式:arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.

类型：std::string

必需：否
名称

游戏会话的描述性标签。

类型：std::string

必需：否
FleetId

运行游戏会话的集的唯一标识符。

类型：std::string

必需：否
MaximumPlayerSessionCount

机群中已连接到游戏会话的玩家数量。

类型：int

必需：否
端口

游戏会话的端口号。要连接到 Amazon GameLift 游戏服务器，应用程序需要 IP 地址和端口号。

类型：in

必需：否
IpAddress

游戏会话的 IP 地址。要连接到 Amazon GameLift 游戏服务器，应用程序需要 IP 地址和端口号。

类型：std::string

必需：否
GameSessionData

一组自定义游戏会话属性，采用单个字符串值格式。

类型：std::string

必需：否
MatchmakerData

有关用于创建游戏会话的配对过程的信息，JSON语法格式为字符串。除了使用的对战配置外，它还包含分配到对战的所有玩家的数据，包括玩家属性和队伍分配。

类型：std::string

必需：否
GameProperties

游戏会话的一组自定义属性，采用键值对格式。这些属性将通过启动新游戏会话的请求传递到游戏服务器进程。

类型：std :: vector < GameProperty >

必需：否
DnsName

分配给正在运行游戏会话的实例的DNS标识符。CRL 采用以下格式：

  • TLS-已启用的舰队：。<unique identifier>.<region identifier>.amazongamelift.com

  • 未TLS启用的舰队:. ec2-<unique identifier>.compute.amazonaws.com

连接到在TLS已启用队列上运行的游戏会话时，必须使用DNS名称，而不是 IP 地址。

类型：std::string

必需：否

ServerParameters

游戏服务器进程用于与 Amazon GameLift 服务建立连接的信息。InitSDK()仅当游戏服务器版本将部署到没有 Amazon A GameLift gent 的Anywhere队列或集装箱队列时，才在调用时包含这些参数。对于所有其他部署方案，请InitSDK()不带参数调用。

属性 描述
webSocketUrl

当您获取GameLiftServerSdkEndpoint亚马逊 GameLift Anywhere计算资源时，RegisterComputeAmazon 会 GameLift 返回。

类型：std::string

必需：是

processId

注册到托管游戏的服务器进程的唯一标识符。

类型：std::string

必需：是
hostId HostID是在您注册计算机时ComputeName使用的。有关更多信息，请参阅RegisterCompute。

类型：std::string

必需：是
fleetId 计算注册到的实例集的唯一标识符。有关更多信息，请参阅RegisterCompute。

类型：std::string

必需：是
authToken 由亚马逊生成的身份验证令牌 GameLift ，用于向亚马逊 GameLift验证您的服务器。有关更多信息，请参阅GetComputeAuthToken。

类型：std::string

必需：是

StartMatchBackfillRequest

用于创建对战回填请求的信息。游戏服务器通过StartMatchBackfill()电话将此信息传达给 Amazon GameLift 。

属性 描述
GameSessionArn

游戏会话的唯一标识符。该API操作以ARN格式GetGameSessionId返回标识符。

类型：std::string

必需：是
MatchmakingConfigurationArn

一个唯一标识符，形式为ARN，供媒人用于此请求。原始游戏会话ARN的匹配器位于匹配器数据属性的游戏会话对象中。在使用对战构建器数据中了解有关对战构建器数据的更多信息。

类型：std::string

必需：是
玩家

一组表示当前正在游戏会话中的所有玩家的数据。对战构建器使用此信息搜索与当前玩家非常匹配的新玩家。

类型：std::vector<Player>

必需：是
TicketId

对战或匹配回填请求票证的唯一标识符。如果您不提供值，Amazon GameLift 会生成一个值。使用此标识符可跟踪匹配回填票证状态或取消请求 (如需要)。

类型：std::string

必需：否

玩家

此数据类型代表对战中的玩家。发起对战请求时，玩家会有玩家 ID、属性，可能还有延迟数据。比赛结束后，Amazon 会 GameLift 添加球队信息。

属性 描述
LatencyInMS

一组以毫秒为单位的值，表示玩家在连接到某个位置时所经历的延迟量。

如果使用此属性，则仅匹配列出的位置的玩家。如果对战构建器具有评估玩家延迟的规则，玩家必须报告延迟才能进行匹配。

类型：Dictionary<string,int>

必需：否
PlayerAttributes

键/值对的集合，其中包含用于对战的玩家信息。玩家属性键必须与配对规则集中 PlayerAttributes 使用的属性密钥相匹配。

有关玩家属性的更多信息，请参阅AttributeValue。

类型：std::map<std::string,AttributeValue>

必需：否
PlayerId

玩家的唯一标识符。

类型：std::string

必需：否
团队

玩家在对战中被分配到的团队的名称。在对战规则集中定义团队名称。

类型：std::string

必需：否

DescribePlayerSessionsRequest

一个对象，用于指定要检索哪些玩家会话。服务器进程通过DescribePlayerSessions()调用 Amazon 来提供这些信息 GameLift。

属性 描述
GameSessionId

游戏会话的唯一标识符。使用此参数可请求指定游戏会话的所有玩家会话。

游戏会话 ID 的格式为arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>。GameSessionID是自定义 ID 字符串或

类型：std::string

必需：否
PlayerSessionId

玩家会话的唯一标识符。使用此参数请求单个特定的玩家会话。

类型：std::string

必需：否
PlayerId

玩家的唯一标识符。使用此参数可请求指定游戏会话的所有玩家会话。请参阅 生成玩家 ID。

类型：std::string

必需：否
PlayerSessionStatusFilter

用于筛选结果的玩家会话状态。可能的玩家会话状态包括以下内容：

  • RESERVED— 已收到玩家会话请求，但玩家尚未连接到服务器进程或未通过验证。

  • ACTIVE— 玩家已通过服务器进程验证并已连接。

  • COMPLETED— 玩家连接中断。

  • TIMEDOUT— 已收到玩家会话请求，但该玩家未连接或未在超时限制（60 秒）内通过验证。

类型：std::string

必需：否
NextToken

令牌指示结果的下一个连续页面的开头。要指定结果集的开始，请不要指定值。如果指定玩家会话 ID，将忽略此参数。

类型：std::string

必需：否
限制

要返回的最大结果数量。如果指定玩家会话 ID，将忽略此参数。

类型：int

必需：否

StopMatchBackfillRequest

用于取消对战回填请求的信息。游戏服务器通过StopMatchBackfill()呼叫将此信息传送给 Amazon GameLift 服务。

属性 描述
GameSessionArn

与被取消的请求关联的唯一游戏会话标识符。

类型：char[]

必需：否
MatchmakingConfigurationArn

此请求发送到的对战构建器的唯一标识符。

类型：char[]

必需：否
TicketId

要取消的回填请求票证的唯一标识符。

类型：char[]

必需：否

AttributeValue

在玩家属性密钥-值对中使用。此对象允许您使用任何有效的数据类型来指定属性值：字符串、数字、字符串数组或数据映射。每个AttributeValue对象必须只使用一个可用属性：S、NSL、或SDM。

属性 描述
AttrType

指定属性值的类型。可能的属性值类型包括：

  • NONE

  • STRING

  • DOUBLE

  • STRING_LIST

  • STRING_DOUBLE_MAP

必需：否
S

表示字符串属性值。

类型：std::string

必需：否
否

表示属性值。

类型：double

必需：否
sl

表示字符串属性值的数组。

类型：std::vector<std::string>

必需：否
SDM

表示字符串键和双精度值的字典。

类型：std::map<std::string, double>

必需：否

GetFleetRoleCredentialsRequest

这种数据类型使游戏服务器只能有限地访问您的其他 AWS 资源。有关更多信息，请参阅为亚马逊设置 IAM 服务角色 GameLift。

属性 描述
RoleArn 服务角色的 Amazon 资源名称 (ARN)，用于扩展对您的 AWS 资源的有限访问权限。

类型：std::string

必需：否
RoleSessionName 可用于唯一标识会话的角色会 AWS Security Token Service AssumeRole话名称。此名称会显示在审计日志中，例如中的日志 CloudTrail。

类型：std::string

必需：否

AwsLongOutcome

此数据类型由操作生成，并生成具有以下属性的对象：

属性 描述
结果

操作的结果。

类型：long

必需：否
ResultWithOwnership

操作的结果，转换为右值，以便调用代码可以拥有该对象的所有权。

类型：long&&

必需：否
成功

操作是否成功。

类型：bool

必需：是
错误

操作失败时发生的错误。

类型：GameLiftError

必需：否

AwsStringOutcome

此数据类型由操作生成，并生成具有以下属性的对象：

属性 描述
结果

操作的结果。

类型：std::string

必需：否
ResultWithOwnership

操作的结果，转换为右值，以便调用代码可以拥有该对象的所有权。

类型：long&&

必需：否
成功

操作是否成功。

类型：bool

必需：是
错误

操作失败时发生的错误。

类型：GameLiftError

必需：否

DescribePlayerSessionsOutcome

此数据类型由操作生成，并生成具有以下属性的对象：

属性 描述
结果

操作的结果。

类型：DescribePlayerSessionsResult

必需：否

ResultWithOwnership

操作的结果，转换为右值，以便调用代码可以拥有该对象的所有权。

类型：Aws::GameLift::Server::Model::DescribePlayerSessionsResult&&

必需：否
成功

操作是否成功。

类型：bool

必需：是
错误

操作失败时发生的错误。

类型：GameLiftError

必需：否

DescribePlayerSessionsResult

一组对象，其中包含与请求相匹配的每个玩家会话的属性。

属性 描述
NextToken

令牌指示结果的下一个连续页面的开头。使用之前的调用返回此操作的令牌。要指定结果集的开始，请不要指定值。如果指定玩家会话 ID，将忽略此参数。

类型：std::string

必需：是
PlayerSessions

类型：IList<PlayerSession>

必填

ResultWithOwnership

操作的结果，转换为右值，以便调用代码可以拥有该对象的所有权。

类型：std::string&&

必需：否
成功

操作是否成功。

类型：bool

必需：是
错误

操作失败时发生的错误。

类型：GameLiftError

必需：否

GenericOutcome

此数据类型由操作生成，并生成具有以下属性的对象：

属性 描述
成功

操作是否成功。

类型：bool

必需：是
错误

操作失败时发生的错误。

类型：GameLiftError

必需：否

GenericOutcomeCallable

这种数据类型是一种异步的通用结果。它具有以下属性：

属性 描述
成功

操作是否成功。

类型：bool

必需：是
错误

操作失败时发生的错误。

类型：GameLiftError

必需：否

PlayerSession

此数据类型表示 Amazon GameLift 传递给游戏服务器的玩家会话。有关更多信息，请参阅PlayerSession。

属性 描述
CreationTime

类型：long

必需：否
FleetId

类型：std::string

必需：否
GameSessionId

类型：std::string

必需：否
IpAddress

类型：std::string

必需：否
PlayerData

类型：std::string

必需：否
PlayerId

类型：std::string

必需：否
PlayerSessionId

类型：std::string

必需：否
端口

类型：int

必需：否
Status

用于筛选结果的玩家会话状态。如果提供 PlayerId 了 o PlayerSessionId r，则 PlayerSessionStatusFilter 对响应没有影响。

类型：PlayerSessionStatus枚举。可能的值包括：

  • ACTIVE

  • COMPLETED

  • NOT_SET

  • RESERVED

  • TIMEDOUT

必需：否
TerminationTime

类型：long

必需：否
DnsName

类型：std::string

必需：否

StartMatchBackfillOutcome

此数据类型由操作生成，并生成具有以下属性的对象：

属性 描述
结果

操作的结果。

类型：StartMatchBackfillResult

必需：否
ResultWithOwnership

操作的结果，转换为右值，以便调用代码可以拥有该对象的所有权。

类型：StartMatchBackfillResult&&

必需：否
成功

操作是否成功。

类型：bool

必需：是
错误

操作失败时发生的错误。

类型：GameLiftError

必需：否

StartMatchBackfillResult

此数据类型由操作生成，并生成具有以下属性的对象：

属性 描述
TicketId

对战配置的唯一标识符。如果此处未指定票证编号，Amazon GameLift 将以 a 的形式生成一个UUID。使用此标识符跟踪对战回填单状态并检索匹配结果。

类型：std::string

必需：否

GetComputeCertificateOutcome

此数据类型由操作生成，并生成具有以下属性的对象：

属性 描述
结果

操作的结果。

类型：GetComputeCertificateResult

必需：否

ResultWithOwnership

操作的结果，转换为右值，以便调用代码可以拥有该对象的所有权。

类型：Aws::GameLift::Server::Model::GetComputeCertificateResult&&

必需：否
成功

操作是否成功。

类型：bool

必需：是
错误

操作失败时发生的错误。

类型：GameLiftError

必需：否

GetComputeCertificateResult

计算机上TLS证书的路径和计算机的主机名。

属性 描述
CertificatePath

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

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

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

  • 根证书。

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

类型：std::string

必需：否
ComputeName

您的计算资源的名称。

类型：std::string

必需：否

GetFleetRoleCredentialsOutcome

此数据类型由操作生成，并生成具有以下属性的对象：

属性 描述
结果

操作的结果。

类型：GetFleetRoleCredentialsResult

必需：否

ResultWithOwnership

操作的结果，转换为右值，以便调用代码可以拥有该对象的所有权。

类型：Aws::GameLift::Server::Model::GetFleetRoleCredentialsResult

必需：否
成功

操作是否成功。

类型：bool

必需：是
错误

操作失败时发生的错误。

类型：GameLiftError

必需：否

GetFleetRoleCredentialsResult

属性 描述
AccessKeyId

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

类型：string

必需：否
AssumedRoleId

服务角色所属的用户 ID。

类型：string

必需：否
AssumedRoleUserArn

服务角色所属用户的 Amazon 资源名称 (ARN)。

类型：string

必需：否
过期

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

类型：DateTime

必需：否
SecretAccessKey

指定 S3 验证的访问密钥 ID。

类型：string

必需：否
SessionToken

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

类型：string

必需：否
成功

操作是否成功。

类型：bool

必需：是
错误

操作失败时发生的错误。

类型：GameLiftError

必需：否

我 nitSDKOutcome

注意

InitSDKOutcome仅当你使用std标志构建时才SDK会返回。如果您使用nostd标志进行构建，则会改GenericOutcome为返回。

属性 描述
成功

操作是否成功。

类型：bool

必需：是
错误

操作失败时发生的错误。

类型：GameLiftError

必需：否

GameLiftError

属性 描述
ErrorType

错误的类型。

类型：GameLiftErrorType枚举。

必需：否

ErrorName

错误类型的名称。

类型：std::string

必需：否

ErrorMessage

错误消息。

类型：std::string

必需：否

枚举

为亚马逊 GameLift 服务器 SDK (C++) 定义的枚举定义如下：

GameLiftErrorType

表示错误类型的字符串值。有效值包括：

  • BAD_REQUEST_EXCEPTION

  • GAMESESSION_ID_ NOT _ SET — 游戏会话 ID 尚未设置。

  • INTERNAL_SERVICE_EXCEPTION

  • LOCAL_ CONNECTION _ FAILED — 与 Amazon 的本地连接 GameLift 失败。

  • NETWORK_ NOT _ INITIALIZED — 网络尚未初始化。

  • SERVICE_ CALL _ FAILED — 对 AWS 服务的呼叫失败。

  • WEBSOCKET_CONNECT_FAILURE

  • WEBSOCKET_CONNECT_FAILURE_FORBIDDEN

  • WEBSOCKET_CONNECT_FAILURE_INVALID_URL

  • WEBSOCKET_CONNECT_FAILURE_TIMEOUT

  • ALREADY_ INITIALIZED — Amazon GameLift 服务器或客户端已使用初始化 () 进行初始化。

  • FLEET_ MISMATCH — 目标舰队与 gameSession 或的舰队不匹配playerSession。

  • GAMELIFT_ CLIENT NOT _ INITIALIZED — Amazon GameLift 客户端尚未初始化。

  • GAMELIFT_ SERVER NOT _ INITIALIZED — Amazon GameLift 服务器尚未初始化。

  • GAME_ SESSION ENDED _ FAILED — Amazon GameLift 服务器SDK无法联系服务以报告游戏会话已结束。

  • GAME_ SESSION NOT _ READY — Amazon GameLift 服务器游戏会话未激活。

  • GAME_ SESSION READY _ FAILED — Amazon GameLift 服务器SDK无法联系服务以报告游戏会话已准备就绪。

  • INITIALIZATION_ MISMATCH — 在 Server:: Initialize () 之后调用了客户端方法，反之亦然。

  • NOT_ INITIALIZED — 尚未使用初始化 () 初始化 Amazon GameLift 服务器或客户端。

  • NO TARGET _ ALIASID _ _ SET — aliasId 尚未设定目标。

  • NO TARGET _ FLEET _ _ SET — 尚未设置目标舰队。

  • PROCESS_ ENDING _ FAILED — Amazon GameLift 服务器SDK无法联系服务以报告该过程即将结束。

  • PROCESS_ NOT _ ACTIVE — 服务器进程尚未处于活动状态，未绑定到 GameSession，并且无法接受或处理 PlayerSessions。

  • PROCESS_ NOT _ READY — 服务器进程尚未准备好激活。

  • PROCESS_ READY _ FAILED — Amazon GameLift 服务器SDK无法联系服务以报告流程已准备就绪。

  • SDK_ VERSION DETECTION _ FAILED — SDK 版本检测失败。

  • STX_ CALL _ FAILED — 对XStx服务器后端组件的调用失败。

  • STX_ INITIALIZATION _ FAILED — XStx 服务器后端组件初始化失败。

  • UNEXPECTED_ PLAYER _ SESSION — 服务器遇到未注册的玩家会话。

  • WEBSOCKET_CONNECT_FAILURE

  • WEBSOCKET_CONNECT_FAILURE_FORBIDDEN

  • WEBSOCKET_CONNECT_FAILURE_INVALID_URL

  • WEBSOCKET_CONNECT_FAILURE_TIMEOUT

  • WEBSOCKET_ RETRIABLE _ SEND MESSAGE _ FAILURE — 向 GameLift 服务 WebSocket发送消息失败可重试。

  • WEBSOCKETSEND_ MESSAGE _ FAILURE — 未能向 GameLift 服务发送消息 WebSocket。

  • MATCH_ BACKFILL REQUEST _ VALIDATION-请求验证失败。

  • PLAYER_ SESSION REQUEST _ VALIDATION-请求验证失败。

PlayerSessionCreationPolicy

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

  • ACCEPT_ ALL — 接受所有新玩家会话。

  • DENY_ ALL — 拒绝所有新玩家会话。

  • NOT_ SET — 游戏会话未设置为接受或拒绝新玩家会话。