CTR-Pia  5.4.3
Game Communication Engine
 全て クラス ネームスペース 関数 変数 型定義 列挙型 列挙型の値 ページ
クラス nn::pia::local::UdsSessionSearchCriteria

UDS ライブラリ(ローカル通信)を利用したネットワークのセッションを検索する際に使用する検索条件のクラスです。 [詳細]

+ nn::pia::local::UdsSessionSearchCriteriaに対する継承グラフ

Public メソッド

 UdsSessionSearchCriteria (const UdsSessionSearchCriteria &rhs)
 コピーコンストラクタ。。
 
void Copy (const UdsSessionSearchCriteria &rhs)
 設定をコピーします。
 
UdsSessionSearchCriteriaoperator= (const UdsSessionSearchCriteria &rhs)
 代入演算子です。
 
virtual void Reset ()
 設定をリセットします。
 
void SetLocalCommunicationId (uint32_t localCommunicationId)
 検索条件にローカル通信 ID を指定します。
 
void SetMaxParticipantNum (uint16_t max)
 検索条件に最大参加人数を指定します。
 
void SetMaxParticipantNumRange (uint16_t min, uint16_t max)
 検索条件に最大参加人数を範囲指定します。
 
void SetOpenedOnly (bool bOpenedOnly)
 検索条件に参加受付状態のセッションのみを検索するか指定します。
 
virtual Result SetResultRange (uint32_t offset, uint32_t size)
 検索結果の取得範囲を指定します。
 
void SetSubId (uint8_t subId)
 検索条件に通信モード識別用 ID を指定します。
 
void SetVacantOnly (bool bVacantOnly)
 検索条件に空きがあるセッションのみを検索するか指定します。
 

説明

UDS ライブラリ(ローカル通信)を利用したネットワークのセッションを検索する際に使用する検索条件のクラスです。

検索結果として得られるセッションの最大数は nn::pia::session::Session::CreateInstance 呼び出し時に 指定する nn::pia::session::Session::Setting 構造体の browsedSessionInfoListNum の値になります。

コンストラクタとデストラクタ

nn::pia::local::UdsSessionSearchCriteria::UdsSessionSearchCriteria ( const UdsSessionSearchCriteria rhs)

コピーコンストラクタ。。

引数
[in]rhsコピー元のオブジェクトです。

関数

void nn::pia::local::UdsSessionSearchCriteria::Copy ( const UdsSessionSearchCriteria rhs)

設定をコピーします。

引数
[in]rhsコピー元のオブジェクトです。
UdsSessionSearchCriteria& nn::pia::local::UdsSessionSearchCriteria::operator= ( const UdsSessionSearchCriteria rhs)

代入演算子です。

引数
[in]rhs代入するオブジェクトです。
戻り値
本オブジェクトへの参照。
void nn::pia::local::UdsSessionSearchCriteria::SetLocalCommunicationId ( uint32_t  localCommunicationId)
inline

検索条件にローカル通信 ID を指定します。

引数
[in]localCommunicationId検索条件に指定するローカル通信 ID です。LocalFacade::CreateLocalCommunicationId で生成した値を指定する必要があります。
void nn::pia::local::LocalSessionSearchCriteria::SetMaxParticipantNum ( uint16_t  max)
inlineinherited

検索条件に最大参加人数を指定します。

引数
[in]max検索条件に指定する最大参加人数。
void nn::pia::local::LocalSessionSearchCriteria::SetMaxParticipantNumRange ( uint16_t  min,
uint16_t  max 
)
inlineinherited

検索条件に最大参加人数を範囲指定します。

引数
[in]min検索条件に指定する最大参加人数の範囲の下限。
[in]max検索条件に指定する最大参加人数の範囲の上限。
void nn::pia::local::LocalSessionSearchCriteria::SetOpenedOnly ( bool  bOpenedOnly)
inlineinherited

検索条件に参加受付状態のセッションのみを検索するか指定します。

引数
[in]bOpenedOnly参加受付状態のセッションのみを検索する場合は true を指定します。
virtual Result nn::pia::session::SessionSearchCriteria::SetResultRange ( uint32_t  offset,
uint32_t  size 
)
virtualinherited

検索結果の取得範囲を指定します。

インターネット通信時のみ offset に 0xFFFFFFFF を指定すると、検索結果をランダムに並び替えた上で 指定されたエントリー数を取得するように振る舞います。

引数
[in]offset検索条件にマッチしたエントリーリストから検索結果として取得するエントリー群の開始位置。
[in]size検索条件にマッチしたエントリーリストから検索結果として取得するエントリー数。
戻り値
処理に成功すれば、成功の Result が返されます。失敗した場合、以下の Result を返します。
返るエラーの一覧:
nn::pia::ResultInvalidArgument 引数の値が範囲外です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

nn::pia::inet::NexSessionSearchCriteria, と nn::pia::inet::NexSessionSearchCriteriaOwnerで再定義されています。

void nn::pia::local::UdsSessionSearchCriteria::SetSubId ( uint8_t  subId)
inline

検索条件に通信モード識別用 ID を指定します。

引数
[in]subId検索条件に指定する通信モード識別用 ID です。0xff を指定するとあらゆる ID を探索します。
void nn::pia::local::LocalSessionSearchCriteria::SetVacantOnly ( bool  bVacantOnly)
inlineinherited

検索条件に空きがあるセッションのみを検索するか指定します。

引数
[in]bVacantOnly空きがあるセッションのみを検索する場合は true を指定します。