nl::Weave::System::Timer

#include <src/system/SystemTimer.h>

Il s'agit d'une classe interne au Layer du système Weave, utilisée pour représenter un minuteur one-shot en cours.

Résumé

Il n'existe pas de véritable interface publique disponible pour la couche application. Les méthodes publiques statiques permettant d'obtenir l'heure système actuelle sont destinées à un usage interne.

Héritage

Hérite de: nl::Weave::System::Object

Types publics

Epoch typedef
uint64_t
Représente une époque dans l'échelle de temps du système local, généralement l'échelle de temps POSIX.
OnCompleteFunct)(Layer *aLayer, void *aAppState, Error aError) typedef
void(*

Attributs publics

OnComplete
OnCompleteFunct

Fonctions statiques publiques

GetCurrentEpoch(void)
Cette méthode renvoie l'epoch actuelle, corrigée par la veille du système avec l'échelle de temps du système, en millisecondes.
GetStatistics(nl::Weave::System::Stats::count_t & aNumInUse, nl::Weave::System::Stats::count_t & aHighWatermark)
void
IsEarlierEpoch(const Epoch & first, const Epoch & second)
bool
Compare deux valeurs Minuteur::Epoch et renvoie "true" si la première valeur est antérieure à la seconde.

Fonctions publiques

Cancel(void)
Error
Cette méthode initialise l'objet minuteur et empêche le minuteur de se déclencher s'il ne l'a pas déjà fait.
Start(uint32_t aDelayMilliseconds, OnCompleteFunct aOnComplete, void *aAppState)
Error
Cette méthode enregistre un minuteur one-shot avec le mécanisme de minuteur sous-jacent fourni par la plate-forme.

Types publics

Époque

uint64_t Epoch

Représente une époque dans l'échelle de temps du système local, généralement l'échelle de temps POSIX.

Les unités dépendent du contexte. Si elle est utilisée avec des valeurs renvoyées par GetCurrentEpoch, les unités sont les millisecondes.

OnCompleteFunct

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

Attributs publics

OnComplete

OnCompleteFunct OnComplete

Fonctions statiques publiques

GetCurrentEpoch

Epoch GetCurrentEpoch(
  void
)

Cette méthode renvoie l'epoch actuelle, corrigée par la veille du système avec l'échelle de temps du système, en millisecondes.

OBSOLÈTE Veuillez utiliser System::Layer::GetClock_MonotonicMS() à la place.

Détails
Renvoie
Code temporel en millisecondes.

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
)

Compare deux valeurs Minuteur::Epoch et renvoie "true" si la première valeur est antérieure à la seconde.

API statique appelée pour comparer deux valeurs temporelles Cette API tente de tenir compte du retour automatique à la ligne en supposant que la différence entre les deux valeurs d'entrée ne sera que plus de la moitié de la plage scalaire epoch si un retour automatique à la ligne s'est produit entre les deux échantillons.

Détails
Renvoie
La valeur est "true" si le premier paramètre est antérieur au second. Sinon, la valeur est "false".

Fonctions publiques

Annuler

Error Cancel(
  void
)

Cette méthode initialise l'objet minuteur et empêche le minuteur de se déclencher s'il ne l'a pas déjà fait.

Détails
Valeurs renvoyées
WEAVE_SYSTEM_NO_ERROR
Sans condition.

Démarrer

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

Cette méthode enregistre un minuteur one-shot avec le mécanisme de minuteur sous-jacent fourni par la plate-forme.

Détails
Paramètres
[in] aDelayMilliseconds
Nombre de millisecondes avant le déclenchement de ce minuteur
[in] aOnComplete
Un pointeur vers la fonction de rappel lorsque ce minuteur se déclenche
[in] aAppState
Pointeur arbitraire à transmettre à onComplete lorsque ce minuteur se déclenche
Valeurs renvoyées
WEAVE_SYSTEM_NO_ERROR
Sans condition.