nl :: Tejido:: Perfiles: Latido del corazón:: TejerLatido Del Corazón
#include <src/lib/profiles/heartbeat/WeaveHeartbeat.h>
Clase Weave Heartbeat Sender.
Resumen
Constructores y Destructores | |
---|---|
WeaveHeartbeatSender (void) |
Tipos públicos | |
---|---|
EventCallback )(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam) | typedefvoid(* |
EventType { | enumeración |
Atributos públicos | |
---|---|
AppState | void * |
Funciones publicas | |
---|---|
GetBinding () const | Binding * Obtenga el objeto de enlace asociado con el remitente de latido. |
GetConfiguration (uint32_t & interval, uint32_t & phase, uint32_t & window) const | void Obtén la configuración del tiempo de latido. |
GetEventCallback () const | EventCallback Devuelve la función a la que se llamará para notificar a la aplicación de eventos o cambios que ocurran en WeaveHeartbeatSender . |
GetRequestAck () const | bool Devuelve una bandera que indica si los mensajes de latido se enviarán de manera confiable mediante Weave Reliable Messaging. |
GetSubscriptionState () const | uint8_t Obtén el valor del estado de suscripción actual. |
Init ( WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState) | Inicialice Weave Heartbeat Sender. |
ScheduleHeartbeat (void) | Programe el envío de mensajes Weave Heartbeat . |
SendHeartbeatNow (void) | Envíe un mensaje Weave Heartbeat ahora. |
SetConfiguration (uint32_t interval, uint32_t phase, uint32_t window) | void Establece la configuración del tiempo de latido. |
SetEventCallback (EventCallback eventCallback) | void Establece la función a la que se llamará para notificar a la aplicación de eventos o cambios que ocurran en WeaveHeartbeatSender . |
SetRequestAck (bool val) | void Establece una bandera que indica si los mensajes de latido deben enviarse de manera confiable mediante Weave Reliable Messaging. |
SetSubscriptionState (uint8_t val) | void Establece el estado de suscripción actual. |
Shutdown (void) | Apague el remitente Weave Heartbeat . |
StartHeartbeat (void) | Empiece a enviar mensajes Weave Heartbeat . |
StopHeartbeat (void) | Deja de enviar mensajes Weave Heartbeat . |
Funciones estáticas públicas | |
---|---|
DefaultEventHandler (void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam) | void Función de controlador predeterminada para eventos de API WeaveHeartbeatSender . |
Estructuras | |
---|---|
nl :: Weave :: Perfiles :: Heartbeat :: WeaveHeartbeatSender :: InEventParam | Ingrese parámetros al evento de la API WeaveHeartbeatSender . |
nl :: Weave :: Perfiles :: Heartbeat :: WeaveHeartbeatSender :: OutEventParam | Parámetros de salida al evento de la 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
Funciones publicas
GetBinding
Binding * GetBinding() const
Obtenga el objeto de enlace asociado con el remitente de latido.
GetConfiguration
void GetConfiguration( uint32_t & interval, uint32_t & phase, uint32_t & window ) const
Obtén la configuración del tiempo de latido.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
GetEventCallback
EventCallback GetEventCallback() const
Devuelve la función a la que se llamará para notificar la aplicación de eventos o cambios que ocurran en WeaveHeartbeatSender .
GetRequestAck
bool GetRequestAck() const
Devuelve una bandera que indica si los mensajes de latido se enviarán de manera confiable mediante Weave Reliable Messaging.
GetSubscriptionState
uint8_t GetSubscriptionState() const
Obtén el valor del estado de suscripción actual.
En eso
WEAVE_ERROR Init( WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState )
Inicialice Weave Heartbeat Sender.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
| ||||||||
Valores devueltos |
|
Horario latido del corazón
WEAVE_ERROR ScheduleHeartbeat( void )
Programe el envío de mensajes Weave Heartbeat .
Detalles | |||||
---|---|---|---|---|---|
Valores devueltos |
|
SendHeartbeatNow
WEAVE_ERROR SendHeartbeatNow( void )
Envíe un mensaje Weave Heartbeat ahora.
Detalles | |||||
---|---|---|---|---|---|
Valores devueltos |
|
SetConfiguration
void SetConfiguration( uint32_t interval, uint32_t phase, uint32_t window )
SetEventCallback
void SetEventCallback( EventCallback eventCallback )
Establece la función a la que se llamará para notificar a la aplicación de eventos o cambios que ocurran en WeaveHeartbeatSender .
SetRequestAck
void SetRequestAck( bool val )
Establece una bandera que indica si los mensajes de latido deben enviarse de manera confiable mediante Weave Reliable Messaging.
Tenga en cuenta que esta bandera solo es significativa cuando se usa UDP como transporte.
Detalles | |||
---|---|---|---|
Parámetros |
|
SetSubscriptionState
void SetSubscriptionState( uint8_t val )
Establece el estado de suscripción actual.
Detalles | |||
---|---|---|---|
Parámetros |
|
Apagar
WEAVE_ERROR Shutdown( void )
Apague el remitente Weave Heartbeat .
Detalles | |||
---|---|---|---|
Valores devueltos |
|
StartHeartbeat
WEAVE_ERROR StartHeartbeat( void )
Comience a enviar mensajes Weave Heartbeat .
Detalles | |||||
---|---|---|---|---|---|
Valores devueltos |
|
Detener latido
WEAVE_ERROR StopHeartbeat( void )
Deja de enviar mensajes Weave Heartbeat .
Detalles | |||
---|---|---|---|
Valores devueltos |
|
TejerLatido Del Corazón
WeaveHeartbeatSender( void )
Funciones estáticas públicas
DefaultEventHandler
void DefaultEventHandler( void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam )
Función de controlador predeterminada para eventos de API WeaveHeartbeatSender .
Las aplicaciones deben llamar a esta función para cualquier evento de API que no manejen.