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

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

Weave Heartbeat Sender-Klasse.

Zusammenfassung

Konstruktoren und Zerstörer
WeaveHeartbeatSender(void)

Öffentliche Typen
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

Öffentliche Attribute
AppState
void *

Öffentliche Funktionen
GetBinding() const
Ruft das Bindungsobjekt ab, das dem Heartbeat-Sender zugeordnet ist.
GetConfiguration(uint32_t & interval, uint32_t & phase, uint32_t & window) const
void
Heartbeat-Timing-Konfiguration abrufen.
GetEventCallback() const
EventCallback
Gibt die Funktion zurück, die aufgerufen wird, um die Anwendung von Ereignissen oder Änderungen zu benachrichtigen, die in WeaveHeartbeatSender auftreten.
GetRequestAck() const
bool
Gibt eine Markierung zurück, die angibt, ob Heartbeat-Nachrichten zuverlässig mit Weave Reliable Messaging gesendet werden.
GetSubscriptionState() const
uint8_t
Ruft den Wert des aktuellen Abostatus ab.
Init(WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState)
Initialisieren Sie den Weave Heartbeat-Sender.
ScheduleHeartbeat(void)
Planen Sie das Senden von Weave Heartbeat-Nachrichten.
SendHeartbeatNow(void)
Sende jetzt eine Weave Heartbeat-Nachricht.
SetConfiguration(uint32_t interval, uint32_t phase, uint32_t window)
void
Konfiguration für Heartbeat-Timing festlegen.
SetEventCallback(EventCallback eventCallback)
void
Legt die Funktion fest, die aufgerufen wird, um die Anwendung über Ereignisse oder Änderungen zu informieren, die im WeaveHeartbeatSender auftreten.
SetRequestAck(bool val)
void
Legt ein Flag fest, das angibt, ob Heartbeat-Nachrichten zuverlässig mit Weave Reliable Messaging gesendet werden sollen.
SetSubscriptionState(uint8_t val)
void
Legen Sie den aktuellen Abostatus fest.
Shutdown(void)
Schalten Sie den Weave-Heartbeat-Sender aus.
StartHeartbeat(void)
Sende jetzt Weave-Heartbeat-Nachrichten.
StopHeartbeat(void)
Keine Weave-Heartbeat-Nachrichten mehr senden.

Öffentliche statische Funktionen
DefaultEventHandler(void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam)
void
Standard-Handler-Funktion für WeaveHeartbeatSender API-Ereignisse.

Strukturen
nl::Weave::Profiles::Heartbeat::WeaveHeartbeatSender::InEventParam

Eingabeparameter für das API-Ereignis WeaveHeartbeatSender.

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

Ausgabeparameter für das API-Ereignis WeaveHeartbeatSender.

Öffentliche Typen

EventCallback

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

EventType

 EventType
Attribute
kEvent_DefaultCheck

Wird verwendet, um die korrekte Verarbeitung von Standardereignissen in der Anwendung zu prüfen.

Anwendungen dürfen dieses Ereignis NICHT ausdrücklich behandeln.

kEvent_HeartbeatFailed

Eine Heartbeat-Nachricht konnte nicht an den Peer gesendet werden.

kEvent_HeartbeatSent

Eine Heartbeat-Nachricht wurde an den Peer gesendet.

Wenn eine zuverlässige Übertragung aktiviert ist, zeigt dieses Ereignis an, dass die Nachricht bestätigt wurde.

kEvent_UpdateSubscriptionState

Die Anwendung wird aufgefordert, den Abostatus zu aktualisieren.

Öffentliche Attribute

AppState

void * AppState

Öffentliche Funktionen

GetBinding

Binding * GetBinding() const

Ruft das Bindungsobjekt ab, das dem Heartbeat-Sender zugeordnet ist.

GetConfiguration

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

Heartbeat-Timing-Konfiguration abrufen.

Details
Parameter
[out] interval
Ein Verweis auf eine Ganzzahl, um das Heartbeat-Intervall zu erhalten.
[out] phase
Ein Verweis auf eine Ganzzahl, um die Heartbeat-Phase zu empfangen.
[out] window
Ein Verweis auf eine Ganzzahl, um das Heartbeat-Randomisierungsfenster zu erhalten.

GetEventCallback

EventCallback GetEventCallback() const

Gibt die Funktion zurück, die aufgerufen wird, um die Anwendung von Ereignissen oder Änderungen zu benachrichtigen, die in WeaveHeartbeatSender auftreten.

GetRequestAck

