nl:: Weave:: Profiles:: Heartbeat:: WeaveHeartbeatSender
#include <src/lib/profiles/heartbeat/WeaveHeartbeat.h>
Classe do remetente Heartbeat.
Resumo
Construtores e destrutores |
|
---|---|
WeaveHeartbeatSender(void)
|
Tipos públicos |
|
---|---|
EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
|
typedefvoid(*
|
EventType{
|
enum |
Atributos públicos |
|
---|---|
AppState
|
void *
|
Funções públicas |
|
---|---|
GetBinding() const
|
Binding *
Recebe o objeto de vinculação associado ao remetente do sinal de funcionamento.
|
GetConfiguration(uint32_t & interval, uint32_t & phase, uint32_t & window) const
|
void
Recebe a configuração de tempo do sinal de funcionamento.
|
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 sinal de funcionamento serão enviadas de forma confiável usando o Weave trust Messaging.
|
GetSubscriptionState() const
|
uint8_t
Recebe o valor do estado atual 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 Weave Heartbeat.
|
SendHeartbeatNow(void)
|
Envie uma mensagem do Weave Heartbeat agora.
|
SetConfiguration(uint32_t interval, uint32_t phase, uint32_t window)
|
void
Definir 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 mudanças que ocorrem no WeaveHeartbeatSender.
|
SetRequestAck(bool val)
|
void
Define uma sinalização que indica se as mensagens de pulsação devem ser enviadas de forma confiável usando o Weave Responsible Messaging.
|
SetSubscriptionState(uint8_t val)
|
void
Define o estado atual da assinatura.
|
Shutdown(void)
|
Encerre o remetente de batimento cardíaco do Weave.
|
StartHeartbeat(void)
|
Comece a enviar mensagens do 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 o evento da API WeaveHeartbeatSender. |
nl:: |
Parâmetros de saída para o evento da API WeaveHeartbeatSender. |
Tipos públicos
EventCallback
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
|
Falha ao enviar uma mensagem de sinal de funcionamento para o peering. |
kEvent_HeartbeatSent
|
Uma mensagem de sinal de funcionamento foi enviada ao peering. Se uma transmissão confiável estiver ativada, esse evento indica que a mensagem foi confirmada. |
kEvent_UpdateSubscriptionState
|
É solicitado que o aplicativo atualize o estado da assinatura. |
Atributos públicos
AppState
void * AppState
Funções públicas
GetBinding
Binding * GetBinding() const
Recebe o objeto de vinculação associado ao remetente do sinal de funcionamento.
GetConfiguration
void GetConfiguration( uint32_t & interval, uint32_t & phase, uint32_t & window ) const
Recebe a configuração de tempo do sinal de funcionamento.
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 sinal de funcionamento serão enviadas de forma confiável usando o Weave trust Messaging.
GetSubscriptionState
uint8_t GetSubscriptionState() const
Recebe o valor do estado atual 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 Weave Heartbeat.
Detalhes | |||||
---|---|---|---|---|---|
Valores de retorno |
|
SendHeartbeatNow
WEAVE_ERROR SendHeartbeatNow( void )
Envie uma mensagem do Weave Heartbeat agora.
Detalhes | |||||
---|---|---|---|---|---|
Valores de retorno |
|
SetConfiguration
void SetConfiguration( uint32_t interval, uint32_t phase, uint32_t window )
Definir 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 mudanças que ocorrem no WeaveHeartbeatSender.
SetRequestAck
void SetRequestAck( bool val )
Define uma sinalização que indica se as mensagens de pulsação devem ser enviadas de forma confiável usando o Weave Responsible Messaging.
Essa sinalização só é significativa quando o UDP é usado como transporte.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
SetSubscriptionState
void SetSubscriptionState( uint8_t val )
Define o estado atual da assinatura.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
Desligamento
WEAVE_ERROR Shutdown( void )
Encerre o remetente de batimento cardíaco do Weave.
Detalhes | |||
---|---|---|---|
Valores de retorno |
|
StartHeartbeat
WEAVE_ERROR StartHeartbeat( void )
Comece a enviar mensagens do 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
DefaultEventHandler
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 da API que não processam.