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

セッションの条件更新処理に関する情報を管理するクラスです。 [詳細]

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

Public メソッド

 LanUpdateSessionSetting ()
 デフォルトコンストラクタ。
 
 LanUpdateSessionSetting (const LanUpdateSessionSetting &rhs)
 コピーコンストラクタ。
 
virtual ~LanUpdateSessionSetting ()
 デストラクタ。
 
void Copy (const LanUpdateSessionSetting &rhs)
 設定をコピーします。
 
LanUpdateSessionSettingoperator= (const LanUpdateSessionSetting &rhs)
 代入演算子です。
 
virtual void Reset ()
 設定をリセットします。
 
virtual Result SetApplicationData (const void *pData, uint32_t size)
 アプリケーション定義のデータを指定します。
 
Result SetAttribute (uint32_t index, uint32_t value)
 セッションの属性を指定します。
 
void SetMaxParticipantNum (uint16_t max)
 セッションの最大参加人数を指定します。
 
void SetMinParticipantNum (uint16_t min)
 セッションの最小参加人数を指定します。
 
void SetSessionType (LanSessionType sessionType)
 セッションのセッションタイプを指定します。
 

説明

セッションの条件更新処理に関する情報を管理するクラスです。

更新する値を指定した設定のみ更新されます。更新しない設定について、指定は不要です。

参照
session::UpdateSessionSetting

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

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

コピーコンストラクタ。

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

関数

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

設定をコピーします。

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

代入演算子です。

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

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

inet::ApplicationDataBufferSizeMax を超えないサイズを指定する必要があります。

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

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

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

セッションの属性を指定します。

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

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

引数
[in]max作成するセッションに指定する最大参加人数。
void nn::pia::lan::LanUpdateSessionSetting::SetMinParticipantNum ( uint16_t  min)

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

引数
[in]min作成するセッションに指定する最小参加人数。
void nn::pia::lan::LanUpdateSessionSetting::SetSessionType ( LanSessionType  sessionType)

セッションのセッションタイプを指定します。

引数
[in]sessionTypeセッションタイプ。