C++ サーバー SDK 5.x for Amazon GameLift Servers -- データ型 - Amazon GameLift Servers
LogParametersMetricsParametersProcessParametersUpdateGameSessionGameSessionServerParametersStartMatchBackfillRequestプレイヤーDescribePlayerSessionsRequestStopMatchBackfillRequestAttributeValueGetFleetRoleCredentialsRequestAwsLongOutcomeAwsStringOutcomeDescribePlayerSessionsOutcomeDescribePlayerSessionsResultGenericOutcomeGenericOutcomeCallablePlayerSessionStartMatchBackfillOutcomeStartMatchBackfillResultGetComputeCertificateOutcomeGetComputeCertificateResultGetFleetRoleCredentialsOutcomeGetFleetRoleCredentialsResultInitSDKOutcomeGameLiftError列挙型

C++ サーバー SDK 5.x for Amazon GameLift Servers -- データ型

Amazon GameLift Servers C++ サーバー SDK 5.x リファレンスを使用して、Amazon GameLift Servers でホスティングするマルチプレイヤーゲームを統合します。統合プロセスのガイダンスについては、「サーバー SDK を使用して、Amazon GameLift Servers をゲームサーバーに追加します。」を参照してください。

注記

このトピックでは、C++ 標準ライブラリ (std) を使用して構築するときに利用できる Amazon GameLift Servers C++ API について説明します。特に、このドキュメントは -DDGAMELIFT_USE_STD=1 オプションを使用してコンパイルするコードが対象です。

C++ サーバー SDK 5.x for Amazon GameLift Servers -- アクション

LogParameters

ゲームセッション中に生成されたファイルを識別するオブジェクトで、ゲームセッション終了時に Amazon GameLift Servers でアップロードして保存します。ゲームサーバーは、ProcessReady() 呼び出しで ProcessParameters オブジェクトの一部として LogParameters を Amazon GameLift Servers に提供します。

プロパティ

 説明
LogPaths

Amazon GameLift Servers で将来のアクセスに備えて保存するゲームサーバーログファイルへのディレクトリパスのリスト。サーバープロセスは各ゲームセッション中にこれらのファイルを生成します。ファイルのパスと名前はゲームサーバーで定義し､ルートゲームビルドディレクトリに保存します。

ログパスは絶対パスである必要があります。例えば、ゲームビルドによって MyGame\sessionLogs\ などのパスに保存されるゲームセッションログの場合、パスは c:\game\MyGame\sessionLogs (Windows インスタンスの場合) となります。

型: std:vector<std::string>

必須: いいえ

MetricsParameters

このデータ型を使用して、ゲームサーバーのメトリクス収集とクラッシュレポートを設定します。ゲームサーバーは、InitMetrics() 呼び出しで MetricsParameters を Amazon GameLift Servers に送信します。

プロパティ

 説明
StatsdHost

メトリクス収集用の StatsD サーバーのホスト名または IP アドレス。

型: std::string

必須: いいえ
StatsdPort

メトリクス収集用の StatsD サーバーのポート番号です。

型: int

必須: いいえ
CrashReporterHost

クラッシュレポーターサーバーのホスト名または IP アドレスです。

型: std::string

必須: いいえ
CrashReporterPort

クラッシュレポーターサーバーのポート番号です。

型: int

必須: いいえ
FlushIntervalMs

メトリクスデータをサーバーにフラッシュする際のミリ秒単位の間隔です。

型: int

必須: いいえ
MaxPacketSize

サーバーに送信されるメトリクスパケットの最大サイズ (バイト) です。

型: int

必須: いいえ

ProcessParameters

このデータ型には、ProcessReady() の中で Amazon GameLift Servers に送信されるパラメータのセットが含まれます。

プロパティ

 説明
LogParameters ゲームセッション中に生成されるファイルへのディレクトリパスを持つオブジェクトです。Amazon GameLift Servers はこれらのファイルをコピーして保存し、後で参照できるようにします。

