нл:: Переплетение:: Система:: Таймер

#include <src/system/SystemTimer.h>

Это внутренний класс Weave System Layer , используемый для представления работающего одноразового таймера.

Краткое содержание

Для прикладного уровня не существует реального общедоступного интерфейса. Статические общедоступные методы, используемые для получения текущего системного времени, предназначены для внутреннего использования.

Наследование

Наследуется от: nl::Weave::System::Object

Публичные типы

Epoch определение типа
uint64_t
Представляет эпоху в шкале времени локальной системы, обычно в шкале времени POSIX.
OnCompleteFunct )(Layer *aLayer, void *aAppState, Error aError) определение типа
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
Сравнивает два значения Timer::Epoch и возвращает 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)

Публичные атрибуты

При завершении 

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
)

IsРаньшеЭпоха 

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

Сравнивает два значения Timer::Epoch и возвращает true, если первое значение предшествует второму значению.

Статический API, который вызывается для сравнения двух значений времени. Этот API пытается учесть перенос таймера, предполагая, что разница между двумя входными значениями будет составлять только половину скалярного диапазона эпохи, если между двумя выборками произошел перенос таймера.

Подробности
Возврат
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
Безоговорочно.