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)
|
typedefvoid(*
|
EventType{
|
tipo enumerado |
Atributos públicos |
|
---|---|
AppState
|
void *
|
Funções públicas |
|
---|---|
GetBinding() const
|
Binding *
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:: |
Parâmetros de entrada para um evento de API WeaveHeartbeatSender. |
nl:: |
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 |
|
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 |
|
||||||||
Valores de retorno |
|
ScheduleHeartbeat
WEAVE_ERROR ScheduleHeartbeat( void )
Programe o envio de mensagens do Heabeat do Weave.
Detalhes | |||||
---|---|---|---|---|---|
Valores de retorno |
|
SendHeartbeatNow
WEAVE_ERROR SendHeartbeatNow( void )
Envie uma mensagem do Weave Heartbeat agora mesmo.
Detalhes | |||||
---|---|---|---|---|---|
Valores de retorno |
|
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 |
|
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 |
|
Estado de assinatura
void SetSubscriptionState( uint8_t val )
Define o estado atual da assinatura.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
Encerramento
WEAVE_ERROR Shutdown( void )
Encerre o remetente do Weave Heartbeat.
Detalhes | |||
---|---|---|---|
Valores de retorno |
|
StartHeartbeat
WEAVE_ERROR StartHeartbeat( void )
Comece a enviar mensagens Weave Heartbeat.
Detalhes | |||||
---|---|---|---|---|---|
Valores de retorno |
|
StopHeartbeat
WEAVE_ERROR StopHeartbeat( void )
Pare de enviar mensagens do Weave Heartbeat.
Detalhes | |||
---|---|---|---|
Valores de retorno |
|
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.