型: Aws::GameLift::Server::LogParameters

必須: いいえ
OnHealthCheck Amazon GameLift Servers がサーバープロセスにヘルスステータスレポートを要求するために呼び出すコールバック関数です。Amazon GameLift Servers はこの関数を 60 秒ごとに呼び出し、応答を最大 60 秒間待機します。サーバープロセスは正常であれば TRUE を返し、正常でない場合は FALSE を返します。応答が返されない場合、Amazon GameLift Servers はサーバープロセスを正常ではないと記録します。

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

必須: いいえ
OnProcessTerminate Amazon GameLift Servers がサーバープロセスを強制的にシャットダウンするために呼び出すコールバック関数です。この関数を呼び出すと、Amazon GameLift Servers はサーバープロセスがシャットダウンするまで最大 5 分間待機し、サーバープロセスがシャットダウンする前に ProcessEnding() 呼び出しで応答するのを待ちます。

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

必須: はい
OnStartGameSession Amazon GameLift Servers が新しいゲームセッションをアクティブ化するために呼び出すコールバック関数。Amazon GameLift Servers は、クライアントリクエスト CreateGameSession に応じてこの関数を呼び出します。コールバック関数は GameSession オブジェクトを渡します。

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

必須: はい
OnUpdateGameSession 更新されたゲームセッションオブジェクトをサーバープロセスに渡すために、Amazon GameLift Servers が呼び出すコールバック関数。Amazon GameLift Servers は、更新されたマッチメーカーデータを提供するために、マッチバックフィルリクエストが処理された際にこの関数を呼び出します。これは、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 Servers ゲームサーバーに接続するには、アプリに IP アドレスとポート番号の両方が必要です。

型: in

必須: いいえ
IpAddress

ゲームセッションの IP アドレス。Amazon GameLift Servers ゲームサーバーに接続するには、アプリに IP アドレスとポート番号の両方が必要です。

型: std::string

必須: いいえ
GameSessionData

単一の文字列値としてフォーマットされたカスタムゲームセッションプロパティのセット。

型: std::string

必須: いいえ
MatchmakerData

ゲームセッションの作成に使用されたマッチメーキングプロセスに関する情報。JSON 構文で、文字列としてフォーマットされています。使用されたマッチメーキング設定に加えて、プレイヤー属性やチーム割り当てなど、マッチに割り当てられた全プレイヤーに関するデータが含まれます。

型: std::string

必須: いいえ
GameProperties

ゲームセッションのカスタムプロパティのセットで、キーと値のペアとしてフォーマットされます。これらのプロパティは、新しいゲームセッションを開始するリクエストとともに渡されます。

型: std :: vector < GameProperty >

必須: いいえ
DnsName

ゲームセッションを実行しているインスタンスに割り当てられた DNS 識別子。値の形式は次のとおりです。

  • TLS 対応フリート: <unique identifier>.<region identifier>.amazongamelift.com。

  • TLS 対応でないフリート: ec2-<unique identifier>.compute.amazonaws.com。

TLS 対応フリートで実行しているゲームセッションに接続する場合、IP アドレスではなく DNS 名を使用する必要があります。

型: std::string

必須: いいえ

ServerParameters

ゲームサーバープロセスが、Amazon GameLift Servers サービスへの接続を確立するために使用する情報。ゲームサーバービルドが、Amazon GameLift Servers エージェントを使用しない Anywhere フリートまたはコンテナフリートにデプロイされる場合にのみ、InitSDK() を呼び出す際にこれらのパラメータを含めます。他のすべてのデプロイシナリオでは、パラメータなしで InitSDK() が呼び出されます。

プロパティ 説明
webSocketUrl

Amazon GameLift Servers Anywhere コンピューティングリソース用に RegisterCompute を実行すると、GameLiftServerSdkEndpoint Amazon GameLift Servers が返されます。

型: std::string

必須: はい

processId

ゲームをホストするサーバープロセスに登録された固有の識別子。

型: std::string

