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

端末のアドレス情報 (StationURL) 及び NAT トラバーサル処理で計測された PingTime (RTT) 値を保持するクラスです。 [詳解]

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

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

公開メンバ関数

 StationProbe ()
 コンストラクタです
 
virtual ~StationProbe ()
 デストラクタです。
 
qUnsignedInt32 GetPingTime () const
 NAT トラバーサルで計測した PingTime (RTT) 値を取得します。 [詳解]
 
StationURLGetPreferredURL ()
 NAT トラバーサルを行って得られた接続情報です。 [詳解]
 
const StationURLGetPreferredURL () const
 NAT トラバーサルを行って得られた接続情報です。 [詳解]
 
PrincipalID GetPrincipalId () const
 この端末に紐づけられているプリンシパル ID を取得します。 [詳解]
 
const UserContextGetUserContext () const
 アプリケーション定義データを取得します。 [詳解]
 
void SetUserContext (const UserContext &refUserContext)
 アプリケーション定義データをセットします。 [詳解]
 

詳解

端末のアドレス情報 (StationURL) 及び NAT トラバーサル処理で計測された PingTime (RTT) 値を保持するクラスです。

通常、アプリケーションが直接生成することはありません。 StationProbeList のコンストラクタ または StationProbeList::AddStationURL() で生成されます。

関数詳解

StationURL& nn::nex::StationProbe::GetPreferredURL ( )

NAT トラバーサルを行って得られた接続情報です。

VSocket::ProbeStations() の完了後に利用可能になります。 得られた StationURL オブジェクトから StationURL::GetInetAddress() 及び InetAddress::GetAddress() と InetAddress::GetPortNumber() で IP アドレスとポート番号を取得してください。

戻り値
NAT トラバーサルを行って得られた接続情報
const StationURL& nn::nex::StationProbe::GetPreferredURL ( ) const

NAT トラバーサルを行って得られた接続情報です。

VSocket::ProbeStations() の完了後に利用可能になります。 得られた StationURL オブジェクトから StationURL::GetInetAddress() 及び InetAddress::GetAddress() と InetAddress::GetPortNumber() で IP アドレスとポート番号を取得してください。

戻り値
NAT トラバーサルを行って得られた接続情報
qUnsignedInt32 nn::nex::StationProbe::GetPingTime ( ) const

NAT トラバーサルで計測した PingTime (RTT) 値を取得します。

VSocket::ProbeStations() の完了後に利用可能になります。 本関数で NAT トラバーサルに成功したかどうかも判断出来ます。 NAT トラバーサルが失敗した場合、 Infinite が返ります。


戻り値一覧:

Infinite NAT トラバーサルに失敗した。

Infinite以外 この端末との PingTime (RTT) 値(ミリ秒)。

PrincipalID nn::nex::StationProbe::GetPrincipalId ( ) const

この端末に紐づけられているプリンシパル ID を取得します。

戻り値
この端末に紐づけられているプリンシパル ID。
const UserContext& nn::nex::StationProbe::GetUserContext ( ) const

アプリケーション定義データを取得します。

戻り値
アプリケーションがセットした UserContext。
void nn::nex::StationProbe::SetUserContext ( const UserContext refUserContext)

アプリケーション定義データをセットします。

引数
[in]refUserContextアプリケーションが任意の値を指定した UserContext。