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

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

Classe d'émetteur Weave Heartbeat

Résumé

Constructeurs et destructeurs
WeaveHeartbeatSender(void)

Types publics
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
} 		énum

Attributs publics
AppState
void *

Fonctions publiques
GetBinding() const
Permet d'obtenir l'objet de liaison associé à l'émetteur de pulsation.
GetConfiguration(uint32_t & interval, uint32_t & phase, uint32_t & window) const
void
Obtenir la configuration de la synchronisation des pulsations
GetEventCallback() const
EventCallback
Renvoie la fonction qui sera appelée pour avertir l'application des événements ou des modifications qui se produisent dans WeaveHeartbeatSender.
GetRequestAck() const
bool
Renvoie un indicateur indiquant si les messages Heartbeat seront envoyés de manière fiable à l'aide de la messagerie fiable de Weave.
GetSubscriptionState() const
uint8_t
Obtenez la valeur actuelle de l'état de l'abonnement.
Init(WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState)
Initialisez l'expéditeur Heartbeat de Weave.
ScheduleHeartbeat(void)
Programmez l'envoi de messages Heartbeat de Weave.
SendHeartbeatNow(void)
Envoyez un message Heartbeat à Weave maintenant.
SetConfiguration(uint32_t interval, uint32_t phase, uint32_t window)
void
Définissez la configuration des codes temporels des pulsations.
SetEventCallback(EventCallback eventCallback)
void
Définit la fonction qui sera appelée pour avertir l'application des événements ou des modifications qui se produisent dans WeaveHeartbeatSender.
SetRequestAck(bool val)
void
Définit un indicateur indiquant si les messages Heartbeat doivent être envoyés de manière fiable à l'aide de la messagerie fiable de Weave.
SetSubscriptionState(uint8_t val)
void
Définissez l'état actuel de l'abonnement.
Shutdown(void)
Arrêtez l'émetteur Weave Heartbeat.
StartHeartbeat(void)
Commencez à envoyer des messages Heartbeat de Weave.
StopHeartbeat(void)
Arrêtez d'envoyer des messages Heartbeat de Weave.

Fonctions statiques publiques
DefaultEventHandler(void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam)
void
Fonction de gestionnaire par défaut pour les événements de l'API WeaveHeartbeatSender.

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

Paramètres d'entrée pour l'événement d'API WeaveHeartbeatSender.

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

Paramètres de sortie dans l'événement d'API WeaveHeartbeatSender.

Types publics

EventCallback

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

EventType

 EventType
Propriétés
kEvent_DefaultCheck

Permet de vérifier que la gestion des événements par défaut est correcte dans l'application.

Les applications NE doivent PAS explicitement gérer cet événement.

kEvent_HeartbeatFailed

Échec de l'envoi d'un message de pulsation au pair.

kEvent_HeartbeatSent

Un message de pulsation a bien été envoyé au pair.

Si la transmission fiable est activée, cet événement indique que le message a été accusé de réception.

kEvent_UpdateSubscriptionState

L'application est invitée à mettre à jour l'état de l'abonnement.

Attributs publics

AppState

void * AppState

Fonctions publiques

GetBinding

Binding * GetBinding() const

Permet d'obtenir l'objet de liaison associé à l'émetteur de pulsation.

GetConfiguration

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

Obtenir la configuration de la synchronisation des pulsations

Détails
Paramètres
[out] interval
Référence à un entier pour recevoir l'intervalle des pulsations.
[out] phase
Référence à un entier pour recevoir la phase de pulsation.
[out] window
Référence à un entier pour recevoir la fenêtre de randomisation des pulsations.

GetEventCallback

EventCallback GetEventCallback() const

Renvoie la fonction qui sera appelée pour avertir l'application des événements ou des modifications qui se produisent dans WeaveHeartbeatSender.

GetRequestAck

bool GetRequestAck() const

Renvoie un indicateur indiquant si les messages Heartbeat seront envoyés de manière fiable à l'aide de la messagerie fiable de Weave.

GetSubscriptionState

uint8_t GetSubscriptionState() const

