En Google, luchamos por la equidad racial de la comunidad negra. Más información
Se usó la API de Cloud Translation para traducir esta página.
Switch to English

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) typedef
void(*
EventType {
kEvent_UpdateSubscriptionState = 1,
kEvent_HeartbeatSent = 2,
kEvent_HeartbeatFailed = 3,
kEvent_DefaultCheck = 100
}		 enumeración

Atributos públicos

AppState
void *

Funciones publicas

GetBinding () const
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
Propiedades
kEvent_DefaultCheck

Se utiliza para verificar el correcto manejo de eventos predeterminado en la aplicación.

Las aplicaciones NO deben manejar expresamente este evento.

kEvent_HeartbeatFailed

No se pudo enviar un mensaje de latido al par.

kEvent_HeartbeatSent

Se envió correctamente un mensaje de latido al par.

Si la transmisión confiable está habilitada, este evento indica que el mensaje fue reconocido.

kEvent_UpdateSubscriptionState

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

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
[out] interval
Una referencia a un número entero para recibir el intervalo de latidos.
[out] phase
Una referencia a un número entero para recibir la fase de latido.
[out] window
Una referencia a un número entero para recibir la ventana de aleatorización de latidos.

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
[in] exchangeMgr
Un puntero al sistema Weave Exchange Manager.
[in] binding
Un puntero a un objeto de enlace Weave que se utilizará para dirigirse al nodo del mismo nivel.
[in] eventCallback
Un puntero a una función que será llamada para notificar a la aplicación de eventos o cambios de estado que ocurren en el remitente.
[in] appState
Un puntero a datos específicos de la aplicación. Este puntero se devolverá en devoluciones de llamada a la aplicación.
Valores devueltos
WEAVE_ERROR_INCORRECT_STATE
Si el objeto WeaveHeartbeatSender ya se ha inicializado.
WEAVE_ERROR_INVALID_ARGUMENT
Si alguno de los argumentos proporcionados es nulo.
WEAVE_NO_ERROR
Sobre el éxito.

Horario latido del corazón

WEAVE_ERROR ScheduleHeartbeat(
  void
)

Programe el envío de mensajes Weave Heartbeat .

Detalles
Valores devueltos
WEAVE_SYSTEM_ERROR_NO_MEMORY
si StartTimer () falló
WEAVE_NO_ERROR
en el éxito

SendHeartbeatNow

WEAVE_ERROR SendHeartbeatNow(
  void
)

Envíe un mensaje Weave Heartbeat ahora.

Detalles
Valores devueltos
WEAVE_ERROR_INCORRECT_STATE
si WeaveHeartbeatSender no está inicializado
WEAVE_NO_ERROR
en el éxito

SetConfiguration

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

Establece la configuración del tiempo de latido.

Detalles
Parámetros
[in] interval
Intervalo para usar al enviar mensajes Weave Heartbeat .
[in] phase
Fase a utilizar al enviar mensajes Weave Heartbeat .
[in] window
Rango de ventana a utilizar 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 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
[in] val
Verdadero si los mensajes de latido deben enviarse de manera confiable.

SetSubscriptionState

void SetSubscriptionState(
  uint8_t val
)

Establece el estado de suscripción actual.

Detalles
Parámetros
[in] val
Un valor de estado de suscripción de 8 bits que se transmitirá con el mensaje de latido.

Apagar

WEAVE_ERROR Shutdown(
  void
)

Apague el remitente Weave Heartbeat .

Detalles
Valores devueltos
WEAVE_NO_ERROR
Sobre el éxito.

StartHeartbeat

WEAVE_ERROR StartHeartbeat(
  void
)

Comience a enviar mensajes Weave Heartbeat .

Detalles
Valores devueltos
INET_ERROR_NO_MEMORY
si StartTimer () falló
WEAVE_NO_ERROR
en el éxito

Detener latido

WEAVE_ERROR StopHeartbeat(
  void
)

Deja de enviar mensajes Weave Heartbeat .

Detalles
Valores devueltos
WEAVE_NO_ERROR
incondicionalmente

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.