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

LAN マッチメイクのセッション構築処理に関する設定を管理するクラスです。 [詳細]

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

Public メソッド

 LanCreateSessionSetting ()
 デフォルトコンストラクタ。
 
 LanCreateSessionSetting (const LanCreateSessionSetting &rhs)
 コピーコンストラクタ。
 
virtual ~LanCreateSessionSetting ()
 デストラクタ。
 
void Copy (const LanCreateSessionSetting &rhs)
 設定をコピーします。
 
LanCreateSessionSettingoperator= (const LanCreateSessionSetting &rhs)
 代入演算子です。
 
virtual void Reset ()
 設定をリセットします。
 
virtual Result SetApplicationData (const void *pData, uint32_t size)
 アプリケーション定義のデータを指定します。
 
Result SetAttribute (uint32_t index, uint32_t value)
 構築するセッションに属性を指定します。
 
void SetGameMode (uint32_t gameMode)
 構築するセッションのゲームモードを指定します。
 
virtual void SetMaxParticipantNum (uint16_t max)
 作成するセッションの最大参加人数を指定します。
 
void SetMinParticipantNum (uint16_t min)
 作成するセッションの最小参加人数を指定します。
 
void SetOpenSession (bool isOpen)
 構築したセッションが参加可能で構築されるか、参加不可で構築されるかを指定します。
 
void SetSessionType (LanSessionType sessionType)
 構築するセッションタイプを指定します。
 

説明

LAN マッチメイクのセッション構築処理に関する設定を管理するクラスです。

参照
nn::pia::session::CreateSessionSetting

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

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

コピーコンストラクタ。

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

関数

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

設定をコピーします。

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

代入演算子です。

引数
[in]rhs代入するオブジェクトです。
戻り値
本オブジェクトへの参照。
virtual Result nn::pia::lan::LanCreateSessionSetting::SetApplicationData ( const void *  pData,
uint32_t  size 
)
virtual

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

引数
[in]pData構築するセッションに指定するアプリケーション定義データのバッファ。
[in]size構築するセッションに指定するアプリケーション定義データのサイズ。LanApplicationDataBufferSizeMax 以下である必要があります。
戻り値
アプリケーション定義データの設定に成功すれば、成功の Result が返されます。
返るエラーの一覧:
nn::pia::ResultInvalidArgument バッファが NULL ポインタ、または指定したデータサイズが大きすぎます。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

nn::pia::session::CreateSessionSettingを実装しています。

Result nn::pia::lan::LanCreateSessionSetting::SetAttribute ( uint32_t  index,
uint32_t  value 
)

構築するセッションに属性を指定します。

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

構築するセッションのゲームモードを指定します。

引数
[in]gameMode構築するセッションに指定するゲームモード。
virtual void nn::pia::session::CreateSessionSetting::SetMaxParticipantNum ( uint16_t  max)
virtualinherited

作成するセッションの最大参加人数を指定します。

引数
[in]max作成するセッションに指定する最大参加人数。

nn::pia::local::UdsCreateSessionSettingで再定義されています。

void nn::pia::session::CreateSessionSetting::SetMinParticipantNum ( uint16_t  min)
inherited

作成するセッションの最小参加人数を指定します。

引数
[in]min作成するセッションに指定する最小参加人数。
void nn::pia::lan::LanCreateSessionSetting::SetOpenSession ( bool  isOpen)

構築したセッションが参加可能で構築されるか、参加不可で構築されるかを指定します。

引数
[in]isOpentrue を設定した場合、セッションは参加可能な状態で構築されます。
void nn::pia::lan::LanCreateSessionSetting::SetSessionType ( LanSessionType  sessionType)

構築するセッションタイプを指定します。

引数
[in]sessionType構築するセッションに指定するセッションタイプ。