CTR-Pia
5.4.3
Game Communication Engine
|
TransportAnalyzer クラスは、パケット解析結果や RTT 、パケロス率などを 報告するために用意されたクラスです。 [詳細]
Public 型 | |
typedef void(* | AnalysisPrintCallback )(const char *pStr) |
トランスポート分析データのプリントコールバック型です。 | |
Public メソッド | |
struct TransportAnalysisData & | GetTransportAnalysisData () const |
データを取得します。 | |
AnalysisPrintCallback | RegisterPrintCallback (AnalysisPrintCallback pCallback) |
プリントコールバックを登録します。 | |
Result | SetMarker (const char *pComment) |
グラフに区切りをいれるための文字列をコンソールに出力します。 | |
void | Trace (uint64_t flag) const |
デバッグに有用な情報をプリントします。 | |
Result | Update () |
データを更新します。 | |
Static Public メソッド | |
static TransportAnalyzer * | GetInstance () |
TransportAnalyzer クラスのインスタンスを得ます(シングルトンパターン)。 事前に CreateInstance() によってインスタンスを作成していない場合は、 NULL ポインタが返されます。 この関数はスレッドセーフです。 | |
TransportAnalyzer クラスは、パケット解析結果や RTT 、パケロス率などを 報告するために用意されたクラスです。
typedef void(* nn::pia::transport::TransportAnalyzer::AnalysisPrintCallback)(const char *pStr) |
トランスポート分析データのプリントコールバック型です。
トランスポート分析データの出力文字列を独自定義の関数に渡したい場合に使用します。
[in] | pStr | トランスポート分析データのテキスト文字列が渡されます。改行文字は含まれません。 |
|
inlinestatic |
TransportAnalyzer クラスのインスタンスを得ます(シングルトンパターン)。 事前に CreateInstance() によってインスタンスを作成していない場合は、 NULL ポインタが返されます。 この関数はスレッドセーフです。
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 を呼びだし、 データの更新を行う必要があります。
ResultNotInitialized TransportAnalyzer インスタンスが未初期化です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
ResultInvalidState この関数を呼び出すタイミングが誤っています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。