必須: はい
hostId HostID はコンピューティングを登録したときに使用される ComputeName です。詳細については、「RegisterCompute」を参照してください。

型: std::string

必須: はい
fleetId コンピューティングが登録されているフリートの固有識別子。詳細については、「RegisterCompute」を参照してください。

型: std::string

必須: はい
authToken Amazon GameLift Servers によって生成され、サーバーを Amazon GameLift Servers に対して認証するための認証トークン。詳細については、「GetComputeAuthToken」を参照してください。

型: std::string

必須: はい

StartMatchBackfillRequest

マッチメーキングバックフィルリクエストの作成に使用される情報。ゲームサーバーは、この情報を StartMatchBackfill() 呼び出しで Amazon GameLift Servers に送信します。

プロパティ 説明
GameSessionArn

一意のゲームセッション識別子。API オペレーション GetGameSessionId は ARN 形式の識別子を返します。

型: std::string

必須: はい
MatchmakingConfigurationArn

このリクエストに使用されるマッチメーカーの ARN 形式の一意な識別子。元のゲームセッションののマッチメーカー ARN は、マッチメーカーデータプロパティのゲームセッションオブジェクトにあります。マッチメーカーデータの詳細については「マッチメーカーデータの処理」を参照してください。

型: std::string

必須: はい
プレイヤー

ゲームセッションに参加しているすべてのプレイヤーを表すデータのセット。マッチメーカーはこの情報を使用して、現在のプレイヤーとマッチする新しいプレイヤーを検索します。

型: std::vector<Player>

必須: はい
TicketId

マッチメーキングまたはバックフィルリクエストチケットの一意の識別子。値を指定しない場合、Amazon GameLift Servers が値を生成します。この識別子を使用してマッチバックフィルチケットのステータスを追跡したり、必要に応じてリクエストをキャンセルしたりします。

型: std::string

必須: いいえ

プレイヤー

このデータ型はマッチメーキングのプレイヤーを表します。マッチメーキングリクエストを開始すると、プレイヤーにはプレイヤー ID、属性、必要に応じてレイテンシーデータが含まれます。マッチが成立すると、Amazon GameLift Servers がチーム情報を追加します。

プロパティ 説明
LatencyInMS

プレイヤーがロケーションに接続したときに発生するレイテンシーの量を示すミリ秒単位の値のセット。

このプロパティを使用すると、プレーヤーはリストに表示されている場所でのみマッチングされます。マッチメーカーにプレイヤーレイテンシーを評価するルールがある場合、プレイヤーはレイテンシーを報告しないとマッチングされません。

型: Dictionary<string,int>

必須: いいえ
PlayerAttributes

マッチメーキングに使用するプレイヤー情報を含むキーと値のペアの集合。プレイヤー属性キーは、マッチメーキングルールセットで使用されている PlayerAttributes と一致する必要があります。

プレイヤー属性の詳細については、「AttributeValue」を参照してください。

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

必須: いいえ
PlayerId

プレイヤーを表す一意の識別子。

型: std::string

必須: いいえ
チーム

マッチでプレーヤーが割り当てられるチームの名前。チーム名はマッチメーキングルールセットで定義します。

型: std::string

必須: いいえ

DescribePlayerSessionsRequest

取得するプレイヤーセッションを指定するオブジェクト。サーバープロセスは、この情報を DescribePlayerSessions() 呼び出しで Amazon GameLift Servers に提供します。

プロパティ 説明
GameSessionId

一意のゲームセッション識別子。このパラメータを使用して、指定したゲームセッションのすべてのプレイヤーセッションをリクエストします。

ゲームセッション ID の形式は arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string> です。GameSessionID はカスタム ID 文字列または

型: std::string

必須: いいえ
PlayerSessionId

プレイヤーセッションを表す一意の識別子。このパラメータを使用して、特定の 1 つのプレイヤーセッションをリクエストします。

型: std::string

必須: いいえ
PlayerId

