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

Pia ライブラリ内部のメモリリークを自動検出するためのクラスです。 [詳細]

Public メソッド

 MemoryLeakChecker (void)
 コンストラクタです。
 
 ~MemoryLeakChecker (void)
 デストラクタです。
 
Result Check (void) const
 メモリリークが発生したかどうかの判定を行います。
 
Result Set (void)
 メモリリーク調査の起点をセットします。
 

説明

Pia ライブラリ内部のメモリリークを自動検出するためのクラスです。

関数

Result nn::pia::common::MemoryLeakChecker::Check ( void  ) const

メモリリークが発生したかどうかの判定を行います。

この API は、メモリリークを疑う Pia モジュールの終了処理を終えた後に 呼び出すことを想定しています。Pia は最上位のモジュールから順に 終了処理を実行していく設計となっておりますが、 仮に Pia の xxx モジュールを含む上位モジュールでのメモリリークを疑う場合、 nn::pia::xxx::Finalize() を呼び出した後にこの API を実行する必要があります。

このAPIは、各モジュールの BeginSetup()EndSetup() 間では 呼び出してはいけません。

戻り値
呼び出しが無事に完了し、メモリリークの疑いが無ければ、成功の Result が返されます。
返るエラーの一覧:

ResultMemoryLeak メモリリークの疑いがあります。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

ResultNotInitialized nn::pia::common::Initialize() が呼ばれていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

ResultInvalidState このAPIを呼び出すタイミングが誤っています。 nn::pia::common::EndSetup() の後で呼び出す必要があります。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

参照
Set
Result nn::pia::common::MemoryLeakChecker::Set ( void  )

メモリリーク調査の起点をセットします。

この API は、メモリリークを疑う Pia モジュールの初期化処理を開始する前に 呼び出すことを想定しています。Pia は最初に common モジュールを初期化し、 順に上位モジュールの初期化処理を実行していく設計となっておりますが、 仮に Pia の xxx モジュールを含む上位モジュールでのメモリリークを疑う場合、 nn::pia::xxx::Initialize() を呼び出す前にこの API を実行する必要があります。

この API は、各モジュールの BeginSetup()EndSetup() 間では 呼び出してはいけません。

戻り値
呼び出しが無事に完了すれば、成功の Result が返されます。
返るエラーの一覧:

ResultNotInitialized nn::pia::common::Initialize が呼ばれていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

ResultInvalidState このAPIを呼び出すタイミングが誤っています。 nn::pia::common::EndSetup() の後で呼び出す必要があります。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

参照
Check