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

LAN マッチメイクのセッション情報クラスです。 [詳細]

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

Public メソッド

 LanSessionInfo (const LanSessionInfo &rhs)
 コピーコンストラクタ。
 
virtual void Clear ()
 セッション情報をクリアします。
 
virtual void Copy (const LanSessionInfo &rhs)
 セッション情報をコピーします。
 
virtual Result GetApplicationData (void *pBuffer, uint32_t size) const
 セッションのアプリケーション定義データを取得します。
 
virtual uint32_t GetApplicationDataSize () const
 セッションのアプリケーション定義データの長さを取得します。
 
virtual Result GetAttribute (uint8_t idx, uint32_t *pAttribute) const
 セッションの属性を取得します。
 
virtual uint16_t GetCurrentParticipantNum () const
 セッションに参加している人数を取得します。
 
virtual uint32_t GetGameMode () const
 セッションのゲームモードを取得します。
 
virtual PrincipalId GetHostPrincipalId () const
 セッションのホストのプリンシパル ID を取得します。
 
virtual uint8_t GetLocalCommunicationVersion () const
 セッションの通信バージョンを取得します。
 
virtual uint16_t GetMaxParticipantNum () const
 セッションに参加できる最大人数を取得します。
 
virtual uint16_t GetMinParticipantNum () const
 セッションに参加できる最小人数を取得します。
 
virtual uint32_t GetSessionId () const
 セッションの ID を取得します。
 
virtual Result GetSessionStationInfo (LanStationInfo *pSessoinStationInfoList, uint32_t sessionStationInfoListSize)
 セッションに参加中のステーション情報を取得します。
 
virtual uint32_t GetSessionStationInfoSize () const
 セッションに参加中のステーション情報のサイズを取得します。
 
virtual LanSessionType GetSessionType () const
 セッションタイプを取得します。
 
virtual bool IsOpened () const
 セッションが参加募集受付状態かどうかを取得します。
 
LanSessionInfooperator= (const LanSessionInfo &rhs)
 代入演算子です。
 
virtual void Trace (uint64_t flag) const
 デバッグに有用な情報をプリントします。
 

説明

LAN マッチメイクのセッション情報クラスです。

参照
session::ISessionInfo

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

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

コピーコンストラクタ。

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

関数

virtual void nn::pia::lan::LanSessionInfo::Copy ( const LanSessionInfo rhs)
virtual

セッション情報をコピーします。

引数
[in]rhsコピーするセッション情報
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

セッションのアプリケーション定義データの長さを取得します。

戻り値
セッションのアプリケーション定義データの長さが返ります。

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

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

セッションに参加している人数を取得します。

戻り値
セッションに参加している人数を返します。

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

virtual uint32_t nn::pia::lan::LanSessionInfo::GetGameMode ( ) const
virtual

セッションのゲームモードを取得します。

戻り値
セッションのゲームモードを返します。

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

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

セッションに参加できる最大人数を取得します。

戻り値
セッションに参加できる最大人数を返します。

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

virtual uint16_t nn::pia::lan::LanSessionInfo::GetMinParticipantNum ( ) const
virtual

セッションに参加できる最小人数を取得します。

戻り値
セッションに参加できる最小人数を返します。

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

virtual uint32_t nn::pia::lan::LanSessionInfo::GetSessionId ( ) const
virtual

セッションの ID を取得します。

戻り値
セッションの ID を返します。

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

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

セッションが参加募集受付状態かどうかを取得します。

戻り値
セッションが参加募集受付状態なら true, 参加募集締切状態なら false を返します。

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

LanSessionInfo& nn::pia::lan::LanSessionInfo::operator= ( const LanSessionInfo rhs)

代入演算子です。

引数
[in]rhs代入するオブジェクトです。
戻り値
本オブジェクトへの参照。
virtual void nn::pia::lan::LanSessionInfo::Trace ( uint64_t  flag) const
virtual

デバッグに有用な情報をプリントします。

引数
[in]flagトレースフラグの論理和。詳細は TraceFlag 型を参照してください。

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