bool GetRequestAck() const

Gibt eine Markierung zurück, die angibt, ob Heartbeat-Nachrichten zuverlässig mit Weave Reliable Messaging gesendet werden.

GetSubscriptionState

uint8_t GetSubscriptionState() const

Ruft den Wert des aktuellen Abostatus ab.

Init

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

Initialisieren Sie den Weave Heartbeat-Sender.

Details
Parameter
[in] exchangeMgr
Ein Verweis auf das System Weave Exchange Manager.
[in] binding
Ein Zeiger auf ein Weave-Bindungsobjekt, mit dem der Peer-Knoten angesprochen wird.
[in] eventCallback
Ein Zeiger auf eine Funktion, die aufgerufen wird, um die Anwendung über Ereignisse oder Statusänderungen zu informieren, die beim Sender auftreten.
[in] appState
Ein Zeiger auf anwendungsspezifische Daten. Dieser Zeiger wird in Callbacks an die Anwendung zurückgegeben.
Rückgabewerte
WEAVE_ERROR_INCORRECT_STATE
Wenn das Objekt WeaveHeartbeatSender bereits initialisiert wurde.
WEAVE_ERROR_INVALID_ARGUMENT
Wenn eines der angegebenen Argumente null ist.
WEAVE_NO_ERROR
Bei Erfolg.

ScheduleHeartbeat

WEAVE_ERROR ScheduleHeartbeat(
  void
)

Planen Sie das Senden von Weave Heartbeat-Nachrichten.

Details
Rückgabewerte
WEAVE_SYSTEM_ERROR_NO_MEMORY
StartTimer() fehlgeschlagen
WEAVE_NO_ERROR
bei Erfolg

SendHeartbeatNow

WEAVE_ERROR SendHeartbeatNow(
  void
)

Sende jetzt eine Weave Heartbeat-Nachricht.

Details
Rückgabewerte
WEAVE_ERROR_INCORRECT_STATE
WeaveHeartbeatSender ist nicht initialisiert.
WEAVE_NO_ERROR
bei Erfolg

SetConfiguration

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

Konfiguration für Heartbeat-Timing festlegen.

Details
Parameter
[in] interval
Intervall, das beim Senden von Weave Heartbeat-Nachrichten verwendet werden soll.
[in] phase
Diese Phase wird beim Senden von Weave-Heartbeat-Nachrichten verwendet.
[in] window
Fensterbereich zur Auswahl eines zufälligen Intervalls

SetEventCallback

void SetEventCallback(
  EventCallback eventCallback
)

Legt die Funktion fest, die aufgerufen wird, um die Anwendung über Ereignisse oder Änderungen zu informieren, die im WeaveHeartbeatSender auftreten.

SetRequestAck

void SetRequestAck(
  bool val
)

Legt ein Flag fest, das angibt, ob Heartbeat-Nachrichten zuverlässig mit Weave Reliable Messaging gesendet werden sollen.

Beachten Sie, dass dieses Flag nur sinnvoll ist, wenn UDP als Transport verwendet wird.

Details
Parameter
[in] val
True, wenn Heartbeat-Nachrichten zuverlässig gesendet werden sollen.

SetSubscriptionState

void SetSubscriptionState(
  uint8_t val
)

Legen Sie den aktuellen Abostatus fest.

Details
Parameter
[in] val
Ein 8-Bit-Abostatuswert, der mit der Heartbeat-Nachricht übertragen werden soll.

Herunterfahren

WEAVE_ERROR Shutdown(
  void
)

Schalten Sie den Weave-Heartbeat-Sender aus.

Details
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.

StartHeartbeat

WEAVE_ERROR StartHeartbeat(
  void
)

Sende jetzt Weave-Heartbeat-Nachrichten.

Details
Rückgabewerte
INET_ERROR_NO_MEMORY
StartTimer() fehlgeschlagen
WEAVE_NO_ERROR
bei Erfolg

StopHeartbeat

WEAVE_ERROR StopHeartbeat(
  void
)

Keine Weave-Heartbeat-Nachrichten mehr senden.

Details
Rückgabewerte
WEAVE_NO_ERROR
bedingungslos

WeaveHeartbeatSender

 WeaveHeartbeatSender(
  void
)

Öffentliche statische Funktionen

DefaultEventHandler

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

Standard-Handler-Funktion für WeaveHeartbeatSender API-Ereignisse.

Anwendungen müssen diese Funktion für alle API-Ereignisse aufrufen, die sie nicht verarbeiten.