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

TransportAnalyzer クラスは、パケット解析結果や RTT 、パケロス率などを 報告するために用意されたクラスです。 [詳細]

+ nn::pia::transport::TransportAnalyzerに対する継承グラフ

Public 型

typedef void(* AnalysisPrintCallback )(const char *pStr)
 トランスポート分析データのプリントコールバック型です。
 

Public メソッド

struct TransportAnalysisDataGetTransportAnalysisData () const
 データを取得します。
 
AnalysisPrintCallback RegisterPrintCallback (AnalysisPrintCallback pCallback)
 プリントコールバックを登録します。
 
Result SetMarker (const char *pComment)
 グラフに区切りをいれるための文字列をコンソールに出力します。
 
void Trace (uint64_t flag) const
 デバッグに有用な情報をプリントします。
 
Result Update ()
 データを更新します。
 

Static Public メソッド

static TransportAnalyzerGetInstance ()
 TransportAnalyzer クラスのインスタンスを得ます(シングルトンパターン)。 事前に CreateInstance() によってインスタンスを作成していない場合は、 NULL ポインタが返されます。 この関数はスレッドセーフです。
 

説明

TransportAnalyzer クラスは、パケット解析結果や RTT 、パケロス率などを 報告するために用意されたクラスです。

型定義

typedef void(* nn::pia::transport::TransportAnalyzer::AnalysisPrintCallback)(const char *pStr)

トランスポート分析データのプリントコールバック型です。

トランスポート分析データの出力文字列を独自定義の関数に渡したい場合に使用します。

引数
[in]pStrトランスポート分析データのテキスト文字列が渡されます。改行文字は含まれません。

関数

static TransportAnalyzer* nn::pia::transport::TransportAnalyzer::GetInstance ( void  )
inlinestatic

TransportAnalyzer クラスのインスタンスを得ます(シングルトンパターン)。 事前に CreateInstance() によってインスタンスを作成していない場合は、 NULL ポインタが返されます。 この関数はスレッドセーフです。

戻り値
TransportAnalyzer インスタンスへのポインタ。
参照
CreateInstance, DestroyInstance
AnalysisPrintCallback nn::pia::transport::TransportAnalyzer::RegisterPrintCallback ( AnalysisPrintCallback  pCallback)

プリントコールバックを登録します。

引数
[in]pCallback登録するコールバック関数ポインタ。
戻り値
この関数を呼び出す前に登録されていたプリントコールバックが返されます。
Result nn::pia::transport::TransportAnalyzer::SetMarker ( const char *  pComment)

グラフに区切りをいれるための文字列をコンソールに出力します。

引数
[in]pComment区切り線に付ける名前の文字列を指すポインタ。文字列に空白類文字を含めることはできません。また、NULL を指定することもできません。
返るエラーの一覧:

ResultInvalidArgument 引数が誤っています。NULL ポインタや、空白類文字を含む文字列を与えることはできません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

ResultInvalidState この関数を呼び出すタイミングが誤っています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

void nn::pia::transport::TransportAnalyzer::Trace ( uint64_t  flag) const

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

引数
[in]flagトレースフラグの論理和。詳細は TraceFlag 型を参照してください。
Result nn::pia::transport::TransportAnalyzer::Update ( )

データを更新します。

Transport::Setting 構造体の analysisInterval メンバ変数に正の値をセットして、 分析データの自動プリントを有効にした状態であれば、アプリケーションはこの API を 呼び出す必要はありません。 analysisInterval メンバ変数に 0 の値をセットし、自動プリント機能を無効にした 状態でアプリケーションが分析データを取得する際は、明示的にこの API を呼びだし、 データの更新を行う必要があります。

戻り値
処理が成功すれば、IsSuccess() が true となる Result が返されます。この関数がエラーを返さないようにアプリケーションを実装する必要があります。
返るエラーの一覧:

ResultNotInitialized TransportAnalyzer インスタンスが未初期化です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

ResultInvalidState この関数を呼び出すタイミングが誤っています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。