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

Station の URL を構築します。 [詳解]

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

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

公開型

enum  Flags {
  BehindNAT = (1 << 0),
  Public = (1 << 1),
  DetectedByNatCheck = (1 << 2),
  DetectedByNgs = (1 << 3)
}
 StationURL に設定可能な各種Flagsを列挙します。 [詳解]
 
enum  URLType {
  unknown,
  prudp,
  prudps,
  udp
}
 StationURL の種類を列挙します。 [詳解]
 

公開メンバ関数

 StationURL ()
 コンストラクタです
 
 StationURL (const StationURL &oStationURL)
 コピーコンストラクタです [詳解]
 
virtual ~StationURL ()
 デストラクタです
 
const qCharCStr () const
 Station の URL を文字列を返します。 [詳解]
 
qBool Get (const String &strKey, String *pstrValue) const
 指定されたキーに関連付けられている値を返します。 [詳解]
 
String GetAddress () const
 Station のアドレスを取得します [詳解]
 
qUnsignedInt16 GetPortNumber () const
 この StationURL によって指定されたポート番号を返します。 [詳解]
 
PrincipalID GetPrincipalID () const
 この StationURL によって指定されたPrincipalID を取得します。 [詳解]
 
String GetStringRepresentation () const
 StationURL を文字列で返します。 [詳解]
 
URLType GetURLType () const
 この StationURL が使用する URLType を取得します。 [詳解]
 
qBool IsBehindNAT () const
 この StationURL が関連する Station が NAT デバイスの配下にあるものであるかを返します。 [詳解]
 
qBool IsPublic () const
 この StationURL がパブリックのIPアドレスおよびポート番号を参照しているかどうかを返します。 [詳解]
 
qBool operator!= (const StationURL &oStationURL) const
 比較演算子です。
 
StationURLoperator= (const StationURL &oStationURL)
 代入演算子です。
 
StationURLoperator= (const String &strURL)
 代入演算子です。
 
StationURLoperator= (const qChar *szURL)
 代入演算子です。
 
qBool operator== (const StationURL &oStationURL) const
 比較演算子です。
 
qBool Remove (const String &strKey)
 StationURL からユーザー定義属性を削除します。 [詳解]
 
qBool Set (const String &strKey, const String &strValue)
 StationURL にユーザー定義属性を設定します。 [詳解]
 
qBool SetAddress (const qChar *strAddress)
 この StationURL が使用するアドレスを設定します。 [詳解]
 
void SetPortNumber (const qUnsignedInt16 ui16Port)
 ポート番号をセットします。 [詳解]
 
void SetPrincipalID (const PrincipalID pid)
 この StationURL によって指定されるPrincipalID を設定します。 [詳解]
 
void SetURLType (const URLType eType)
 この StationURL が使用する URLType を設定します。 [詳解]
 
void Trace (qUnsignedInt64 uiTraceFlags=TRACE_ALWAYS) const
 この StationURL の内容をトレースします。 [詳解]
 

詳解

Station の URL を構築します。

このクラスは、特定のノードに対して URLを構築します。 StationURLには、最低1つのURLとポート、そして NAT トラバーサル用には ConnectionID が必要です。

列挙型メンバ詳解

StationURL の種類を列挙します。

列挙値
unknown 

無効。

prudp 

PRUDP。信頼性のある UDP 通信プロトコルです。

prudps 

PRUDPS。信頼性のある セキュアな UDP 通信プロトコルです。ゲームサーバーとの通信に使用されます。

udp 

UDP。

StationURL に設定可能な各種Flagsを列挙します。

参照
Flags
列挙値
BehindNAT 

StationURLに対応するステーションは、NATデバイスの配下にある

Public 

StationURL は、パブリックなIPアドレスおよびポート番号を参照している

DetectedByNatCheck 

StationURL は、NAT チェックサーバーで検出されたグローバルアドレスを参照している。必ず同時に Public フラグも立つ。

DetectedByNgs 

StationURL は、NGS で検出されたグローバルアドレスを参照している。必ず同時に Public フラグも立つ。

構築子と解体子

nn::nex::StationURL::StationURL ( const StationURL oStationURL)