プレイヤーの一意識別子。このパラメータを使用して、特定の 1 人のプレイヤーに対するすべてのプレイヤーセッションをリクエストします。「プレイヤー ID を生成する」を参照してください。

型: std::string

必須: いいえ
PlayerSessionStatusFilter

結果をフィルタリングするプレイヤーセッションステータス。可能なプレイヤーセッションステータスには以下が含まれます。

  • RESERVED - プレイヤーセッションリクエストは受領されましたが、プレイヤーはサーバープロセスに接続していないか、または検証はまだ行われていません。

  • ACTIVE - プレイヤーはサーバープロセスによって検証され、接続されています。

  • COMPLETED - プレイヤー接続は削除されました。

  • TIMEDOUT - プレイヤーセッションリクエストは受領されましたが、タイムアウト制限 (60 秒) 内でのプレイヤーの接続や検証は行われていません。

型: std::string

必須: いいえ
NextToken

結果の次のページの先頭を示すトークン。結果セットの先頭を指定するには、値を指定しないでください。プレイヤーセッション ID を提供する場合、このパラメータは無視されます。

型: std::string

必須: いいえ
制限

返される結果の最大数。プレイヤーセッション ID を提供する場合、このパラメータは無視されます。

型: int

必須: いいえ

StopMatchBackfillRequest

マッチメーキングバックフィルリクエストのキャンセルに使用される情報。ゲームサーバーは、この情報を StopMatchBackfill() 呼び出しで Amazon GameLift Servers サービスに送信します。

プロパティ 説明
GameSessionArn

キャンセルされるリクエストの一意のゲームセッション識別子。

型: char[]

必須: いいえ
MatchmakingConfigurationArn

このリクエストが送信されたマッチメーカーの一意の識別子。

型: char[]

必須: いいえ
TicketId

キャンセルされるバックフィルリクエストチケットの一意の識別子。

型: char[]

必須: いいえ

AttributeValue

これらの値を プレイヤー 属性のキーと値のペアで使用します。このオブジェクトでは、文字列、数値、文字列配列、データマップのいずれかの有効なデータ型を使用して属性値を指定できます。各 AttributeValue オブジェクトは S、N、SL、または SDM の使用可能なプロパティのうちの 1 つだけを使用する必要があります。

プロパティ 説明
AttrType

属性値のタイプを指定します。可能な属性値のタイプは次のとおりです。

  • なし

  • STRING

  • DOUBLE

  • STRING_LIST

  • STRING_DOUBLE_MAP

必須: いいえ
S

文字列の属性値を表します。

型: std::string

必須: いいえ
N

数値の属性値を表します。

型: double

必須: いいえ
SL

文字列の属性値の配列を表します。

型: std::vector<std::string>

必須: いいえ
SDM

文字列キーと二重値のディクショナリを表します。

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

必須: いいえ

GetFleetRoleCredentialsRequest

このデータ型により、ゲームサーバーは他の AWS リソースへのアクセスが制限されます。詳細については、「Amazon GameLift Servers 用に IAM サービスロールをセットアップする」を参照してください。

プロパティ 説明
RoleArn AWS リソースへの制限付きアクセスを拡張するサービスロールの Amazon リソースネーム (ARN)。

型: std::string

必須: いいえ
RoleSessionName AWS Security Token Service AssumeRole セッションを一意に識別するために使用できるロールセッション名。この名前は、CloudTrail などの監査ログに公開されます。

型: std::string

必須: いいえ

AwsLongOutcome

このデータ型はアクションの結果で、以下のプロパティを持つオブジェクトを生成します。

プロパティ 説明
結果

アクションの結果。

型: long

必須: いいえ
ResultWithOwnership

アクションの結果を rvalue としてキャストし、呼び出し元のコードがオブジェクトの所有権を取得できるようにします。

型: long&&

必須: いいえ
成功

アクションが成功したかどうか。

型: bool

必須: はい
エラー

アクションが失敗した場合に発生したエラー。

型: GameLiftError

