nl::Weave::System::Timer

#include <src/system/SystemTimer.h>

Esta é uma classe interna para a camada do sistema Weave, usada para representar um timer one-shot em andamento.

Resumo

Não há uma interface pública real disponível para a camada do aplicativo. Os métodos públicos estáticos usados para adquirir o horário atual do sistema são destinados ao uso interno.

Herança

Herda de: nl::Weave::System::Object

Tipos públicos

Epoch typedef
uint64_t
Representa um período na escala de tempo do sistema local, normalmente a escala de tempo POSIX.
OnCompleteFunct)(Layer *aLayer, void *aAppState, Error aError) typedef
void(*

Atributos públicos

OnComplete
OnCompleteFunct

Funções estáticas públicas

GetCurrentEpoch(void)
Esse método retorna a época atual, corrigida pela suspensão do sistema com a escala de tempo do sistema, em milissegundos.
GetStatistics(nl::Weave::System::Stats::count_t & aNumInUse, nl::Weave::System::Stats::count_t & aHighWatermark)
void
IsEarlierEpoch(const Epoch & first, const Epoch & second)
bool
Compara dois valores de Timer::Epoch e retorna "verdadeiro" se o primeiro valor for anterior ao segundo.

Funções públicas

Cancel(void)
Error
Esse método desinicializa o objeto timer e impede que o timer seja disparado se não tiver feito isso.
Start(uint32_t aDelayMilliseconds, OnCompleteFunct aOnComplete, void *aAppState)
Error
Esse método registra um timer one-shot com o mecanismo de timer subjacente fornecido pela plataforma.

Tipos públicos

Período

uint64_t Epoch

Representa um período na escala de tempo do sistema local, normalmente a escala de tempo POSIX.

As unidades dependem do contexto. Se usado com valores retornados por GetCurrentEpoch, as unidades são milissegundos.

OnCompleteFunct

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

Atributos públicos

OnComplete

OnCompleteFunct OnComplete

Funções estáticas públicas

GetCurrentEpoch

Epoch GetCurrentEpoch(
  void
)

Esse método retorna a época atual, corrigida pela suspensão do sistema com a escala de tempo do sistema, em milissegundos.

OBSOLETO Use System::Layer::GetClock_MonotonicMS().

Detalhes
Retornos
Carimbo de data/hora em milissegundos.

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
)

Compara dois valores de Timer::Epoch e retorna "verdadeiro" se o primeiro valor for anterior ao segundo.

Uma API estática que é chamada para comparar dois valores de tempo. Essa API tenta considerar o encapsulamento do timer assumindo que a diferença entre os dois valores de entrada será apenas mais da metade do intervalo escalar da época, se um encapsulamento de timer tiver ocorrido entre as duas amostras.

Detalhes
Retornos
verdadeiro se o primeiro parâmetro for anterior ao segundo; caso contrário, falso.

Funções públicas

Cancelar

Error Cancel(
  void
)

Esse método desinicializa o objeto timer e impede que o timer seja disparado se não tiver feito isso.

Detalhes
Valores de retorno
WEAVE_SYSTEM_NO_ERROR
Incondicionalmente.

Iniciar

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

Esse método registra um timer one-shot com o mecanismo de timer subjacente fornecido pela plataforma.

Detalhes
Parâmetros
[in] aDelayMilliseconds
O número de milésimos de segundo antes do disparo deste timer
[in] aOnComplete
Um ponteiro para a função de callback quando este timer é disparado
[in] aAppState
Um ponteiro arbitrário a ser transmitido para onComplete quando este timer for disparado
Valores de retorno
WEAVE_SYSTEM_NO_ERROR
Incondicionalmente.