nl :: Tecer:: Perfis :: Batimento cardiaco:: WeaveHeartbeatSender
#include <src/lib/profiles/heartbeat/WeaveHeartbeat.h>
Classe Weave Heartbeat Sender.
Resumo
Construtores e Destruidores | |
---|---|
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 * Obtenha o objeto de ligação associado ao remetente de pulsação. |
GetConfiguration (uint32_t & interval, uint32_t & phase, uint32_t & window) const | void Obtenha a configuração de tempo de pulsação. |
GetEventCallback () const | EventCallback Retorna a função que será chamada para notificar a aplicação dos eventos ou alterações que ocorrerem no WeaveHeartbeatSender . |
GetRequestAck () const | bool Retorna um sinalizador que indica se as mensagens de pulsação serão enviadas de maneira confiável usando o Weave Reliable Messaging. |
GetSubscriptionState () const | uint8_t Obtenha o valor do estado da assinatura atual. |
Init ( WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState) | Inicialize o Weave Heartbeat Sender. |
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 Defina a configuração de tempo de pulsação. |
SetEventCallback (EventCallback eventCallback) | void Define a função que será chamada para notificar a aplicação de eventos ou mudanças que ocorrerem no WeaveHeartbeatSender . |
SetRequestAck (bool val) | void Define um sinalizador que indica se as mensagens de pulsação devem ser enviadas de maneira confiável usando o Weave Reliable Messaging. |
SetSubscriptionState (uint8_t val) | void Defina o estado da assinatura atual. |
Shutdown (void) | Desligue o Weave Heartbeat Sender. |
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 manipulador padrão para eventos da API WeaveHeartbeatSender . |
Structs | |
---|---|
nl :: Weave :: Profiles :: Heartbeat :: WeaveHeartbeatSender :: InEventParam | Parâmetros de entrada para o evento da API WeaveHeartbeatSender . |
nl :: Weave :: Profiles :: Heartbeat :: WeaveHeartbeatSender :: OutEventParam | 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)
Tipo de evento
EventType
Atributos públicos
AppState
void * AppState
Funções públicas
GetBinding
Binding * GetBinding() const
Obtenha o objeto de ligação associado ao remetente de pulsação.
GetConfiguration
void GetConfiguration( uint32_t & interval, uint32_t & phase, uint32_t & window ) const
Obtenha a configuração de tempo de pulsação.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
GetEventCallback
EventCallback GetEventCallback() const
Retorna a função que será chamada para notificar a aplicação dos eventos ou alterações que ocorrerem no WeaveHeartbeatSender .
GetRequestAck
bool GetRequestAck() const
Retorna um sinalizador que indica se as mensagens de pulsação serão enviadas de maneira confiável usando o Weave Reliable Messaging.
GetSubscriptionState
uint8_t GetSubscriptionState() const
Obtenha o valor do estado da assinatura atual.
Iniciar
WEAVE_ERROR Init( WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState )
Inicialize o Weave Heartbeat Sender.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||
Valores Retornados |
|
ScheduleHeartbeat
WEAVE_ERROR ScheduleHeartbeat( void )
Programe o envio de mensagens do Weave Heartbeat .
Detalhes | |||||
---|---|---|---|---|---|
Valores Retornados |
|
SendHeartbeatNow
WEAVE_ERROR SendHeartbeatNow( void )
Envie uma mensagem do Weave Heartbeat agora.
Detalhes | |||||
---|---|---|---|---|---|
Valores Retornados |
|
SetConfiguration
void SetConfiguration( uint32_t interval, uint32_t phase, uint32_t window )
SetEventCallback
void SetEventCallback( EventCallback eventCallback )
Define a função que será chamada para notificar a aplicação de eventos ou alterações que ocorrerem no WeaveHeartbeatSender .
SetRequestAck
void SetRequestAck( bool val )
Define um sinalizador que indica se as mensagens de pulsação devem ser enviadas de maneira confiável usando o Weave Reliable Messaging.
Observe que este sinalizador só é significativo ao usar UDP como um transporte.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
SetSubscriptionState
void SetSubscriptionState( uint8_t val )
Defina o estado da assinatura atual.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
Desligar
WEAVE_ERROR Shutdown( void )
Desligue o Weave Heartbeat Sender.
Detalhes | |||
---|---|---|---|
Valores Retornados |
|
StartHeartbeat
WEAVE_ERROR StartHeartbeat( void )
Comece a enviar mensagens de Weave Heartbeat .
Detalhes | |||||
---|---|---|---|---|---|
Valores Retornados |
|
StopHeartbeat
WEAVE_ERROR StopHeartbeat( void )
Pare de enviar mensagens do Weave Heartbeat .
Detalhes | |||
---|---|---|---|
Valores Retornados |
|
WeaveHeartbeatSender
WeaveHeartbeatSender( void )
Funções estáticas públicas
DefaultEventHandler
void DefaultEventHandler( void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam )
Função de manipulador padrão para eventos da API WeaveHeartbeatSender .
Os aplicativos devem chamar essa função para quaisquer eventos de API que eles não manipulam.