必須: いいえ

AwsStringOutcome

このデータ型はアクションの結果で、以下のプロパティを持つオブジェクトを生成します。

プロパティ 説明
結果

アクションの結果。

型: std::string

必須: いいえ
ResultWithOwnership

アクションの結果を rvalue としてキャストし、呼び出し元のコードがオブジェクトの所有権を取得できるようにします。

型: long&&

必須: いいえ
成功

アクションが成功したかどうか。

型: bool

必須: はい
エラー

アクションが失敗した場合に発生したエラー。

型: GameLiftError

必須: いいえ

DescribePlayerSessionsOutcome

このデータ型はアクションの結果で、以下のプロパティを持つオブジェクトを生成します。

プロパティ 説明
結果

アクションの結果。

型: DescribePlayerSessionsResult

必須: いいえ

ResultWithOwnership

アクションの結果を rvalue としてキャストし、呼び出し元のコードがオブジェクトの所有権を取得できるようにします。

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

必須: いいえ
成功

アクションが成功したかどうか。

型: bool

必須: はい
エラー

アクションが失敗した場合に発生したエラー。

型: GameLiftError

必須: いいえ

DescribePlayerSessionsResult

リクエストに一致する各プレイヤーセッションのプロパティを含むオブジェクトの集合。

プロパティ 説明
NextToken

結果の次の順次ページの先頭を示すトークン。このオペレーションの以前の呼び出しで返されたトークンを使用します。結果セットの先頭で開始するには、値を指定しないでください。プレイヤーセッション ID を指定した場合、このパラメータは無視されます。

型: std::string

必須: はい
PlayerSessions

型: IList<PlayerSession>

必須:

ResultWithOwnership

アクションの結果を rvalue としてキャストし、呼び出し元のコードがオブジェクトの所有権を取得できるようにします。

型: std::string&&

必須: いいえ
成功

アクションが成功したかどうか。

型: bool

必須: はい
エラー

アクションが失敗した場合に発生したエラー。

型: GameLiftError

必須: いいえ

GenericOutcome

このデータ型はアクションの結果で、以下のプロパティを持つオブジェクトを生成します。

プロパティ 説明
成功

アクションが成功したかどうか。

型: bool

必須: はい
エラー

アクションが失敗した場合に発生したエラー。

型: GameLiftError

必須: いいえ

GenericOutcomeCallable

このデータ型は非同期の一般的な結果です。以下のプロパティがあります。

プロパティ 説明
成功

アクションが成功したかどうか。

型: bool

必須: はい
エラー

アクションが失敗した場合に発生したエラー。

型: GameLiftError

必須: いいえ

PlayerSession

このデータ型は、Amazon GameLift Servers がゲームサーバーに渡すプレイヤーセッションを表します。詳細については、「PlayerSession」を参照してください。

プロパティ 説明
CreationTime

型: long

必須: いいえ
FleetId

型: std::string

必須: いいえ
GameSessionId

型: std::string

必須: いいえ
IpAddress

型: std::string

必須: いいえ
PlayerData

型: std::string

必須: いいえ
PlayerId

型: std::string

必須: いいえ
PlayerSessionId

型: std::string

必須: いいえ
ポート

型: int

必須: いいえ
Status

結果をフィルタリングするプレイヤーセッションステータス。PlayerSessionId または PlayerId が提供された場合、PlayerSessionStatusFilter はレスポンスに影響を与えません。

型: PlayerSessionStatus enum。以下に示しているのは、可能な値です。

  • アクティブ

  • COMPLETED

  • NOT_SET

  • RESERVED

  • TIMEDOUT

必須: いいえ
TerminationTime

型: long

必須: いいえ
DnsName

型: std::string

必須: いいえ

StartMatchBackfillOutcome

このデータ型はアクションの結果で、以下のプロパティを持つオブジェクトを生成します。

プロパティ 説明
結果

アクションの結果。

型: StartMatchBackfillResult

必須: いいえ
ResultWithOwnership

