PiaSession の API の中でゲームサーバーとの通信が発生する API (サーバー API)について説明します。
サーバー API については、ガイドライン「ゲームサーバーへのアクセス制限」で呼び出し頻度などが制限されています。ガイドラインで制限されている API の呼び出し履歴を記録する方法については、「NEX プログラミングマニュアル」 - 「サーバーサービス」 - 「9. デバッグ補助」 の説明を参照してください。
アプリケーションが呼び出す Pia の API と、その API 内部で呼び出される可能性があるサーバー API の対応表を以下に示します。記録されるサーバー API 名は、 NEX のデバッグ用機能 nn::nex::DebugClient::GetApiCallSummary で記録される際の API 名を表記しています。
Pia ライブラリ API | NEX ライブラリ側 API 名 | 記録されるサーバー API 名 |
---|---|---|
Session::JoinRandomSessionAsync | MatchmakeExtensionClient::AutoMatchmake | MatchmakeExtensionProtocol::AutoMatchmakeWithParam_Postpone |
MatchMakingClient::GetSessionURLs | MatchMakingProtocol::GetSessionURLs | |
Session::BrowseSessionAsync | MatchmakeExtensionClient::BrowseMatchmakeSession | MatchmakeExtensionProtocol::BrowseMatchmakeSession |
MatchmakeExtensionClient::FindMatchmakeSessionByOwner | ※NEX マニュアルの対応表に記載無し | |
MatchmakeExtensionClient::FindMatchmakeSessionByParticipant | ※NEX マニュアルの対応表に記載無し | |
Session::CreateSessionAsync | ||
MatchmakeExtensionClient::CreateMatchmakeSession | MatchmakeExtensionProtocol::CreateMatchmakeSessionWithParam | |
Session::JoinSessionAsync | ||
MatchmakeExtensionClient::JoinMatchmakeSession | MatchmakeExtensionProtocol::JoinMatchmakeSessionWithParam | |
MatchMakingClient::GetSessionURLs | MatchMakingProtocol::GetSessionURLs | |
Session::LeaveSessionAsync | MatchMakingClient::EndParticipation | MatchMakingProtocolExt::EndParticipation |
MatchMakingClient::UnregisterGathering | MatchMakingClient::UnregisterGathering | |
Session::OpenSessionAsync | MatchmakeExtensionClient::OpenParticipation | MatchmakeExtensionProtocol::OpenParticipation |
Session::CloseSessionAsync | MatchmakeExtensionClient::CloseParticipation | MatchmakeExtensionProtocol::CloseParticipation |
Session::UpdateSessionSettingAsync | MatchmakeExtensionClient::ModifyMatchmakeSessionAttribute | MatchmakeExtensionProtocol::ModifyMatchmakeSessionAttribute |
MatchmakeExtensionClient::ModifyMatchmakeSessionAttribute | MatchmakeExtensionProtocol::ModifyCurrentGameAttribute | |
MatchmakeExtensionClient::UpdateMatchmakeSession | MatchmakeExtensionProtocol::UpdateMatchmakeSession | |
MatchmakeExtensionClient::UpdateMatchmakeSessionAttribute | MatchmakeExtensionProtocol::UpdateMatchmakeSessionAttribute | |
MatchmakeExtensionClient::UpdateApplicationBuffer | MatchmakeExtensionProtocol::UpdateApplicationBuffer | |
ジョイントセッション機能 | ||
Session::JoinRandomJointSessionAsync | MatchmakeExtensionClient::AutoMatchmake | MatchmakeExtensionProtocol::AutoMatchmakeWithParam_Postpone |
MatchMakingClient::GetSessionURLs | MatchMakingProtocol::GetSessionURLs | |
Session::CreateJointSessionAsync | MatchmakeExtensionClient::CreateMatchmakeSession | MatchmakeExtensionProtocol::CreateMatchmakeSessionWithParam |
MatchMakingClient::GetSessionURLs | MatchMakingProtocol::GetSessionURLs | |
Session::JoinJointSessionAsync | MatchmakeExtensionClient::JoinMatchmakeSession | MatchmakeExtensionProtocol::JoinMatchmakeSessionWithParam |
MatchMakingClient::GetSessionURLs | MatchMakingProtocol::GetSessionURLs | |
Session::DestroyJointSessionAsync | MatchMakingClient::EndParticipation | MatchMakingProtocolExt::EndParticipation |
MatchMakingClient::GetSessionURLs | MatchMakingProtocol::GetSessionURLs | |
Session::LeaveJointSessionAsync | MatchMakingClient::EndParticipation | MatchMakingProtocolExt::EndParticipation |
MatchMakingClient::GetSessionURLs | MatchMakingProtocol::GetSessionURLs | |
Session::OpenJointSessionAsync | MatchmakeExtensionClient::OpenParticipation | MatchmakeExtensionProtocol::OpenParticipation |
Session::CloseJointSessionAsync | MatchmakeExtensionClient::CloseParticipation | MatchmakeExtensionProtocol::CloseParticipation |
Session::UpdateJointSessionSettingAsync | MatchmakeExtensionClient::ModifyMatchmakeSessionAttribute | MatchmakeExtensionProtocol::ModifyMatchmakeSessionAttribute |
MatchmakeExtensionClient::ModifyMatchmakeSessionAttribute | MatchmakeExtensionProtocol::ModifyCurrentGameAttribute | |
MatchmakeExtensionClient::UpdateMatchmakeSession | MatchmakeExtensionProtocol::UpdateMatchmakeSession | |
MatchmakeExtensionClient::UpdateMatchmakeSessionAttribute | MatchmakeExtensionProtocol::UpdateMatchmakeSessionAttribute | |
MatchmakeExtensionClient::UpdateApplicationBuffer | MatchmakeExtensionProtocol::UpdateApplicationBuffer |
PiaSession のシステム処理により自動的に行われる処理と、その処理内で呼び出される可能性のあるサーバー API 名の対応表を以下に示します。
Pia ライブラリ自動処理 | NEX ライブラリ側 API 名 | 記録されるサーバー API 名 |
---|---|---|
ステーション間の接続処理時の NAT トラバーサル | ※NEX マニュアルの対応表に記載無し (ライブラリが自動で呼び出す API として記載有り) |
SecureConnectionInternalProtocol::UpdateConnectionProperties |
SecureConnectionInternalProtocol::ReplaceConnectionProperties | ||
NATTraversalReportInternalProtocol::ReportNATTraversalResult | ||
NATTraversalReportInternalProtocol::ReportNATTraversalResultDetail | ||
非同期処理失敗やエラー発生時の自動クリーンアップ処理 | MatchMakingClient::UnregisterGathering | MatchMakingClient::UnregisterGathering |
MatchMakingClient::EndParticipation | MatchMakingProtocolExt::EndParticipation | |
ジョイントセッション機能 | ||
セッションホストの指示によって受動的に開始されるジョイントセッション処理 |
※NEX マニュアルの対応表に記載無し | MatchmakeExtensionClient::FindMatchmakeSessionByGatheringIdDetail |
MatchMakingClient::GetSessionURLs | MatchMakingProtocol::GetSessionURLs | |
MatchMakingClient::EndParticipation | MatchMakingProtocolExt::EndParticipation | |
ジョイントセッションホストの離脱によるホストマイグレーション | MatchmakingClient::FindByID | MatchMakingProtocol::FindBySingleID |