nl :: Tejido:: Perfiles: Latido del corazón:: TejidoLatido Del Corazón
#include <src/lib/profiles/heartbeat/WeaveHeartbeat.h>
Armadura de Heartbeat clase remitente.
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 * Obtén el objeto de enlace asociado con el remitente del 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 que será llamada para notificar a la aplicación de los eventos o cambios que se producen en el 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 Obtenga el valor del estado de suscripción actual. |
Init ( WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState) | Inicializar la armadura del latido del corazón del remitente. |
ScheduleHeartbeat (void) | Programar el envío de la armadura de latido mensajes. |
SendHeartbeatNow (void) | Enviar un tejido Heartbeat mensaje 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 que será llamada para notificar a la aplicación de los eventos o cambios que se producen en el 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) | Apagar la armadura del latido del corazón del remitente. |
StartHeartbeat (void) | Iniciar el envío de la armadura de latido mensajes. |
StopHeartbeat (void) | Detener el envío de la armadura de latido mensajes. |
Funciones estáticas públicas | |
---|---|
DefaultEventHandler (void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam) | void Función de controlador predeterminado para WeaveHeartbeatSender sucesos de API. |
Estructuras | |
---|---|
nl :: Armadura :: Perfiles :: latido del corazón :: :: WeaveHeartbeatSender InEventParam | Los parámetros de entrada a WeaveHeartbeatSender suceso de la API. |
nl :: Armadura :: Perfiles :: latido del corazón :: :: WeaveHeartbeatSender OutEventParam | Los parámetros de salida a WeaveHeartbeatSender suceso de la API. |
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
Obtiene 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 que será llamada para notificar a la aplicación de los eventos o cambios que se producen en el 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
Obtenga el valor del estado de suscripción actual.
En eso
WEAVE_ERROR Init( WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState )
Inicializar la armadura del latido del corazón del remitente.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
| ||||||||
Valores devueltos |
|
Horario latido del corazón
WEAVE_ERROR ScheduleHeartbeat( void )
Programar el envío de la armadura de latido mensajes.
Detalles | |||||
---|---|---|---|---|---|
Valores devueltos |
|
SendHeartbeatNow
WEAVE_ERROR SendHeartbeatNow( void )
Enviar un tejido Heartbeat mensaje 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 que será llamada para notificar a la aplicación de los eventos o cambios que se producen en el 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 |
|
Cerrar
WEAVE_ERROR Shutdown( void )
Apagar la armadura del latido del corazón del remitente.
Detalles | |||
---|---|---|---|
Valores devueltos |
|
StartHeartbeat
WEAVE_ERROR StartHeartbeat( void )
Iniciar el envío de la armadura de latido mensajes.
Detalles | |||||
---|---|---|---|---|---|
Valores devueltos |
|
Detener latido
WEAVE_ERROR StopHeartbeat( void )
Detener el envío de la armadura de latido mensajes.
Detalles | |||
---|---|---|---|
Valores devueltos |
|
TejidoLatido 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 predeterminado para WeaveHeartbeatSender sucesos de API.
Las aplicaciones deben llamar a esta función para cualquier evento de API que no manejen.