アクションの結果を rvalue としてキャストし、呼び出し元のコードがオブジェクトの所有権を取得できるようにします。

型: StartMatchBackfillResult&&

必須: いいえ
成功

アクションが成功したかどうか。

型: bool

必須: はい
エラー

アクションが失敗した場合に発生したエラー。

型: GameLiftError

必須: いいえ

StartMatchBackfillResult

このデータ型はアクションの結果で、以下のプロパティを持つオブジェクトを生成します。

プロパティ 説明
TicketId

マッチメーキングチケットの一意の識別子。ここでチケット ID を指定しない場合、Amazon GameLift Servers が UUID 形式の ID を自動生成します。この識別子を使用して、マッチバックフィルチケットのステータスを追跡し、マッチ結果を取得します。

型: std::string

必須: いいえ

GetComputeCertificateOutcome

このデータ型はアクションの結果で、以下のプロパティを持つオブジェクトを生成します。

プロパティ 説明
結果

アクションの結果。

型: GetComputeCertificateResult

必須: いいえ

ResultWithOwnership

アクションの結果を rvalue としてキャストし、呼び出し元のコードがオブジェクトの所有権を取得できるようにします。

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

必須: いいえ
成功

アクションが成功したかどうか。

型: bool

必須: はい
エラー

アクションが失敗した場合に発生したエラー。

型: GameLiftError

必須: いいえ

GetComputeCertificateResult

コンピューティングの TLS 証明書へのパスとコンピューティングのホスト名。

プロパティ 説明
CertificatePath

コンピューティングリソースの TLS 証明書へのパス。Amazon GameLift Serversマネージドフリートを使用する場合、このパスには次の内容が含まれます。

  • certificate.pem: エンドユーザー証明書。証明書チェーン全体は、この証明書に追加された certificateChain.pem を組み合わせたものです。

  • certificateChain.pem: ルート証明書と中間証明書を含む証明書チェーン。

  • rootCertificate.pem: ルート証明書。

  • privateKey.pem: エンドユーザー証明書のプライベートキー。

型: std::string

必須: いいえ
ComputeName

コンピューティングリソースの名前。

型: std::string

必須: いいえ

GetFleetRoleCredentialsOutcome

このデータ型はアクションの結果で、以下のプロパティを持つオブジェクトを生成します。

プロパティ 説明
結果

アクションの結果。

型: GetFleetRoleCredentialsResult

必須: いいえ

ResultWithOwnership

アクションの結果を rvalue としてキャストし、呼び出し元のコードがオブジェクトの所有権を取得できるようにします。

型: Aws::GameLift::Server::Model::GetFleetRoleCredentialsResult

必須: いいえ
成功

アクションが成功したかどうか。

型: bool

必須: はい
エラー

アクションが失敗した場合に発生したエラー。

型: GameLiftError

必須: いいえ

GetFleetRoleCredentialsResult

プロパティ 説明
AccessKeyId

AWS へのアクセスを認証して提供するためのアクセスキー ID。

型: string

必須: いいえ
AssumedRoleId

サービスロールが属するユーザーの ID。

型: string

必須: いいえ
AssumedRoleUserArn

サービスロールが属するユーザーの Amazon リソースネーム (ARN)。

型: string

必須: いいえ
有効期限

セッション認証情報の有効期限が切れるまでの時間。

型: DateTime

必須: いいえ
SecretAccessKey

認証のためのシークレットアクセスキー ID。

型: string

必須: いいえ
SessionToken

AWS リソースとやり取りしている現在のアクティブなセッションを識別するトークン。

型: string

必須: いいえ
成功

アクションが成功したかどうか。

型: bool

必須: はい
エラー

アクションが失敗した場合に発生したエラー。

型: GameLiftError

必須: いいえ

InitSDKOutcome

注記

InitSDKOutcome は std フラグを付けて SDK を構築した場合にのみ返されます。nostd フラグを付けて構築すると、代わりに GenericOutcome が返されます。

