O Google tem o compromisso de promover a igualdade racial para as comunidades negras. Saiba como.

nl::Weave::Perfis::Heartbeat::WeaveHeartbeatSender

#include <src/lib/profiles/heartbeat/WeaveHeartbeat.h>

Tecer a classe Sender Heartbeat.

Resumo

Construtores e destruidores
WeaveHeartbeatSender(void)

Tipos públicos
EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam) typedef
void(*
EventType{
  kEvent_UpdateSubscriptionState = 1,
  kEvent_HeartbeatSent = 2,
  kEvent_HeartbeatFailed = 3,
  kEvent_DefaultCheck = 100
} 		tipo enumerado

Atributos públicos
AppState
void *

Funções públicas
GetBinding() const
Receba o objeto de vinculação associado ao remetente de sinal de funcionamento.
GetConfiguration(uint32_t & interval, uint32_t & phase, uint32_t & window) const
void
Acessar configuração de tempo de batimentos cardíacos.
GetEventCallback() const
EventCallback
Retorna a função que será chamada para notificar a aplicação de eventos ou alterações que ocorrem no WeaveHeartbeatSender.
GetRequestAck() const
bool
Retorna uma sinalização que indica se as mensagens de pulsação serão enviadas de maneira confiável usando o Weave Trusted Messaging.
GetSubscriptionState() const
uint8_t
Recebe o valor atual do estado da assinatura.
Init(WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState)
Inicialize o remetente Heartbeat do Weave.
ScheduleHeartbeat(void)
Programe o envio de mensagens do Heabeat do Weave.
SendHeartbeatNow(void)
Envie uma mensagem do Weave Heartbeat agora mesmo.
SetConfiguration(uint32_t interval, uint32_t phase, uint32_t window)
void
Defina a configuração de tempo do sinal de funcionamento.
SetEventCallback(EventCallback eventCallback)
void
Define a função que será chamada para notificar a aplicação de eventos ou alterações que ocorrem no WeaveHeartbeatSender.
SetRequestAck(bool val)
void
Define uma sinalização que indica se as mensagens de pulsação precisam ser enviadas de maneira confiável usando o Weave Trusted Messaging.
SetSubscriptionState(uint8_t val)
void
Define o estado atual da assinatura.
Shutdown(void)
Encerre o remetente do Weave Heartbeat.
StartHeartbeat(void)
Comece a enviar mensagens Weave Heartbeat.
StopHeartbeat(void)
Pare de enviar mensagens do Weave Heartbeat.

Funções estáticas públicas
DefaultEventHandler(void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam)
void
Função de gerenciador padrão para eventos da API WeaveHeartbeatSender.

Estruturas
nl::Weave::Perfils::Heartbeat::WeaveHeartbeatSender::InEventParam

Parâmetros de entrada para um evento de API WeaveHeartbeatSender.

nl::Weave::Perfis::Heartbeat::WeaveHeartbeatSender::OutEventParam

Parâmetros de saída para o evento da API WeaveHeartbeatSender.

Tipos públicos

Callback de evento

void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)

EventType

 EventType
Propriedades
kEvent_DefaultCheck

Usado para verificar o gerenciamento correto de eventos padrão no aplicativo.

Os aplicativos NÃO devem lidar expressamente com esse evento.

kEvent_HeartbeatFailed

Uma mensagem de frequência cardíaca não foi enviada ao par.

kEvent_HeartbeatSent

Uma mensagem de sinal de funcionamento foi enviada ao par.

Se uma transmissão confiável estiver ativada, esse evento indica que a mensagem foi confirmada.

kEvent_UpdateSubscriptionState

O aplicativo é solicitado a atualizar o estado da assinatura.

Atributos públicos

Estado do aplicativo

void * AppState

Funções públicas

GetBinding

Binding * GetBinding() const

Receba o objeto de vinculação associado ao remetente de sinal de funcionamento.

GetConfiguration

void GetConfiguration(
  uint32_t & interval,
  uint32_t & phase,
  uint32_t & window
) const

Acessar configuração de tempo de batimentos cardíacos.

Detalhes
Parâmetros
[out] interval
Uma referência a um número inteiro para receber o intervalo de frequência cardíaca.
[out] phase
Uma referência a um número inteiro para receber a fase de sinal de funcionamento.
[out] window
Uma referência a um número inteiro para receber a janela de ordem aleatória de frequência cardíaca.

GetEventCallback

EventCallback GetEventCallback() const

Retorna a função que será chamada para notificar a aplicação de eventos ou alterações que ocorrem no WeaveHeartbeatSender.

