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

ジョブのスケジューラです。 [詳細]

+ nn::pia::common::Schedulerに対する継承グラフ

Public メソッド

void Dispatch (uint32_t timeout=0)
 ジョブをディスパッチします。
 
virtual void Trace (uint64_t flag) const
 デバッグに有用な情報をプリントします。
 

Static Public メソッド

static Result CreateInstance (int32_t backgroundThreadPriority=DefaultBackgroundThreadPriority)
 インスタンスを作成します(シングルトンパターン)。
 
static void DestroyInstance ()
 インスタンスを破棄します(シングルトンパターン)。
 
static SchedulerGetInstance ()
 Scheduler インスタンスへのポインタを取得します(シングルトンパターン)。
 

Static Public 変数

static const int32_t DefaultBackgroundThreadPriority = 24
 バックグラウンドスケジューラ用スレッドの優先度のデフォルト値です。
 

説明

ジョブのスケジューラです。

スケジューラは、ジョブのクラスで定義されている処理を非同期に 実行するためのオブジェクトです。 なお、このクラスはスレッドセーフではありません。

関数

static Result nn::pia::common::Scheduler::CreateInstance ( int32_t  backgroundThreadPriority = DefaultBackgroundThreadPriority)
static

インスタンスを作成します(シングルトンパターン)。

このAPIは、 nn::pia::common::BeginSetup() を呼び出してから、 nn::pia::common::EndSetup() を呼び出すまでの間に呼び出す必要があります。

引数
[in]backgroundThreadPriorityバックグラウンドスケジューラ用スレッドの優先度です。 Pia の各 API を呼び出すスレッドより低い優先度を指定する必要があります。
戻り値
インスタンスの作成に成功すれば、成功の Result が返されます。この関数がエラーを返さないようにアプリケーションを実装する必要があります。
返るエラーの一覧:

ResultAlreadyExists 既にインスタンスは作成されています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

ResultNotInitialized commonモジュールが初期化されていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

ResultInvalidState BeginSetup()EndSetup() 間で呼び出されていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

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

static void nn::pia::common::Scheduler::DestroyInstance ( )
static

インスタンスを破棄します(シングルトンパターン)。

インスタンスが作成されていないときにこの関数が呼び出された場合は、 何も実行せずに関数から返ります。

void nn::pia::common::Scheduler::Dispatch ( uint32_t  timeout = 0)

ジョブをディスパッチします。

この関数を呼び出すことでジョブが実行されます。

引数
[in]timeoutジョブ実行の上限となる、タイムアウト時間を指定します。単位はミリ秒です。 ただし、必ずこのタイムアウト時間以下に収まることを保証するものではありません。 ゼロを与えると、無制限の時間を指定したと解釈されます。
static Scheduler* nn::pia::common::Scheduler::GetInstance ( )
inlinestatic

Scheduler インスタンスへのポインタを取得します(シングルトンパターン)。

戻り値
インスタンスが作成されていないときは、 NULL ポインタが返ります。
virtual void nn::pia::common::Scheduler::Trace ( uint64_t  flag) const
virtual

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

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