CTR NEX API Reference
nn::nex::StationProbeList クラス

StationProbe のリストを内包するクラスです。 [詳解]

#include <OnlineCore/src/Transport/Interface/StationProbeList.h>

+ nn::nex::StationProbeList の継承関係図

クラス

class  PingStats
 各端末との間の PingTime (RTT) の統計情報です。 [詳解]
 

公開メンバ関数

 StationProbeList ()
 コンストラクタです。空の StationProbeList を生成します。
 
 StationProbeList (const qList< StationURL > &reflstStationURL)
 コンストラクタです。 [詳解]
 
virtual ~StationProbeList ()
 デストラクタです
 
StationProbeAddStationURL (const StationURL &refStationURL)
 StationURL を NAT トラバーサル対象として追加します [詳解]
 
qBool AnyoneFailed () const
 いずれかの端末との NAT トラバーサルが失敗したかどうかを取得します。 [詳解]
 
qBool EveryoneReached () const
 全ての端末との NAT トラバーサルが成功して疎通が取れたかどうかを取得します。 [詳解]
 
PingStats GetPingStats () const
 各端末との間の PingTime (RTT) の統計情報を取得します。 [詳解]
 
void Reset ()
 内部で保持している NAT トラバーサルの結果をクリアします。 [詳解]
 
void Trace (qUnsignedInt64 uiTraceFlags)
 本オブジェクトの内容をログ出力します。 [詳解]
 

詳解

StationProbe のリストを内包するクラスです。

VSocket::ProbeStations() で NAT トラバーサルを行う際に使用します。 NAT トラバーサルの対象とする端末情報 (StationProbe) を保持します。 StationProbe には NAT トラバーサルの結果となる詳細情報が含まれ、これは VSocket::ProbeStations() の完了後に StationProbeList::begin() などのイテレータを使用することにより参照します。

構築子と解体子

nn::nex::StationProbeList::StationProbeList ( const qList< StationURL > &  reflstStationURL)

コンストラクタです。

引数で与える StationURL のリストは、 MatchMakingClient::GetSessionURLs(), MatchMakingClient::GetParticipantsURLs(), MatchmakeExtensionClient::BrowseMatchmakeSession() などで、 ゲームサーバーから取得したものである必要があります。 これらの API で取得した StationURL は、通常一つの端末につき複数個存在します。 指定した StationURL のリストは本コンストラクタ内部で自動的に端末ごとに分類され、StationProbe にまとめられます。 生成したオブジェクトに対して StationProbeList::size() を呼び出すと端末の数と一致します。

引数
[in]reflstStationURL内部で保持する NAT トラバーサル対象の StationURL のリスト

関数詳解

StationProbe* nn::nex::StationProbeList::AddStationURL ( const StationURL refStationURL)

StationURL を NAT トラバーサル対象として追加します

同じ端末に対する StationProbe がすでに存在する場合は、その StationProbeStationURL が追加されます。

引数
[in]refStationURL追加する URL。
戻り値
StationProbe のポインタ
PingStats nn::nex::StationProbeList::GetPingStats ( ) const

各端末との間の PingTime (RTT) の統計情報を取得します。

VSocket::ProbeStations() の完了後に利用可能になります。 個別の NAT トラバーサル結果を取得するには begin() などのイテレータを使用して StationProbe オブジェクトを参照してください。

戻り値
各端末との間の PingTime (RTT) の統計情報。
qBool nn::nex::StationProbeList::EveryoneReached ( ) const

全ての端末との NAT トラバーサルが成功して疎通が取れたかどうかを取得します。

VSocket::ProbeStations() の完了後に利用可能になります。 個別の NAT トラバーサル結果を取得するには begin() などのイテレータを使用して StationProbe オブジェクトを参照してください。

戻り値
全ての端末との NAT トラバーサルが成功して疎通が取れたかどうか。
qBool nn::nex::StationProbeList::AnyoneFailed ( ) const

いずれかの端末との NAT トラバーサルが失敗したかどうかを取得します。

VSocket::ProbeStations() の完了後に利用可能になります。 個別の NAT トラバーサル結果を取得するには begin() などのイテレータを使用して StationProbe オブジェクトを参照してください。

戻り値
いずれかの端末との NAT トラバーサルが失敗したかどうか。
void nn::nex::StationProbeList::Trace ( qUnsignedInt64  uiTraceFlags)

本オブジェクトの内容をログ出力します。

引数
[in]uiTraceFlagsTraceLog::SetFlag() の引数と同様です。
void nn::nex::StationProbeList::Reset ( )

内部で保持している NAT トラバーサルの結果をクリアします。

内部で保持している StationProbe の PingTime や 接続情報、統計情報をクリアします。 VSocket::ProbeStations() 開始時に自動的に呼び出されます。