インターネット通信のセッション情報クラスです。
[詳細]
インターネット通信のセッション情報クラスです。
- 参照
- session::ISessionInfo
nn::pia::inet::NexSessionInfo::NexSessionInfo |
( |
const NexSessionInfo & |
rhs | ) |
|
void nn::pia::inet::NexSessionInfo::Copy |
( |
const NexSessionInfo & |
rhs | ) |
|
virtual Result nn::pia::inet::NexSessionInfo::GetApplicationData |
( |
void * |
pBuffer, |
|
|
uint32_t |
size |
|
) |
| const |
|
virtual |
セッションのアプリケーション定義データを取得します。
セッションに設定したアプリケーション定義データを取得します。
- 引数
-
[out] | pBuffer | セッションのアプリケーション定義データのコピー用バッファのポインタ。 |
[in] | size | セッションのアプリケーション定義データのコピー用バッファのサイズ。アプリケーション定義データの最大長は ApplicationDataBufferSizeMax です。 |
- 戻り値
- 正常に情報を取得できた場合、成功の Result が返ります。
- 返るエラーの一覧:
ResultInvalidArgument バッファが NULL ポインタです。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
ResultInvalidState アプリケーション定義データが設定されていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
ResultBufferShortage 設定されているアプリケーション定義データのサイズがバッファのサイズよりも大きいため、コピーできません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
nn::pia::session::ISessionInfoを実装しています。
virtual uint32_t nn::pia::inet::NexSessionInfo::GetApplicationDataSize |
( |
| ) |
const |
|
virtual |
virtual Result nn::pia::inet::NexSessionInfo::GetAttribute |
( |
uint8_t |
idx, |
|
|
uint32_t * |
pAttribute |
|
) |
| const |
|
virtual |
セッションの属性を取得します。
- 引数
-
[in] | idx | 取得する属性のインデックス。AttributeSizeMax である必要があります。 |
[out] | pAttribute | 指定されたインデックスのセッションの属性格納先のポインタ。 |
- 戻り値
- 正常に情報を取得できた場合、成功の Result が返ります。
- 返るエラーの一覧:
- ResultInvalidArgument 引数が不正です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
virtual uint32_t nn::pia::inet::NexSessionInfo::GetCommunityId |
( |
| ) |
const |
|
virtual |
セッションに関連付けられているコミュニティの ID を取得します。
- 戻り値
- セッションに関連付けられているコミュニティの ID を返します。
virtual uint16_t nn::pia::inet::NexSessionInfo::GetCurrentParticipantNum |
( |
| ) |
const |
|
virtual |
virtual uint32_t nn::pia::inet::NexSessionInfo::GetGameMode |
( |
| ) |
const |
|
virtual |
virtual PrincipalId nn::pia::inet::NexSessionInfo::GetHostPrincipalId |
( |
| ) |
const |
|
virtual |
セッションのホストのプリンシパル ID を取得します。
- 戻り値
- セッションのホストのプリンシパル ID が返ります。
virtual uint16_t nn::pia::inet::NexSessionInfo::GetMaxParticipantNum |
( |
| ) |
const |
|
virtual |
virtual uint16_t nn::pia::inet::NexSessionInfo::GetMinParticipantNum |
( |
| ) |
const |
|
virtual |
virtual uint8_t nn::pia::inet::NexSessionInfo::GetSelectionPriority |
( |
| ) |
const |
|
virtual |
セッションのマッチメイクの優先度を取得します。
- 戻り値
- セッションのマッチメイクの優先度が返ります。
virtual uint32_t nn::pia::inet::NexSessionInfo::GetSessionId |
( |
| ) |
const |
|
virtual |
virtual SessionType nn::pia::inet::NexSessionInfo::GetSessionType |
( |
| ) |
const |
|
virtual |
セッションタイプを取得します。
- 戻り値
- 設定されているセッションタイプが返ります。
virtual const common::DateTime& nn::pia::inet::NexSessionInfo::GetStartedTime |
( |
| ) |
const |
|
virtual |
セッションが開始された時刻を取得します。
- 戻り値
- セッションが開始された時刻が返ります。
virtual PrincipalId nn::pia::inet::NexSessionInfo::GetTargetPrincipalId |
( |
| ) |
const |
|
virtual |
セッションの検索条件に指定したプリンシパル ID を取得します。
- 戻り値
- セッションの検索条件に指定したプリンシパル ID が返ります。
virtual bool nn::pia::inet::NexSessionInfo::IsAutoCloseSession |
( |
| ) |
const |
|
virtual |
ホストマイグレーション時にセッションを自動的に参加締切状態にする設定を取得します。
- 戻り値
- ホストマイグレーション時にセッションを自動的に参加締切状態にする設定が返ります。
virtual bool nn::pia::inet::NexSessionInfo::IsOpened |
( |
| ) |
const |
|
virtual |
virtual bool nn::pia::inet::NexSessionInfo::IsRestrictedByUserPassword |
( |
| ) |
const |
|
virtual |
セッションにユーザーパスワードが設定されているかどうかを確認します。
- 戻り値
- ユーザーパスワードが設定されている場合は true が返ります。
代入演算子です。
- 引数
-
- 戻り値
- 本オブジェクトへの参照。
virtual void nn::pia::inet::NexSessionInfo::Trace |
( |
uint64_t |
flag | ) |
const |
|
virtual |