nl::Weave::System::Timer

#include <src/system/SystemTimer.h>

これは Weave システムレイヤの内部クラスで、進行中のワンショットタイマーを表すために使用されます。

概要

アプリケーションレイヤで使用できる実際の公開インターフェースはありません。現在のシステム時刻を取得するために使用される静的パブリックメソッドは、内部使用を目的としています。

公開タイプ
`Epoch`	typedef `uint64_t` ローカルシステムのタイムスケール（通常は POSIX タイムスケール）でエポックを表します。
`OnCompleteFunct)(Layer aLayer, void aAppState, Error aError)`	typedef `void(*`

パブリック属性
`OnComplete`	`OnCompleteFunct`

静的パブリック関数
`GetCurrentEpoch(void)`	`Epoch` このメソッドは、システムタイムスケールでシステムスリープによって修正された現在のエポックをミリ秒単位で返します。
`GetStatistics(nl::Weave::System::Stats::count_t & aNumInUse, nl::Weave::System::Stats::count_t & aHighWatermark)`	`void`
`IsEarlierEpoch(const Epoch & first, const Epoch & second)`	`bool` 2 つの Timer::Epoch 値を比較し、最初の値が 2 番目の値よりも前の場合に true を返します。

パブリック関数
`Cancel(void)`	`Error` このメソッドは、タイマーオブジェクトの初期化を解除し、このタイマーがまだ起動していない場合には起動しないようにします。
`Start(uint32_t aDelayMilliseconds, OnCompleteFunct aOnComplete, void *aAppState)`	`Error` このメソッドは、プラットフォームが提供する基本タイマーメカニズムを使用してワンショットタイマーを登録します。

uint64_t Epoch

ローカルシステムのタイムスケール（通常は POSIX タイムスケール）でエポックを表します。

単位はコンテキストに依存します。GetCurrentEpoch から返される値で使用する場合、単位はミリ秒です。

void(* OnCompleteFunct)(Layer *aLayer, void *aAppState, Error aError)

OnCompleteFunct OnComplete

Epoch GetCurrentEpoch(
  void
)

このメソッドは、システムタイムスケールでシステムスリープによって修正された現在のエポックをミリ秒単位で返します。

非推奨: 代わりに System::Layer::GetClock_MonotonicMS() を使用してください。

詳細
戻り値	ミリ秒単位のタイムスタンプ。

void GetStatistics(
  nl::Weave::System::Stats::count_t & aNumInUse,
  nl::Weave::System::Stats::count_t & aHighWatermark
)

bool IsEarlierEpoch(
  const Epoch & first,
  const Epoch & second
)

2 つの Timer::Epoch 値を比較し、最初の値が 2 番目の値よりも前の場合に true を返します。

2 つの時間値を比較するために呼び出される静的 API。この API は、2 つのサンプル間でタイマーラップが発生した場合、2 つの入力値の差がエポックスカラー範囲の半分を超えるだけであると仮定して、タイマーラップを考慮しようとします。

詳細
戻り値	最初のパラメータが 2 番目のパラメータが前の場合は true、そうでない場合は false。

Error Cancel(
  void
)

このメソッドは、タイマーオブジェクトの初期化を解除し、このタイマーがまだ起動していない場合には起動しないようにします。

詳細

戻り値

WEAVE_SYSTEM_NO_ERROR

無条件に

Error Start(
  uint32_t aDelayMilliseconds,
  OnCompleteFunct aOnComplete,
  void *aAppState
)

このメソッドは、プラットフォームが提供する基本タイマーメカニズムを使用してワンショットタイマーを登録します。

詳細

パラメータ

`[in] aDelayMilliseconds`	このタイマーが起動するまでの時間（ミリ秒）。
`[in] aOnComplete`	このタイマー起動時のコールバック関数へのポインタ
`[in] aAppState`	このタイマーが開始されたときに onComplete に渡される任意のポインタ

戻り値

WEAVE_SYSTEM_NO_ERROR

無条件に