nl::Weave::Wetbeat::Heartbeat:Weave.Weerve

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

La clase de remitente de Wetve

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 señal de monitoreo de funcionamiento.
GetConfiguration(uint32_t & interval, uint32_t & phase, uint32_t & window) const
void
Obtén un parámetro de configuración de tiempo de monitoreo de funcionamiento.
GetEventCallback() const
EventCallback
Muestra la función que se llamará para notificar a la aplicación sobre los eventos o cambios que ocurren en WeaveHeartbeatSender.
GetRequestAck() const
bool
Muestra una marca que indica si los mensajes de monitoreo de funcionamiento se enviarán de manera confiable mediante Weave Reliable Messaging.
GetSubscriptionState() const
uint8_t
Obtén el valor del estado de la suscripción actual.
Init(WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState)
Inicializa el remitente de Heartbeat.
ScheduleHeartbeat(void)
Programa el envío de mensajes de Heartbeat a 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 tiempo de monitoreo de funcionamiento.
SetEventCallback(EventCallback eventCallback)
void
Configura la función a la que se llamará para notificar a la aplicación sobre eventos o cambios que ocurren en WeaveHeartbeatSender.
SetRequestAck(bool val)
void
Establece una marca que indica si los mensajes de monitoreo de funcionamiento deben enviarse de manera confiable con Weave Reliable Messaging.
SetSubscriptionState(uint8_t val)
void
Establece el estado actual de la suscripción.
Shutdown(void)
Cierra el remitente de Wetbeat.
StartHeartbeat(void)
Envía mensajes de Weave Heartbeat.
StopHeartbeat(void)
Dejar de enviar mensajes de Heartbeat a Weave.

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 de WeaveHeartbeatSender.

Structs
nl::Weave::Perfiles::Heartbeat::WeaveHeartbeatSender::InEventParam

Parámetros de entrada para el evento de la API WeaveHeartbeatSender

nl::Weave::Perfiles::Heartbeat::WeaveHeartbeatSender::OutEventParam

Proporciona parámetros 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
Properties
kEvent_DefaultCheck

Se utiliza para verificar la administración predeterminada de eventos en la aplicación.

Las aplicaciones NO deben controlar este evento expresamente.

kEvent_HeartbeatFailed

No se pudo enviar el mensaje de monitoreo de funcionamiento a un colega.

kEvent_HeartbeatSent

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

Si la transmisión confiable está habilitada, 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

Estado de la aplicación

void * AppState

Funciones públicas

GetBinding

Binding * GetBinding() const

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

GetConfiguration

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

Obtén un parámetro de configuración de tiempo de monitoreo de funcionamiento.

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

GetEventCallback

EventCallback GetEventCallback() const

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

GetRequestAck

bool GetRequestAck() const

Muestra una marca que indica si los mensajes de monitoreo de funcionamiento se enviarán de manera confiable mediante Weave Reliable Messaging.

Estado de la suscripción

uint8_t GetSubscriptionState() const

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

Init

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

Inicializa el remitente de Heartbeat.

Detalles
Parámetros
[in] exchangeMgr
Un puntero para el administrador de intercambio de Weave.
[in] binding
Un puntero para un objeto de vinculación de Weave que se usará para abordar el nodo de par.
[in] eventCallback
Un puntero para una función que se llamará para notificar a la aplicación sobre eventos o cambios de estado que ocurren en el remitente.
[in] appState
Un puntero para los datos específicos de la aplicación. Este puntero se devolverá en las devoluciones de llamada a la aplicación.
Valores que se muestran
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 la operación se realiza correctamente

Programar Hearttbeat

WEAVE_ERROR ScheduleHeartbeat(
  void
)

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

Detalles
Valores que se muestran
WEAVE_SYSTEM_ERROR_NO_MEMORY
si StartTimer() falló
WEAVE_NO_ERROR
el éxito

EnviarHeartbeatNow

WEAVE_ERROR SendHeartbeatNow(
  void
)

Envía un mensaje de Heartbeat de Weave ahora.

Detalles
Valores que se muestran
WEAVE_ERROR_INCORRECT_STATE
si no se inicializa WeaveHeartbeatSender.
WEAVE_NO_ERROR
el éxito

Configurar

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

Establece la configuración de tiempo de monitoreo de funcionamiento.

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

SetEventCallback

void SetEventCallback(
  EventCallback eventCallback
)

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

SetRequestAck

void SetRequestAck(
  bool val
)

Establece una marca que indica si los mensajes de monitoreo de funcionamiento deben enviarse de manera confiable con Weave Reliable Messaging.

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

Detalles
Parámetros
[in] val
Verdadero si los mensajes de monitoreo de funcionamiento deben enviarse de forma confiable.

Estado de la suscripción

void SetSubscriptionState(
  uint8_t val
)

Establece el estado actual de la suscripción.

Detalles
Parámetros
[in] val
Un 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
)

Cierra el remitente de Wetbeat.

Detalles
Valores que se muestran
WEAVE_NO_ERROR
Si la operación se realiza correctamente

StartHeartbeat

WEAVE_ERROR StartHeartbeat(
  void
)

Envía mensajes de Weave Heartbeat.

Detalles
Valores que se muestran
INET_ERROR_NO_MEMORY
si StartTimer() falló
WEAVE_NO_ERROR
el éxito

Para detener el ritmo

WEAVE_ERROR StopHeartbeat(
  void
)

Dejar de enviar mensajes de Heartbeat a Weave.

Detalles
Valores que se muestran
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 predeterminada para eventos de API de WeaveHeartbeatSender.

Las aplicaciones deben llamar a esta función para todos los eventos de la API que no controlan.