nl::Weave::System::Timer

#include <src/system/SystemTimer.h>

Dies ist eine interne Klasse von Weave System Layer, die einen laufenden Timer mit einer Aufnahme darstellt.

Zusammenfassung

Für die Anwendungsebene ist keine echte öffentliche Schnittstelle verfügbar. Die statischen öffentlichen Methoden, die zum Abrufen der aktuellen Systemzeit verwendet werden, sind für den internen Gebrauch bestimmt.

Übernahme

Übernimmt von: nl::Weave::System::Object

Öffentliche Typen

Epoch typedef
uint64_t
Stellt eine Epoche in der lokalen Systemzeitskala dar, normalerweise die POSIX-Zeitskala.
OnCompleteFunct)(Layer *aLayer, void *aAppState, Error aError) typedef
void(*

Öffentliche Attribute

OnComplete
OnCompleteFunct

Öffentliche statische Funktionen

GetCurrentEpoch(void)
Diese Methode gibt die aktuelle Epoche zurück, korrigiert durch den System-Ruhemodus mit der Systemzeitskala in Millisekunden.
GetStatistics(nl::Weave::System::Stats::count_t & aNumInUse, nl::Weave::System::Stats::count_t & aHighWatermark)
void
IsEarlierEpoch(const Epoch & first, const Epoch & second)
bool
Vergleicht zwei Timer::Epoch-Werte und gibt „true“ zurück, wenn der erste Wert vor dem zweiten Wert liegt.

Öffentliche Funktionen

Cancel(void)
Error
Diese Methode deinitialisiert das Timer-Objekt und verhindert, dass dieser Timer ausgelöst wird, falls nicht bereits geschehen.
Start(uint32_t aDelayMilliseconds, OnCompleteFunct aOnComplete, void *aAppState)
Error
Diese Methode registriert einen einmaligen Timer mit dem zugrunde liegenden Timer-Mechanismus, der von der Plattform bereitgestellt wird.

Öffentliche Typen

Epoche

uint64_t Epoch

Stellt eine Epoche in der lokalen Systemzeitskala dar, normalerweise die POSIX-Zeitskala.

Die Einheiten sind abhängig vom Kontext. Bei Verwendung mit Werten, die von GetCurrentEpoch zurückgegeben werden, sind die Einheiten Millisekunden.

OnCompleteFunct

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

Öffentliche Attribute

OnComplete

OnCompleteFunct OnComplete

Öffentliche statische Funktionen

GetCurrentEpoch

Epoch GetCurrentEpoch(
  void
)

Diese Methode gibt die aktuelle Epoche zurück, korrigiert durch den System-Ruhemodus mit der Systemzeitskala in Millisekunden.

EINGESTELLT. Verwenden Sie stattdessen System::Layer::GetClock_MonotonicMS().

Details
Rückgabe
Ein Zeitstempel in Millisekunden.

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
)

Vergleicht zwei Timer::Epoch-Werte und gibt „true“ zurück, wenn der erste Wert vor dem zweiten Wert liegt.

Eine statische API, die aufgerufen wird, um zwei Zeitwerte zu vergleichen. Diese API versucht, die Timer-Wrapping-Funktion zu berücksichtigen, indem angenommen wird, dass die Differenz zwischen den beiden Eingabewerten nur mehr als die Hälfte des Epochenskalarbereichs beträgt, wenn zwischen den beiden Stichproben eine Timer-Wrapping-Funktion aufgetreten ist.

Details
Rückgabe
„true“, wenn der erste Parameter vor dem zweiten liegt, andernfalls „false“.

Öffentliche Funktionen

Abbrechen

Error Cancel(
  void
)

Diese Methode deinitialisiert das Timer-Objekt und verhindert, dass dieser Timer ausgelöst wird, falls nicht bereits geschehen.

Details
Rückgabewerte
WEAVE_SYSTEM_NO_ERROR
Bedingungslos.

Starten

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

Diese Methode registriert einen einmaligen Timer mit dem zugrunde liegenden Timer-Mechanismus, der von der Plattform bereitgestellt wird.

Details
Parameter
[in] aDelayMilliseconds
Die Anzahl der Millisekunden, bevor dieser Timer ausgelöst wird
[in] aOnComplete
Ein Zeiger auf die Callback-Funktion, wenn dieser Timer ausgelöst wird
[in] aAppState
Ein beliebiger Zeiger, der an onComplete übergeben wird, wenn dieser Timer ausgelöst wird
Rückgabewerte
WEAVE_SYSTEM_NO_ERROR
Bedingungslos.