GetRequestAck

bool GetRequestAck() const

Retorna uma sinalização que indica se as mensagens de pulsação serão enviadas de maneira confiável usando o Weave Trusted Messaging.

GetAssinaturaState

uint8_t GetSubscriptionState() const

Recebe o valor atual do estado da assinatura.

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr,
  Binding *binding,
  EventCallback eventCallback,
  void *appState
)

Inicialize o remetente Heartbeat do Weave.

Detalhes
Parâmetros
[in] exchangeMgr
Um ponteiro para o sistema Weave Exchange Manager.
[in] binding
Um ponteiro para um objeto de vinculação do Weave que será usado para abordar o nó de peering.
[in] eventCallback
Um ponteiro para uma função que será chamada para notificar a aplicação de eventos ou alterações de estado que ocorrem no remetente.
[in] appState
Um ponteiro para dados específicos do aplicativo. Esse ponteiro será retornado em callbacks para o aplicativo.
Valores de retorno
WEAVE_ERROR_INCORRECT_STATE
Se o objeto WeaveHeartbeatSender já foi inicializado.
WEAVE_ERROR_INVALID_ARGUMENT
Se algum dos argumentos fornecidos for nulo.
WEAVE_NO_ERROR
Em caso de sucesso.

ScheduleHeartbeat

WEAVE_ERROR ScheduleHeartbeat(
  void
)

Programe o envio de mensagens do Heabeat do Weave.

Detalhes
Valores de retorno
WEAVE_SYSTEM_ERROR_NO_MEMORY
se StartTimer() falhar
WEAVE_NO_ERROR
em caso de sucesso

SendHeartbeatNow

WEAVE_ERROR SendHeartbeatNow(
  void
)

Envie uma mensagem do Weave Heartbeat agora mesmo.

Detalhes
Valores de retorno
WEAVE_ERROR_INCORRECT_STATE
se WeaveHeartbeatSender não for inicializado.
WEAVE_NO_ERROR
em caso de sucesso

Configuração

void SetConfiguration(
  uint32_t interval,
  uint32_t phase,
  uint32_t window
)

Defina a configuração de tempo do sinal de funcionamento.

Detalhes
Parâmetros
[in] interval
Intervalo a ser usado ao enviar mensagens do Heartbeat do Weave.
[in] phase
Fase a ser usada ao enviar mensagens de Heartbeat do Weave.
[in] window
Intervalo de janelas que será usado para escolher o intervalo aleatório

SetEventCallback

void SetEventCallback(
  EventCallback eventCallback
)

Define a função que será chamada para notificar a aplicação de eventos ou alterações que ocorrem no WeaveHeartbeatSender.

SetRequestAck

void SetRequestAck(
  bool val
)

Define uma sinalização que indica se as mensagens de pulsação precisam ser enviadas de maneira confiável usando o Weave Trusted Messaging.

Essa sinalização só é significativa ao usar o UDP como um transporte.

Detalhes
Parâmetros
[in] val
Verdadeiro se as mensagens de frequência cardíaca forem enviadas de maneira confiável.

Estado de assinatura

void SetSubscriptionState(
  uint8_t val
)

Define o estado atual da assinatura.

Detalhes
Parâmetros
[in] val
Um valor do estado da assinatura de 8 bits a ser transmitido com a mensagem de sinal de funcionamento.

Encerramento

WEAVE_ERROR Shutdown(
  void
)

Encerre o remetente do Weave Heartbeat.

Detalhes
Valores de retorno
WEAVE_NO_ERROR
Em caso de sucesso.

StartHeartbeat

WEAVE_ERROR StartHeartbeat(
  void
)

Comece a enviar mensagens Weave Heartbeat.

Detalhes
Valores de retorno
INET_ERROR_NO_MEMORY
se StartTimer() falhar
WEAVE_NO_ERROR
em caso de sucesso

StopHeartbeat

WEAVE_ERROR StopHeartbeat(
  void
)

Pare de enviar mensagens do Weave Heartbeat.

Detalhes
Valores de retorno
WEAVE_NO_ERROR
incondicionalmente

WeaveHeartbeatSender

 WeaveHeartbeatSender(
  void
)

Funções estáticas públicas

Gerenciador de eventos padrão

void DefaultEventHandler(
  void *appState,
  EventType eventType,
  const InEventParam & inParam,
  OutEventParam & outParam
)

Função de gerenciador padrão para eventos da API WeaveHeartbeatSender.

Os aplicativos precisam chamar essa função para todos os eventos de API que eles não processam.