Obtenez la valeur actuelle de l'état de l'abonnement.

Init

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

Initialisez l'expéditeur Heartbeat de Weave.

Détails
Paramètres
[in] exchangeMgr
Pointeur vers le gestionnaire système Weave Exchange.
[in] binding
Pointeur vers un objet de liaison Weave qui sera utilisé pour adresser le nœud pair.
[in] eventCallback
Pointeur vers une fonction qui sera appelée pour avertir l'application des événements ou des changements d'état qui se produisent dans l'expéditeur.
[in] appState
Pointeur vers les données spécifiques à l'application. Ce pointeur sera renvoyé dans des rappels à l'application.
Valeurs renvoyées
WEAVE_ERROR_INCORRECT_STATE
Si l'objet WeaveHeartbeatSender a déjà été initialisé.
WEAVE_ERROR_INVALID_ARGUMENT
Si l'un des arguments fournis est nul.
WEAVE_NO_ERROR
En cas de réussite.

ScheduleHeartbeat

WEAVE_ERROR ScheduleHeartbeat(
  void
)

Programmez l'envoi de messages Heartbeat de Weave.

Détails
Valeurs renvoyées
WEAVE_SYSTEM_ERROR_NO_MEMORY
si la fonction StartMinuteur() a échoué
WEAVE_NO_ERROR
en cas de réussite

SendHeartbeatNow

WEAVE_ERROR SendHeartbeatNow(
  void
)

Envoyez un message Heartbeat à Weave maintenant.

Détails
Valeurs renvoyées
WEAVE_ERROR_INCORRECT_STATE
si WeaveHeartbeatSender n'est pas initialisé.
WEAVE_NO_ERROR
en cas de réussite

SetConfiguration

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

Définissez la configuration des codes temporels des pulsations.

Détails
Paramètres
[in] interval
Intervalle à utiliser lors de l'envoi de messages Heartbeat de Weave.
[in] phase
Phase à utiliser lors de l'envoi de messages Heartbeat de Weave.
[in] window
Plage de fenêtres à utiliser pour choisir un intervalle aléatoire

SetEventCallback

void SetEventCallback(
  EventCallback eventCallback
)

Définit la fonction qui sera appelée pour avertir l'application des événements ou des modifications qui se produisent dans WeaveHeartbeatSender.

SetRequestAck

void SetRequestAck(
  bool val
)

Définit un indicateur indiquant si les messages Heartbeat doivent être envoyés de manière fiable à l'aide de la messagerie fiable de Weave.

Notez que cette option n'a de sens que lors de l'utilisation d'UDP comme transport.

Détails
Paramètres
[in] val
Vrai si les messages Heartbeat doivent être envoyés de manière fiable.

SetSubscriptionState

void SetSubscriptionState(
  uint8_t val
)

Définissez l'état actuel de l'abonnement.

Détails
Paramètres
[in] val
Valeur d'état d'abonnement 8 bits à transmettre avec le message Heartbeat.

Arrêt

WEAVE_ERROR Shutdown(
  void
)

Arrêtez l'émetteur Weave Heartbeat.

Détails
Valeurs renvoyées
WEAVE_NO_ERROR
En cas de réussite.

StartHeartbeat

WEAVE_ERROR StartHeartbeat(
  void
)

Commencez à envoyer des messages Heartbeat de Weave.

Détails
Valeurs renvoyées
INET_ERROR_NO_MEMORY
si la fonction StartMinuteur() a échoué
WEAVE_NO_ERROR
en cas de réussite

StopHeartbeat

WEAVE_ERROR StopHeartbeat(
  void
)

Arrêtez d'envoyer des messages Heartbeat de Weave.

Détails
Valeurs renvoyées
WEAVE_NO_ERROR
sans condition

WeaveHeartbeatSender

 WeaveHeartbeatSender(
  void
)

Fonctions statiques publiques

DefaultEventHandler

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

Fonction de gestionnaire par défaut pour les événements de l'API WeaveHeartbeatSender.

Les applications doivent appeler cette fonction pour tous les événements d'API qu'elles ne gèrent pas.