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

セッションの情報へのインターフェースです。 [詳細]

+ nn::pia::session::ISessionInfoに対する継承グラフ

Public メソッド

virtual ~ISessionInfo ()
 デストラクタ
 
virtual void Clear ()=0
 セッション情報をクリアします。
 
virtual Result GetApplicationData (void *pBuffer, uint32_t size) const =0
 セッションのアプリケーション定義データを取得します。
 
virtual uint32_t GetApplicationDataSize () const =0
 セッションのアプリケーション定義データの長さを取得します。
 
virtual uint16_t GetCurrentParticipantNum () const =0
 セッションに参加している人数を取得します。
 
virtual uint32_t GetGameMode () const =0
 セッションのゲームモードを取得します。
 
virtual uint16_t GetMaxParticipantNum () const =0
 セッションに参加できる最大人数を取得します。
 
virtual uint16_t GetMinParticipantNum () const =0
 セッションに参加できる最小人数を取得します。
 
virtual uint32_t GetSessionId () const =0
 セッションの ID を取得します。
 
virtual bool IsOpened () const =0
 セッションが参加募集受付状態かどうかを取得します。
 
virtual void Trace (uint64_t flag) const =0
 デバッグに有用な情報をプリントします。
 

説明

セッションの情報へのインターフェースです。

関数

virtual Result nn::pia::session::ISessionInfo::GetApplicationData ( void *  pBuffer,
uint32_t  size 
) const
pure virtual

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

セッションに設定したアプリケーション定義データを取得します。

引数
[out]pBufferセッションのアプリケーション定義データのコピー用バッファのポインタ。
[in]sizeセッションのアプリケーション定義データのコピー用バッファのサイズ。
戻り値
正常に情報を取得できた場合、成功の Result が返ります。
返るエラーの一覧:

ResultInvalidArgument バッファが NULL ポインタです。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

ResultInvalidState アプリケーション定義データが設定されていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

ResultBufferShortage 設定されているアプリケーション定義データのサイズがバッファのサイズよりも大きいため、コピーできません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

nn::pia::local::UdsSessionInfo, nn::pia::inet::NexSessionInfo, nn::pia::lan::LanSessionInfo, と nn::pia::local::LocalSessionInfoで実装されています。

virtual uint32_t nn::pia::session::ISessionInfo::GetApplicationDataSize ( ) const
pure virtual

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

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

nn::pia::local::UdsSessionInfo, nn::pia::inet::NexSessionInfo, nn::pia::lan::LanSessionInfo, と nn::pia::local::LocalSessionInfoで実装されています。

virtual uint16_t nn::pia::session::ISessionInfo::GetCurrentParticipantNum ( ) const
pure virtual

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

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

nn::pia::local::UdsSessionInfo, nn::pia::inet::NexSessionInfo, nn::pia::local::LocalSessionInfo, と nn::pia::lan::LanSessionInfoで実装されています。

virtual uint32_t nn::pia::session::ISessionInfo::GetGameMode ( ) const
pure virtual

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

インターネット通信時はゲームモードの値を返します。
ローカル通信時は通信モード識別用 ID を uint32_t にキャストして返します。

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

nn::pia::local::UdsSessionInfo, nn::pia::inet::NexSessionInfo, nn::pia::local::LocalSessionInfo, と nn::pia::lan::LanSessionInfoで実装されています。

virtual uint16_t nn::pia::session::ISessionInfo::GetMaxParticipantNum ( ) const
pure virtual

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

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

nn::pia::local::UdsSessionInfo, nn::pia::inet::NexSessionInfo, nn::pia::local::LocalSessionInfo, と nn::pia::lan::LanSessionInfoで実装されています。

virtual uint16_t nn::pia::session::ISessionInfo::GetMinParticipantNum ( ) const
pure virtual

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

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

nn::pia::inet::NexSessionInfo, nn::pia::local::LocalSessionInfo, と nn::pia::lan::LanSessionInfoで実装されています。

virtual uint32_t nn::pia::session::ISessionInfo::GetSessionId ( ) const
pure virtual

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

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

nn::pia::local::UdsSessionInfo, nn::pia::inet::NexSessionInfo, nn::pia::local::LocalSessionInfo, と nn::pia::lan::LanSessionInfoで実装されています。

virtual bool nn::pia::session::ISessionInfo::IsOpened ( ) const
pure virtual

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

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

nn::pia::local::UdsSessionInfo, nn::pia::inet::NexSessionInfo, nn::pia::local::LocalSessionInfo, と nn::pia::lan::LanSessionInfoで実装されています。

virtual void nn::pia::session::ISessionInfo::Trace ( uint64_t  flag) const
pure virtual

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

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

nn::pia::inet::NexSessionInfo, nn::pia::lan::LanSessionInfo, nn::pia::local::UdsSessionInfo, と nn::pia::local::LocalSessionInfoで実装されています。