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

LAN マッチメイクのセッションを検索する際に使用する検索条件のクラスです。 [詳細]

+ nn::pia::lan::LanSessionSearchCriteriaに対する継承グラフ

Public メソッド

 LanSessionSearchCriteria ()
 デフォルトコンストラクタ。
 
 LanSessionSearchCriteria (const LanSessionSearchCriteria &rhs)
 コピーコンストラクタ。
 
virtual ~LanSessionSearchCriteria ()
 デストラクタ。
 
void Copy (const LanSessionSearchCriteria &rhs)
 設定をコピーします。
 
LanSessionSearchCriteriaoperator= (const LanSessionSearchCriteria &rhs)
 代入演算子です。
 
virtual void Reset ()
 設定をリセットします。
 
Result SetAttribute (uint32_t index, uint32_t value)
 1つの属性に対して検索時に使用する値を指定します。
 
Result SetAttribute (uint32_t index, const uint32_t *value, uint32_t attributeNum)
 1つの属性に対して検索時に使用する値を複数指定します。
 
Result SetAttributeRange (uint32_t index, uint32_t min, uint32_t max)
 1つの属性に対して検索時に使用する値を範囲指定します。
 
void SetGameMode (uint32_t gameMode)
 検索条件にゲームモードを指定します。
 
void SetMaxParticipantNum (uint16_t max)
 検索条件に最大参加人数を指定します。
 
void SetMaxParticipantNumRange (uint16_t min, uint16_t max)
 検索条件に最大参加人数を範囲指定します。
 
void SetMinParticipantNum (uint16_t min)
 検索条件に最小参加人数を指定します。
 
void SetMinParticipantNumRange (uint16_t min, uint16_t max)
 検索条件に最小参加人数を範囲指定します。
 
void SetOpenedOnly (bool bOpenedOnly)
 検索条件に参加受付状態のセッションのみを検索するか指定します。
 
virtual Result SetResultRange (uint32_t offset, uint32_t size)
 検索結果の取得範囲を指定します。
 
void SetSessionType (LanSessionType sessionType)
 検索条件にセッションタイプを指定します。
 
void SetVacantOnly (bool bVacantOnly)
 検索条件に空きがあるセッションのみを検索するか指定します。
 

説明

LAN マッチメイクのセッションを検索する際に使用する検索条件のクラスです。

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

参照
nn::pia::session::SessionSearchCriteria

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

nn::pia::lan::LanSessionSearchCriteria::LanSessionSearchCriteria ( const LanSessionSearchCriteria rhs)

コピーコンストラクタ。

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

関数

void nn::pia::lan::LanSessionSearchCriteria::Copy ( const LanSessionSearchCriteria rhs)

設定をコピーします。

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

代入演算子です。

引数
[in]rhs代入するオブジェクトです。
戻り値
本オブジェクトへの参照。
Result nn::pia::lan::LanSessionSearchCriteria::SetAttribute ( uint32_t  index,
uint32_t  value 
)

1つの属性に対して検索時に使用する値を指定します。

引数
[in]index指定する属性のインデックス。LanAttributeSizeMax 以下である必要があります。
[in]value指定する属性の値。
戻り値
セッションの属性の指定に成功すれば、成功の Result が返されます。
返るエラーの一覧:
nn::pia::ResultInvalidArgument 属性のインデックスが範囲外です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
Result nn::pia::lan::LanSessionSearchCriteria::SetAttribute ( uint32_t  index,
const uint32_t *  value,
uint32_t  attributeNum 
)

1つの属性に対して検索時に使用する値を複数指定します。

引数
[in]index指定する属性のインデックス。LanAttributeSizeMax 以下である必要があります。
[in]value指定する属性の値のリスト。
[in]attributeNum指定する属性の値の個数。LanAttributeArraySizeMax 以下である必要があります。
戻り値
セッションの属性の指定に成功すれば、成功の Result が返されます。
返るエラーの一覧:
nn::pia::ResultInvalidArgument 属性のインデックスが範囲外、値のリストが NULL、または値の個数が多すぎます。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
Result nn::pia::lan::LanSessionSearchCriteria::SetAttributeRange ( uint32_t  index,
uint32_t  min,
uint32_t  max 
)

1つの属性に対して検索時に使用する値を範囲指定します。

引数
[in]index指定する属性のインデックス。LanAttributeSizeMax 以下である必要があります。
[in]min指定する属性の値の下限。
[in]max指定する属性の値の上限。
戻り値
セッションの属性の指定に成功すれば、成功の Result が返されます。
返るエラーの一覧:
nn::pia::ResultInvalidArgument 属性のインデックスが範囲外、または下限値が上限値よりも大きい値になっています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
void nn::pia::lan::LanSessionSearchCriteria::SetGameMode ( uint32_t  gameMode)

検索条件にゲームモードを指定します。

引数
[in]gameMode検索条件に指定するゲームモード。
void nn::pia::lan::LanSessionSearchCriteria::SetMaxParticipantNum ( uint16_t  max)

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

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

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

引数
[in]min検索条件に指定する最大参加人数の範囲の下限。
[in]max検索条件に指定する最大参加人数の範囲の上限。
void nn::pia::lan::LanSessionSearchCriteria::SetMinParticipantNum ( uint16_t  min)

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

引数
[in]min検索条件に指定する最小参加人数。
void nn::pia::lan::LanSessionSearchCriteria::SetMinParticipantNumRange ( uint16_t  min,
uint16_t  max 
)

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

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

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

引数
[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::lan::LanSessionSearchCriteria::SetSessionType ( LanSessionType  sessionType)

検索条件にセッションタイプを指定します。

引数
[in]sessionType検索条件に指定するセッションタイプ。
void nn::pia::lan::LanSessionSearchCriteria::SetVacantOnly ( bool  bVacantOnly)

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

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