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

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

+ nn::pia::inet::NexUpdateSessionSettingに対する継承グラフ

Public メソッド

 NexUpdateSessionSetting ()
 デフォルトコンストラクタ。
 
 NexUpdateSessionSetting (const NexUpdateSessionSetting &rhs)
 コピーコンストラクタ。
 
virtual ~NexUpdateSessionSetting ()
 デストラクタ。
 
void Copy (const NexUpdateSessionSetting &rhs)
 設定をコピーします。
 
NexUpdateSessionSettingoperator= (const NexUpdateSessionSetting &rhs)
 代入演算子です。
 
virtual void Reset ()
 設定をリセットします。
 
virtual Result SetApplicationData (const void *pData, uint32_t size)
 アプリケーション定義のデータを指定します。
 
Result SetAttribute (uint32_t index, uint32_t value)
 セッションの属性をインデックスを指定して設定します。
 
void SetAttributes (const uint32_t attributes[nn::pia::inet::AttributeSizeMax])
 セッションの属性を一括して指定します。
 
void SetCountryCode (uint32_t countryCode)
 スコアベースマッチメイク指定時に、比較に使用する国コードを設定します。国コードはプラットフォームで定義された値を設定します。
 
void SetDisconnectionRate (uint32_t disconnectionRate)
 スコアベースマッチメイク指定時に、比較に使用する切断率を更新します。
 
void SetMaxParticipantNum (uint16_t max)
 セッションの最大参加人数を指定します。
 
void SetMinParticipantNum (uint16_t min)
 セッションの最小参加人数を指定します。
 
void SetRatingValue (uint32_t ratingValue)
 スコアベースマッチメイク指定時に、比較に使用するレーティング値を更新します。
 
void SetSelectionPriority (uint8_t priority)
 同じ条件のセッションが見つかった際のマッチメイクの優先度を指定します。
 
Result SetSessionMatchmakeKeyword (const common::String &keyword)
 あいことばマッチメイク用のあいことばを指定します。
 
void SetSessionType (SessionType sessionType, bool isAutoCloseSession=false)
 セッションのセッションタイプとホストマイグレーション時にセッションを自動的に参加締切状態にする設定を指定します。
 
Result SetSessionUserPassword (const common::String &userPassword)
 セッションのユーザーパスワードを指定します。
 
Result SetStartedTime (const common::DateTime &dateTime)
 セッションの開始日時の更新日時を指定します。
 
void SetUpdateGeoIp (bool use)
 スコアベースマッチメイク指定時に、比較に使用する位置情報 (緯度経度、国コード) を更新するか設定します。
 
void SetViolationRate (uint32_t violationRate)
 スコアベースマッチメイク指定時に、比較に使用する違反率を更新します。
 

説明

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

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

参照
session::UpdateSessionSetting

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

nn::pia::inet::NexUpdateSessionSetting::NexUpdateSessionSetting ( const NexUpdateSessionSetting rhs)

コピーコンストラクタ。

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

関数

void nn::pia::inet::NexUpdateSessionSetting::Copy ( const NexUpdateSessionSetting rhs)

設定をコピーします。

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

代入演算子です。

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

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

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

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

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

Result nn::pia::inet::NexUpdateSessionSetting::SetAttribute ( uint32_t  index,
uint32_t  value 
)

セッションの属性をインデックスを指定して設定します。

本関数でセッションの属性を設定する場合は、他の項目を併せて設定できません。

引数
[in]index指定するセッションの属性のインデックス。AttributeSizeMax 以下である必要があります。
[in]value指定するセッションの属性の値。
戻り値
セッションの属性の指定に成功すれば、成功の Result が返されます。
返るエラーの一覧:

nn::pia::ResultInvalidArgument 属性のインデックスが範囲外です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

nn::pia::ResultInvalidState 他の項目が設定されています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

void nn::pia::inet::NexUpdateSessionSetting::SetAttributes ( const uint32_t  attributes[nn::pia::inet::AttributeSizeMax])

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

引数
[in]attributes属性の配列。配列のサイズは AttributeSizeMax である必要があります。
void nn::pia::inet::NexUpdateSessionSetting::SetCountryCode ( uint32_t  countryCode)

スコアベースマッチメイク指定時に、比較に使用する国コードを設定します。国コードはプラットフォームで定義された値を設定します。