コピーコンストラクタです

引数
[in]oStationURLコピー元の StationURL

関数詳解

void nn::nex::StationURL::SetURLType ( const URLType  eType)

この StationURL が使用する URLType を設定します。

引数
[in]eTypeこの StationURL が使用する URLType 。
URLType nn::nex::StationURL::GetURLType ( ) const

この StationURL が使用する URLType を取得します。

戻り値
この StationURL が使用する URLType 。
qBool nn::nex::StationURL::SetAddress ( const qChar strAddress)

この StationURL が使用するアドレスを設定します。

アドレスとのポート番号をコンストラクタで指定しない場合は、本関数を使用して後で設定することができます。

引数
[in]strAddressこの StationURL が使用するアドレス。これはテキストまたは数字形式で指定できます(例"www.quazal.com" または "192.168.10.1")。
String nn::nex::StationURL::GetAddress ( ) const

Station のアドレスを取得します

戻り値
Station のアドレス
void nn::nex::StationURL::SetPortNumber ( const qUnsignedInt16  ui16Port)

ポート番号をセットします。

引数
[in]ui16PortStationURL によって指定されるポート番号。
qUnsignedInt16 nn::nex::StationURL::GetPortNumber ( ) const

この StationURL によって指定されたポート番号を返します。

戻り値
この StationURL によって指定されたポート番号。
覚え書き
ポート番号は、 URLType がPRUDPの場合のみ、有効です。
void nn::nex::StationURL::SetPrincipalID ( const PrincipalID  pid)

この StationURL によって指定されるPrincipalID を設定します。

引数
[in]pidこの StationURL によって指定されるPrincipalID 。
PrincipalID nn::nex::StationURL::GetPrincipalID ( ) const

この StationURL によって指定されたPrincipalID を取得します。

この StationURLMatchMakingClient::GetSessionURLs などによってゲームサーバーから取得したものでない場合は、 PrincipalID がセットされていないことがあります。

戻り値
この StationURL によって指定されたPrincipalID 。
覚え書き
PrincipalIDは、 URLType がPRUDPSの場合のみ、有効になります。
qBool nn::nex::StationURL::IsBehindNAT ( ) const

この StationURL が関連する Station が NAT デバイスの配下にあるものであるかを返します。


戻り値一覧:

true StationURL が関連する Station が NAT デバイスの配下にある

false NAT デバイスの配下にない、またはエラーが発生

参照
Flags
qBool nn::nex::StationURL::IsPublic ( ) const

この StationURL がパブリックのIPアドレスおよびポート番号を参照しているかどうかを返します。


戻り値一覧:

true この StationURL がパブリックのIPアドレスおよびポート番号を参照している

false 上記以外、またはエラーが発生した場合は偽。

String nn::nex::StationURL::GetStringRepresentation ( ) const

StationURL を文字列で返します。

戻り値
StationURL の文字列表現。
qBool nn::nex::StationURL::Set ( const String strKey,
const String strValue 
)

StationURL にユーザー定義属性を設定します。

戻り値
設定できたら真、そうでない場合は偽。
引数
[in]strKey設定する値のキー 。
[out]strValue設定する値。
参照
Get, Remove
qBool nn::nex::StationURL::Get ( const String strKey,
String pstrValue 
) const

指定されたキーに関連付けられている値を返します。

戻り値
特定の属性が存在する場合は真、そうでない場合は偽。
引数
[in]strKey取得する値のキー 。
[out]pstrValue指定のキーの値を保存するポインタ。
参照
Set, Remove
qBool nn::nex::StationURL::Remove ( const String strKey)

StationURL からユーザー定義属性を削除します。

戻り値
削除できたら真、そうでない場合は偽。
引数
[in]strKey削除する値のキー 。
参照
Get, Set
void nn::nex::StationURL::Trace ( qUnsignedInt64  uiTraceFlags = TRACE_ALWAYS) const

この StationURL の内容をトレースします。

引数
[in]uiTraceFlagsTRACE フラグ
const qChar* nn::nex::StationURL::CStr ( ) const

Station の URL を文字列を返します。

戻り値
Station の URL