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

インターネット通信のセッション情報クラスです。 [詳細]

+ nn::pia::inet::NexSessionInfoに対する継承グラフ

Public メソッド

 NexSessionInfo (const NexSessionInfo &rhs)
 コピーコンストラクタ。
 
virtual void Clear ()
 セッション情報をクリアします。
 
void Copy (const NexSessionInfo &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 uint32_t GetCommunityId () const
 セッションに関連付けられているコミュニティの ID を取得します。
 
virtual uint16_t GetCurrentParticipantNum () const
 セッションに参加している人数を取得します。
 
virtual uint32_t GetGameMode () const
 セッションのゲームモードを取得します。
 
virtual PrincipalId GetHostPrincipalId () const
 セッションのホストのプリンシパル ID を取得します。
 
virtual uint16_t GetMaxParticipantNum () const
 セッションに参加できる最大人数を取得します。
 
virtual uint16_t GetMinParticipantNum () const
 セッションに参加できる最小人数を取得します。
 
virtual uint8_t GetSelectionPriority () const
 セッションのマッチメイクの優先度を取得します。
 
virtual uint32_t GetSessionId () const
 セッションの ID を取得します。
 
virtual SessionType GetSessionType () const
 セッションタイプを取得します。
 
virtual const common::DateTimeGetStartedTime () const
 セッションが開始された時刻を取得します。
 
virtual PrincipalId GetTargetPrincipalId () const
 セッションの検索条件に指定したプリンシパル ID を取得します。
 
virtual bool IsAutoCloseSession () const
 ホストマイグレーション時にセッションを自動的に参加締切状態にする設定を取得します。
 
virtual bool IsOpened () const
 セッションが参加募集受付状態かどうかを取得します。
 
virtual bool IsRestrictedByUserPassword () const
 セッションにユーザーパスワードが設定されているかどうかを確認します。
 
NexSessionInfooperator= (const NexSessionInfo &rhs)
 代入演算子です。
 
virtual void Trace (uint64_t flag) const
 デバッグに有用な情報をプリントします。
 

説明

インターネット通信のセッション情報クラスです。

参照
session::ISessionInfo

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

nn::pia::inet::NexSessionInfo::NexSessionInfo ( const NexSessionInfo rhs)

コピーコンストラクタ。

引数
[in]rhsコピーするセッション情報

関数

void nn::pia::inet::NexSessionInfo::Copy ( const NexSessionInfo rhs)

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

引数
[in]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

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

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

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

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

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

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

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

virtual uint32_t nn::pia::inet::NexSessionInfo::GetGameMode ( ) const
virtual

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

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

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

virtual PrincipalId nn::pia::inet::NexSessionInfo::GetHostPrincipalId ( ) const
virtual

セッションのホストのプリンシパル ID を取得します。

戻り値
セッションのホストのプリンシパル ID が返ります。
virtual uint16_t nn::pia::inet::NexSessionInfo::GetMaxParticipantNum ( ) const
virtual

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

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

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

virtual uint16_t nn::pia::inet::NexSessionInfo::GetMinParticipantNum ( ) const
virtual

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

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

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

virtual uint8_t nn::pia::inet::NexSessionInfo::GetSelectionPriority ( ) const
virtual

セッションのマッチメイクの優先度を取得します。

戻り値
セッションのマッチメイクの優先度が返ります。
virtual uint32_t nn::pia::inet::NexSessionInfo::GetSessionId ( ) const
virtual

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

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

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

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

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

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

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

virtual bool nn::pia::inet::NexSessionInfo::IsRestrictedByUserPassword ( ) const
virtual

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

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

代入演算子です。

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

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

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

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