SetUpdateGeoIp で位置情報を使用しない設定をした場合、もしくは位置情報を使用する設定をしたが位置情報を得られなかった場合に使用する国コードをセットします。 位置情報が得られた場合はここで指定した国コードは使用されません。 国コードをセットしない場合は SetUpdateGeoIp で位置情報を使用しない設定をした場合、もしくは位置情報を使用する設定をしたが位置情報を得られなかった場合、 国コードの比較に関するスコアがデフォルトスコアとして評価されます。

引数
[in]countryCode国コード
void nn::pia::inet::NexUpdateSessionSetting::SetDisconnectionRate ( uint32_t  disconnectionRate)

スコアベースマッチメイク指定時に、比較に使用する切断率を更新します。

引数
[in]disconnectionRate切断率
void nn::pia::inet::NexUpdateSessionSetting::SetMaxParticipantNum ( uint16_t  max)

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

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

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

引数
[in]min作成するセッションに指定する最小参加人数。
void nn::pia::inet::NexUpdateSessionSetting::SetRatingValue ( uint32_t  ratingValue)

スコアベースマッチメイク指定時に、比較に使用するレーティング値を更新します。

引数
[in]ratingValueレーティング値
void nn::pia::inet::NexUpdateSessionSetting::SetSelectionPriority ( uint8_t  priority)

同じ条件のセッションが見つかった際のマッチメイクの優先度を指定します。

作成したセッションのマッチメイクの優先度を指定します。 nn::pia::inet::SelectionMethod_BroadenRangeWithSelectionPriority, nn::pia::inet::SelectionMethod_ScoreBased で検索を行った場合のみ有効です。 nn::pia::inet::SessionSelectionPriorityMax を超えた値を引数にした場合、nn::pia::inet::SessionSelectionPriorityMax が設定されます。

引数
[in]priority指定するマッチメイクの優先度
Result nn::pia::inet::NexUpdateSessionSetting::SetSessionMatchmakeKeyword ( const common::String keyword)

あいことばマッチメイク用のあいことばを指定します。

引数
[in]keyword設定するあいことばマッチメイク用のあいことば。あいことばの文字列は SessionMatchmakeKeywordLength 以下である必要があります。
戻り値
あいことばの指定に成功すれば、成功の Result が返されます。
返るエラーの一覧:
nn::pia::ResultInvalidArgument 文字列が NULL、文字コードが不正、またはあいことばの最大長を超えています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
void nn::pia::inet::NexUpdateSessionSetting::SetSessionType ( SessionType  sessionType,
bool  isAutoCloseSession = false 
)

セッションのセッションタイプとホストマイグレーション時にセッションを自動的に参加締切状態にする設定を指定します。

セッションタイプの変更は inet::SessionType_Friend から inet::SessionType_Anybody への更新のみ可能です。 セッションタイプを変更せず、自動的に参加締切状態に設定のみを更新することも可能です。デフォルトでは自動的に参加締切状態に変更しない設定になります。

引数
[in]sessionTypeセッションタイプ。
[in]isAutoCloseSessionホストマイグレーション時にセッションを自動的に参加締切状態にする設定。
Result nn::pia::inet::NexUpdateSessionSetting::SetSessionUserPassword ( const common::String userPassword)

セッションのユーザーパスワードを指定します。

引数
[in]userPassword設定するユーザーパスワード。パスワードの文字列は SessionUserPasswordLengthMax 以下である必要があります。
戻り値
ユーザーパスワードの指定に成功すれば、成功の Result が返されます。
返るエラーの一覧:
nn::pia::ResultInvalidArgument 文字列が NULL、文字コードが不正、またはユーザーパスワードの最大長を超えています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
Result nn::pia::inet::NexUpdateSessionSetting::SetStartedTime ( const common::DateTime dateTime)

セッションの開始日時の更新日時を指定します。

現在時刻より未来の日時が設定された場合は、現在時刻がサーバーでセットされます。

引数
[in]dateTime開始日時
戻り値
セッションの開始日時の更新日時の指定に成功すれば、成功の Result が返されます。
返るエラーの一覧:
nn::pia::ResultInvalidArgument 日時が設定されていない、または設定した日時が正しくありません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
void nn::pia::inet::NexUpdateSessionSetting::SetUpdateGeoIp ( bool  use)

スコアベースマッチメイク指定時に、比較に使用する位置情報 (緯度経度、国コード) を更新するか設定します。

引数
[in]use位置情報を更新するかどうか
void nn::pia::inet::NexUpdateSessionSetting::SetViolationRate ( uint32_t  violationRate)

スコアベースマッチメイク指定時に、比較に使用する違反率を更新します。

引数
[in]violationRate違反率