プロパティ 説明
成功

アクションが成功したかどうか。

型: bool

必須: はい
エラー

アクションが失敗した場合に発生したエラー。

型: GameLiftError

必須: いいえ

GameLiftError

プロパティ 説明
ErrorType

エラーのタイプ。

型: GameLiftErrorType enum。

必須: いいえ

ErrorName

エラータイプの名前。

型: std::string

必須: いいえ

ErrorMessage

エラーメッセージです。

型: std::string

必須: いいえ

列挙型

サーバー SDK for Amazon GameLift Servers (C++) で定義されている列挙体は、次のとおりです。

GameLiftErrorType

エラータイプを示す文字列値。有効な値を次に示します。

  • BAD_REQUEST_EXCEPTION

  • GAMESESSION_ID_NOT_SET - ゲームセッション ID が設定されていません。

  • INTERNAL_SERVICE_EXCEPTION

  • LOCAL_CONNECTION_FAILED - Amazon GameLift Serversへのローカル接続に失敗しました。

  • 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 Servers サーバーまたはクライアントはすでに Initialize() で初期化されています。

  • FLEET_MISMATCH - ターゲットフリートが gameSession または playerSession のフリートと一致しません。

  • GAMELIFT_CLIENT_NOT_INITIALIZED - Amazon GameLift Servers クライアントは初期化されていません。

  • GAMELIFT_SERVER_NOT_INITIALIZED - Amazon GameLift Servers クライアントは初期化されていません。

  • GAME_SESSION_ENDED_FAILED - サーバー SDK for Amazon GameLift Servers はサービスにアクセスしてゲームセッションが終了したことを報告できませんでした。

  • GAME_SESSION_NOT_READY - Amazon GameLift Servers サーバーのゲームセッションがアクティブ化されませんでした。

  • GAME_SESSION_READY_FAILED - サーバー SDK for Amazon GameLift Servers は、サービスにアクセスしてゲームセッションの準備が完了したことを報告できませんでした。

  • INITIALIZATION_MISMATCH - Server:: Initialize() の後にクライアントメソッドが呼び出されました。その逆も同様です。

  • NOT_INITIALIZED - Amazon GameLift Servers サーバーまたはクライアントは Initialize() で初期化されていません。

  • NO_TARGET_ALIASID_SET - ターゲットの aliasId が設定されていません。

  • NO_TARGET_FLEET_SET - ターゲットフリートが設定されていません。

  • PROCESS_ENDING_FAILED - サーバー SDK for Amazon GameLift Servers はサービスにアクセスしてプロセスの終了を報告できませんでした。

  • PROCESS_NOT_ACTIVE - サーバープロセスはまだアクティブではなく、GameSession にバインドされていないため、PlayerSessions を受け入れたり処理したりすることはできません。

  • PROCESS_NOT_READY - サーバープロセスをまだアクティブ化する準備ができていません。

  • PROCESS_READY_FAILED - サーバー SDK for Amazon GameLift Servers はサービスにアクセスしてプロセスの準備が完了したことを報告できませんでした。

  • 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 Service WebSocket にメッセージを送信する際に再試行可能な障害が発生しました。

  • WEBSOCKET_SEND_MESSAGE_FAILURE - GameLift Service WebSocket へのメッセージの送信に失敗しました。

  • MATCH_BACKFILL_REQUEST_VALIDATION - リクエストの検証に失敗しました。

  • PLAYER_SESSION_REQUEST_VALIDATION - リクエストの検証に失敗しました。

PlayerSessionCreationPolicy

ゲームセッションで新しいプレイヤーを承諾するかどうかを示す文字列値。有効な値を次に示します。

  • ACCEPT_ALL - すべての新しいプレイヤーセッションを承諾します。

  • DENY_ALL - すべての新しいプレイヤーセッションを拒否します。

  • NOT_SET - ゲームセッションは、新規プレイヤーセッションを受け入れたり拒否したりするように設定されていません。