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

ローカル通信のセッション情報クラスです。 [詳細]

+ nn::pia::local::UdsSessionInfoに対する継承グラフ

Public メソッド

 UdsSessionInfo (const UdsSessionInfo &rhs)
 コピーコンストラクタ。。
 
virtual void Clear ()
 セッション情報をクリアします。
 
void Copy (const UdsSessionInfo &rhs)
 セッション情報をコピーします。
 
virtual Result GetApplicationData (void *pBuffer, uint32_t size) const
 セッションのアプリケーション定義データを取得します。
 
virtual uint32_t GetApplicationDataSize () const
 セッションのアプリケーション定義データの長さを取得します。
 
virtual Result GetBssid (uint8_t *pBssidBuffer, uint32_t size) const
 BSSID(ホストの MAC アドレス)を取得します。
 
virtual uint16_t GetCurrentParticipantNum () const
 セッションに参加している人数を取得します。
 
virtual uint32_t GetGameMode () const
 セッションのゲームモードを取得します。
 
virtual uint16_t GetMaxParticipantNum () const
 セッションに参加できる最大人数を取得します。
 
virtual uint16_t GetMinParticipantNum () const
 セッションに参加できる最小人数を取得します。
 
virtual uint8_t GetRadioStrength () const
 セッションの電波強度を取得します。
 
virtual uint32_t GetSessionId () const
 セッションの ID を取得します。
 
virtual Result GetSessionStationInfo (LocalStationInfo *pSessionStationInfo, uint32_t sessionStationInfoListSize) const
 セッションに参加中のステーション情報を取得します。
 
virtual bool IsOpened () const
 セッションが参加募集受付状態かどうかを取得します。
 
virtual bool IsRestrictedByUserPassword () const
 セッションにユーザーパスワードが設定されているかどうかを確認します。
 
UdsSessionInfooperator= (const UdsSessionInfo &rhs)
 代入演算子です。
 
virtual void Trace (uint64_t flag) const
 デバッグに有用な情報をプリントします。
 

説明

ローカル通信のセッション情報クラスです。

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

nn::pia::local::UdsSessionInfo::UdsSessionInfo ( const UdsSessionInfo rhs)

コピーコンストラクタ。。

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

関数

void nn::pia::local::UdsSessionInfo::Copy ( const UdsSessionInfo rhs)

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

アプリケーションでセッション情報を保持したい際に使用します。

引数
[in]rhsコピーするセッション情報
virtual Result nn::pia::local::UdsSessionInfo::GetApplicationData ( void *  pBuffer,
uint32_t  size 
) const
virtual

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

アプリケーションが設定したビーコンデータを取得します。

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

ResultInvalidArgument 引数が不正です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

ResultInvalidState データを取得できる状態ではありません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

nn::pia::local::LocalSessionInfoを実装しています。

virtual uint32_t nn::pia::local::UdsSessionInfo::GetApplicationDataSize ( ) const
virtual

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

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

nn::pia::local::LocalSessionInfoを実装しています。

virtual Result nn::pia::local::UdsSessionInfo::GetBssid ( uint8_t *  pBssidBuffer,
uint32_t  size 
) const
virtual

BSSID(ホストの MAC アドレス)を取得します。

BSSID のサイズは nn::uds::MAC_ADDRESS_SIZE バイトです。引数には、このサイズのバッファを設定する必要があります。

引数
[out]pBssidBufferBSSID を格納するためのバッファ。サイズが nn::uds::MAC_ADDRESS_SIZE バイトである必要があります。
[in]sizeBSSID を格納するためのバッファサイズ
戻り値
正常に情報を取得できた場合、成功の Result が返ります。
返るエラーの一覧:
ResultInvalidArgument 引数が不正です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

nn::pia::local::LocalSessionInfoを実装しています。

virtual uint16_t nn::pia::local::UdsSessionInfo::GetCurrentParticipantNum ( ) const
virtual

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

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

nn::pia::local::LocalSessionInfoを実装しています。

virtual uint32_t nn::pia::local::UdsSessionInfo::GetGameMode ( ) const
virtual

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

通信モード識別用 ID を uint32_t にキャストして返します。

戻り値
ゲームモードを返します。

nn::pia::local::LocalSessionInfoを実装しています。

virtual uint16_t nn::pia::local::UdsSessionInfo::GetMaxParticipantNum ( ) const
virtual

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

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

nn::pia::local::LocalSessionInfoを実装しています。

virtual uint16_t nn::pia::local::LocalSessionInfo::GetMinParticipantNum ( ) const
virtualinherited

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

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

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

virtual uint8_t nn::pia::local::LocalSessionInfo::GetRadioStrength ( ) const
virtualinherited

セッションの電波強度を取得します。

戻り値
セッションの電波強度が返ります。
virtual uint32_t nn::pia::local::UdsSessionInfo::GetSessionId ( ) const
virtual

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

同じセッション ID を持つ異なるセッションが存在する場合があります。

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

nn::pia::local::LocalSessionInfoを実装しています。

virtual Result nn::pia::local::UdsSessionInfo::GetSessionStationInfo ( LocalStationInfo pSessionStationInfo,
uint32_t  sessionStationInfoListSize 
) const
virtual

セッションに参加中のステーション情報を取得します。

引数
[out]pSessionStationInfoステーション情報格納先のポインタ。
[in]sessionStationInfoListSizeステーション情報リスト格納先のサイズ。参加中のステーション数以上である必要があります。
戻り値
正常に情報を取得できた場合、成功の Result が返ります。
返るエラーの一覧:

ResultInvalidArgument 引数が不正です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

ResultBufferShortage ステーション情報のサイズがステーション情報格納先のサイズよりも大きいため、コピーできません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

nn::pia::local::LocalSessionInfoを実装しています。

virtual bool nn::pia::local::UdsSessionInfo::IsOpened ( ) const
virtual

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

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

nn::pia::local::LocalSessionInfoを実装しています。

virtual bool nn::pia::local::LocalSessionInfo::IsRestrictedByUserPassword ( ) const
virtualinherited

セッションにユーザーパスワードが設定されているかどうかを確認します。

戻り値
ユーザーパスワードが設定されている場合は true が返ります。
UdsSessionInfo& nn::pia::local::UdsSessionInfo::operator= ( const UdsSessionInfo rhs)

代入演算子です。

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

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

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

nn::pia::local::LocalSessionInfoを再定義しています。