LAN マッチメイクのセッション情報クラスです。
[詳細]
LAN マッチメイクのセッション情報クラスです。
- 参照
- session::ISessionInfo
nn::pia::lan::LanSessionInfo::LanSessionInfo |
( |
const LanSessionInfo & |
rhs | ) |
|
virtual void nn::pia::lan::LanSessionInfo::Copy |
( |
const LanSessionInfo & |
rhs | ) |
|
|
virtual |
virtual Result nn::pia::lan::LanSessionInfo::GetApplicationData |
( |
void * |
pBuffer, |
|
|
uint32_t |
size |
|
) |
| const |
|
virtual |
セッションのアプリケーション定義データを取得します。
セッションに設定したアプリケーション定義データを取得します。
- 引数
-
[out] | pBuffer | セッションのアプリケーション定義データのコピー用バッファのポインタ。 |
[in] | size | セッションのアプリケーション定義データのコピー用バッファのサイズ。アプリケーション定義データの最大長は LanApplicationDataBufferSizeMax です。 |
- 戻り値
- 正常に情報を取得できた場合、成功の Result が返ります。
- 返るエラーの一覧:
ResultInvalidArgument バッファが NULL ポインタです。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
ResultInvalidState アプリケーション定義データが設定されていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
ResultBufferShortage 設定されているアプリケーション定義データのサイズがバッファのサイズよりも大きいため、コピーできません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
nn::pia::session::ISessionInfoを実装しています。
virtual uint32_t nn::pia::lan::LanSessionInfo::GetApplicationDataSize |
( |
| ) |
const |
|
virtual |
virtual Result nn::pia::lan::LanSessionInfo::GetAttribute |
( |
uint8_t |
idx, |
|
|
uint32_t * |
pAttribute |
|
) |
| const |
|
virtual |
セッションの属性を取得します。
- 引数
-
[in] | idx | 取得する属性のインデックス。LanAttributeSizeMax 以下である必要があります。 |
[out] | pAttribute | 指定されたインデックスのセッションの属性格納先のポインタ。 |
- 戻り値
- 正常に情報を取得できた場合、成功の Result が返ります。
- 返るエラーの一覧:
- ResultInvalidArgument 引数が不正です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
virtual uint16_t nn::pia::lan::LanSessionInfo::GetCurrentParticipantNum |
( |
| ) |
const |
|
virtual |
virtual uint32_t nn::pia::lan::LanSessionInfo::GetGameMode |
( |
| ) |
const |
|
virtual |
virtual PrincipalId nn::pia::lan::LanSessionInfo::GetHostPrincipalId |
( |
| ) |
const |
|
virtual |
セッションのホストのプリンシパル ID を取得します。
- 戻り値
- セッションのホストのプリンシパル ID が返ります。
virtual uint8_t nn::pia::lan::LanSessionInfo::GetLocalCommunicationVersion |
( |
| ) |
const |
|
virtual |
セッションの通信バージョンを取得します。
- 戻り値
- セッションの通信バージョンを返します。
virtual uint16_t nn::pia::lan::LanSessionInfo::GetMaxParticipantNum |
( |
| ) |
const |
|
virtual |
virtual uint16_t nn::pia::lan::LanSessionInfo::GetMinParticipantNum |
( |
| ) |
const |
|
virtual |
virtual uint32_t nn::pia::lan::LanSessionInfo::GetSessionId |
( |
| ) |
const |
|
virtual |
virtual Result nn::pia::lan::LanSessionInfo::GetSessionStationInfo |
( |
LanStationInfo * |
pSessoinStationInfoList, |
|
|
uint32_t |
sessionStationInfoListSize |
|
) |
| |
|
virtual |
セッションに参加中のステーション情報を取得します。
- 引数
-
[out] | pSessoinStationInfoList | ステーション情報リスト格納先のポインタ。 |
[in] | sessionStationInfoListSize | ステーション情報リスト格納先のサイズ。参加中のステーション数以上である必要があります。 |
- 戻り値
- 正常に情報を取得できた場合、成功の Result が返ります。
- 返るエラーの一覧:
ResultInvalidArgument 引数が不正です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
ResultInvalidState データを取得できる状態ではありません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
ResultBufferShortage ステーション情報のサイズがステーション情報格納先のサイズよりも大きいため、コピーできません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
virtual uint32_t nn::pia::lan::LanSessionInfo::GetSessionStationInfoSize |
( |
| ) |
const |
|
virtual |
セッションに参加中のステーション情報のサイズを取得します。
- 戻り値
- セッションに参加中のステーション情報のサイズを返します。
virtual LanSessionType nn::pia::lan::LanSessionInfo::GetSessionType |
( |
| ) |
const |
|
virtual |
セッションタイプを取得します。
- 戻り値
- 設定されているセッションタイプが返ります。
virtual bool nn::pia::lan::LanSessionInfo::IsOpened |
( |
| ) |
const |
|
virtual |
代入演算子です。
- 引数
-
- 戻り値
- 本オブジェクトへの参照。
virtual void nn::pia::lan::LanSessionInfo::Trace |
( |
uint64_t |
flag | ) |
const |
|
virtual |