セッション設定の更新処理に関する情報を管理するクラスです。
[詳細]
セッション設定の更新処理に関する情報を管理するクラスです。
更新する値を指定した設定のみ更新されます。更新しない設定について、指定は不要です。
- 参照
- session::UpdateSessionSetting
代入演算子です。
- 引数
-
- 戻り値
- 本オブジェクトへの参照。
virtual Result nn::pia::inet::NexUpdateSessionSetting::SetApplicationData |
( |
const void * |
pData, |
|
|
uint32_t |
size |
|
) |
| |
|
virtual |
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] | ) |
|
void nn::pia::inet::NexUpdateSessionSetting::SetCountryCode |
( |
uint32_t |
countryCode | ) |
|
スコアベースマッチメイク指定時に、比較に使用する国コードを設定します。国コードはプラットフォームで定義された値を設定します。
SetUpdateGeoIp で位置情報を使用しない設定をした場合、もしくは位置情報を使用する設定をしたが位置情報を得られなかった場合に使用する国コードをセットします。 位置情報が得られた場合はここで指定した国コードは使用されません。 国コードをセットしない場合は SetUpdateGeoIp で位置情報を使用しない設定をした場合、もしくは位置情報を使用する設定をしたが位置情報を得られなかった場合、 国コードの比較に関するスコアがデフォルトスコアとして評価されます。
- 引数
-
void nn::pia::inet::NexUpdateSessionSetting::SetDisconnectionRate |
( |
uint32_t |
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 | ) |
|
スコアベースマッチメイク指定時に、比較に使用するレーティング値を更新します。
- 引数
-
void nn::pia::inet::NexUpdateSessionSetting::SetSelectionPriority |
( |
uint8_t |
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::ResultInvalidArgument 日時が設定されていない、または設定した日時が正しくありません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
void nn::pia::inet::NexUpdateSessionSetting::SetUpdateGeoIp |
( |
bool |
use | ) |
|
スコアベースマッチメイク指定時に、比較に使用する位置情報 (緯度経度、国コード) を更新するか設定します。
- 引数
-
void nn::pia::inet::NexUpdateSessionSetting::SetViolationRate |
( |
uint32_t |
violationRate | ) |
|
スコアベースマッチメイク指定時に、比較に使用する違反率を更新します。
- 引数
-