nl::Weave::System::Timer

#include <src/system/SystemTimer.h>

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

概要

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

継承

継承元: nl::Weave::System::Object

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

パブリック属性
OnComplete
OnCompleteFunct

静的パブリック関数
GetCurrentEpoch(void)
このメソッドは、システム タイムスケールでシステムのスリープによって修正された現在のエポックをミリ秒単位で返します。
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 値を比較し、1 つ目の値が 2 つ目の値より前である場合は true を返します。

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

パブリック タイプ

エポック

uint64_t Epoch

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

単位はコンテキストによって異なります。GetCurrentEpoch によって返される値とともに使用する場合、単位はミリ秒です。

OnCompleteFunct

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

パブリック属性

OnComplete

OnCompleteFunct OnComplete

静的パブリック関数

GetCurrentEpoch

Epoch GetCurrentEpoch(
  void
)

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

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

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

GetStatistics

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

IsEarlierEpoch

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

2 つの Timer::Epoch 値を比較し、1 つ目の値が 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
無条件に。