nl::Weave::Profiles::Heartbeat::WeaveHeartbeatSender

#include <src/lib/profiles/heartbeat/WeaveHeartbeat.h>

Clase Sender Heartbeat.

Resumen

Constructores y destructores
WeaveHeartbeatSender(void)

Tipos públicos
EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam) typedef
void(*
EventType{
  kEvent_UpdateSubscriptionState = 1,
  kEvent_HeartbeatSent = 2,
  kEvent_HeartbeatFailed = 3,
  kEvent_DefaultCheck = 100
} 		enum

Atributos públicos
AppState
void *

Funciones públicas
GetBinding() const
Obtén el objeto de vinculación asociado con el emisor de la señal de monitoreo de funcionamiento.
GetConfiguration(uint32_t & interval, uint32_t & phase, uint32_t & window) const
void
Obtén la configuración de la sincronización de la señal de monitoreo de funcionamiento.
GetEventCallback() const
EventCallback
Muestra la función a la que se llamará para notificar a la aplicación sobre eventos o cambios que ocurran en WeaveHeartbeatSender.
GetRequestAck() const
bool
Muestra una marca que indica si los mensajes de señal de monitoreo de funcionamiento se enviarán de forma confiable mediante Weave Reliable Messaging.
GetSubscriptionState() const
uint8_t
Obtén el valor del estado actual de la suscripción.
Init(WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState)
Inicializa el emisor de Heartbeat de Weave.
ScheduleHeartbeat(void)
Programa el envío de mensajes de Heartbeat de Weave.
SendHeartbeatNow(void)
Envía un mensaje de Heartbeat de Weave ahora.
SetConfiguration(uint32_t interval, uint32_t phase, uint32_t window)
void
Establece la configuración de la sincronización de la señal de monitoreo de funcionamiento.
SetEventCallback(EventCallback eventCallback)
void
Establece la función a la que se llamará para notificar a la aplicación sobre eventos o cambios que ocurran en WeaveHeartbeatSender.
SetRequestAck(bool val)
void
Establece una marca que indica si los mensajes de señal de monitoreo de funcionamiento se deben enviar de forma confiable a través de Weave Reliable Messaging.
SetSubscriptionState(uint8_t val)
void
Configura el estado actual de la suscripción.
Shutdown(void)
Apaga el emisor de Heartbeat de Weave.
StartHeartbeat(void)
Comienza a enviar mensajes de Heartbeat de Weave.
StopHeartbeat(void)
Deja de enviar mensajes de Heartbeat de Weave.

Funciones estáticas públicas
DefaultEventHandler(void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam)
void
Función de controlador predeterminado para eventos de la API WeaveHeartbeatSender.

Structs
nl::Weave::Profiles::Heartbeat::WeaveHeartbeatSender::InEventParam

Parámetros de entrada al evento de la API WeaveHeartbeatSender.

nl::Weave::Profiles::Heartbeat::WeaveHeartbeatSender::OutEventParam

Parámetros de salida para el evento WeaveHeartbeatSender de la API.

Tipos públicos

EventCallback

void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)

EventType

 EventType
Propiedades
kEvent_DefaultCheck

Se usa para verificar el manejo correcto de eventos predeterminados en la aplicación.

Las aplicaciones NO deben abordar este evento expresamente.

kEvent_HeartbeatFailed

No se pudo enviar un mensaje de señal de monitoreo de funcionamiento a la app similar.

kEvent_HeartbeatSent

Se envió correctamente un mensaje de señal de monitoreo de funcionamiento al par.

Si se habilita una transmisión confiable, este evento indica que se confirmó el mensaje.

kEvent_UpdateSubscriptionState

Se solicita a la aplicación que actualice el estado de la suscripción.

Atributos públicos

AppState

void * AppState

Funciones públicas

GetBinding

Binding * GetBinding() const

Obtén el objeto de vinculación asociado con el emisor de la señal de monitoreo de funcionamiento.

GetConfiguration

void GetConfiguration(
  uint32_t & interval,
  uint32_t & phase,
  uint32_t & window
) const

Obtén la configuración de la sincronización de la señal de monitoreo de funcionamiento.

Detalles
Parámetros
[out] interval
Una referencia a un número entero para recibir el intervalo de la señal de monitoreo de funcionamiento.
[out] phase
Referencia a un número entero para recibir la fase de la señal de monitoreo de funcionamiento.
[out] window
Es una referencia a un número entero para recibir la ventana de aleatorización de señales de monitoreo de funcionamiento.

GetEventCallback

EventCallback GetEventCallback() const

Muestra la función a la que se llamará para notificar a la aplicación sobre eventos o cambios que ocurran en WeaveHeartbeatSender.

GetRequestAck

bool GetRequestAck() const

Muestra una marca que indica si los mensajes de señal de monitoreo de funcionamiento se enviarán de forma confiable a través de Weave Reliable Messaging.

GetSubscriptionState

uint8_t GetSubscriptionState() const

Obtén el valor del estado actual de la suscripción.

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr,
  Binding *binding,
  EventCallback eventCallback,
  void *appState
)

Inicializa el emisor de Heartbeat de Weave.

Detalles
Parámetros
[in] exchangeMgr
Un puntero al sistema Weave Exchange Manager.
[in] binding
Un puntero a un objeto de vinculación de Weave que se usará para abordar el nodo de intercambio de tráfico.
[in] eventCallback
Un puntero a una función a la que se llamará para notificar a la aplicación sobre eventos o cambios de estado que ocurran en el remitente.
[in] appState
Es un puntero a datos específicos de la aplicación. Este puntero se devolverá en devoluciones de llamada a la aplicación.
Valores de retorno
WEAVE_ERROR_INCORRECT_STATE
Si ya se inicializó el objeto WeaveHeartbeatSender.
WEAVE_ERROR_INVALID_ARGUMENT
Si alguno de los argumentos proporcionados es nulo.
WEAVE_NO_ERROR
Si tiene éxito.

ScheduleHeartbeat

WEAVE_ERROR ScheduleHeartbeat(
  void
)

Programa el envío de mensajes de Heartbeat de Weave.

Detalles
Valores de retorno
WEAVE_SYSTEM_ERROR_NO_MEMORY
si StartTimer() falló
WEAVE_NO_ERROR
en función del éxito

SendHeartbeatNow

WEAVE_ERROR SendHeartbeatNow(
  void
)

Envía un mensaje de Heartbeat de Weave ahora.

Detalles
Valores de retorno
WEAVE_ERROR_INCORRECT_STATE
si WeaveHeartbeatSender no se inicializó
WEAVE_NO_ERROR
en función del éxito

SetConfiguration

void SetConfiguration(
  uint32_t interval,
  uint32_t phase,
  uint32_t window
)

Establece la configuración de la sincronización de la señal de monitoreo de funcionamiento.

Detalles
Parámetros
[in] interval
Es el intervalo que se usa cuando se envían mensajes de Heartbeat de Weave.
[in] phase
Fase que se usa cuando se envían mensajes de Heartbeat de Weave.
[in] window
Rango de ventana que se usará para elegir un intervalo aleatorio

SetEventCallback

void SetEventCallback(
  EventCallback eventCallback
)

Establece la función a la que se llamará para notificar a la aplicación sobre eventos o cambios que ocurran en WeaveHeartbeatSender.

SetRequestAck

void SetRequestAck(
  bool val
)

Establece una marca que indica si los mensajes de señal de monitoreo de funcionamiento se deben enviar de forma confiable a través de Weave Reliable Messaging.

Ten en cuenta que esta marca solo es significativa cuando se usa UDP como transporte.

Detalles
Parámetros
[in] val
Es verdadero si los mensajes de señal de monitoreo de funcionamiento se deben enviar de manera confiable.

SetSubscriptionState

void SetSubscriptionState(
  uint8_t val
)

Configura el estado actual de la suscripción.

Detalles
Parámetros
[in] val
Valor de estado de suscripción de 8 bits que se transmitirá con el mensaje de señal de monitoreo de funcionamiento.

Cierre

WEAVE_ERROR Shutdown(
  void
)

Apaga el emisor de Heartbeat de Weave.

Detalles
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.

StartHeartbeat

WEAVE_ERROR StartHeartbeat(
  void
)

Comienza a enviar mensajes de Heartbeat de Weave.

Detalles
Valores de retorno
INET_ERROR_NO_MEMORY
si StartTimer() falló
WEAVE_NO_ERROR
en función del éxito

StopHeartbeat

WEAVE_ERROR StopHeartbeat(
  void
)

Deja de enviar mensajes de Heartbeat de Weave.

Detalles
Valores de retorno
WEAVE_NO_ERROR
incondicionalmente

WeaveHeartbeatSender

 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 eventos de la API WeaveHeartbeatSender.

Las aplicaciones deben llamar a esta función para cualquier evento de API que no controlen.