Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

nl::Weave::Profile::Heartbeat::WeaveHeartbeatSender

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

Weave Heartbeat Sender-Kurs.

Fazit

Konstrukteur und Zerstörer

WeaveHeartbeatSender(void)

Öffentliche Typen

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

Öffentliche Attribute

AppState
void *

Öffentliche Funktionen

GetBinding() const
Rufen Sie das Bindungsobjekt ab, das mit dem Heartbeat-Absender verknüpft ist.
GetConfiguration(uint32_t & interval, uint32_t & phase, uint32_t & window) const
void
Konfiguration des Rhythmus der Herzfrequenz abrufen.
GetEventCallback() const
EventCallback
Gibt die Funktion zurück, die aufgerufen wird, um die Anwendung von Ereignissen oder Änderungen im WeaveHeartbeatSender zu benachrichtigen.
GetRequestAck() const
bool
Gibt ein Flag zurück, das angibt, ob Nachrichten mit Weave-Zuverlässigkeits-Messaging zuverlässig gesendet werden.
GetSubscriptionState() const
uint8_t
Aktuellen Wert des Abostatus abrufen
Init(WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState)
Initialisieren Sie den Weave-Sender.
ScheduleHeartbeat(void)
Senden von Weave-Nachrichten vom Typ Heartbeat planen
SendHeartbeatNow(void)
Sende jetzt eine Weave-Heartbeat-Nachricht.
SetConfiguration(uint32_t interval, uint32_t phase, uint32_t window)
void
Konfiguration des Rhythmus der Herzfrequenz festlegen
SetEventCallback(EventCallback eventCallback)
void
Legt die Funktion fest, die aufgerufen wird, um die Anwendung von Ereignissen oder Änderungen im WeaveHeartbeatSender zu benachrichtigen.
SetRequestAck(bool val)
void
Legt ein Flag fest, das angibt, ob Nachrichten mit Weave Zuverlässige Messaging zuverlässig gesendet werden sollen.
SetSubscriptionState(uint8_t val)
void
Aktuellen Abostatus festlegen.
Shutdown(void)
Sender von Weave Heartbeat herunterfahren.
StartHeartbeat(void)
Beginne mit dem Senden von Weave-Heartbeat-Nachrichten.
StopHeartbeat(void)
Senden von Weave-Heartbeat-Nachrichten beenden

Öffentliche statische Funktionen

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

Strebenklemmen

nl::Weave::Profile::Heartbeat::WeaveHeartbeatSender::InEventParam

Eingabeparameter für das API-Ereignis WeaveHeartbeatSender.

nl::Weave::Profile::Heartbeat::WeaveHeartbeatSender::OutEventParam

Ausgabeparameter an das API-Ereignis WeaveHeartbeatSender.

Öffentliche Typen

Ereignis-Callback

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

EventType

 EventType
Attribute
kEvent_DefaultCheck

Wird verwendet, um die korrekte standardmäßige Ereignisverarbeitung in der Anwendung zu prüfen.

Apps dürfen dieses Ereignis NICHT explizit verarbeiten.

kEvent_HeartbeatFailed

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

kEvent_HeartbeatSent

Eine Heartbeat-Nachricht wurde an den Peer gesendet.

Wenn die 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

App-Status

void * AppState

Öffentliche Funktionen

GetBindung

Binding * GetBinding() const 

Rufen Sie das Bindungsobjekt ab, das mit dem Heartbeat-Absender verknüpft ist.

GetConfiguration

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

Konfiguration des Rhythmus der Herzfrequenz abrufen.

Details
Parameter
[out] interval
Ein Verweis auf eine Ganzzahl für das Empfang des Heartbeat-Intervalls.
[out] phase
Ein Verweis auf eine Ganzzahl zum Empfangen der Heartbeat-Phase.
[out] window
Ein Verweis auf eine Ganzzahl für das Empfangen der zufälligen Zufallssequenz.

GetEventCallback

EventCallback GetEventCallback() const 

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

GetRequestAck

bool GetRequestAck() const 

Gibt ein Flag zurück, das angibt, ob Nachrichten mit Weave-Zuverlässigkeits-Messaging zuverlässig gesendet werden.

Abostatus abrufen

uint8_t GetSubscriptionState() const 

Aktuellen Wert des Abostatus abrufen

Init

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

Initialisieren Sie den Weave-Sender.

Details
Parameter
[in] exchangeMgr
Ein Hinweis auf das System Weave Exchange Manager.
[in] binding
Ein Zeiger auf ein Weave-Bindungsobjekt, der zur Adressierung des Peer-Knotens verwendet wird.
[in] eventCallback
Ein Zeiger auf eine Funktion, die aufgerufen wird, um die Anwendung von Ereignissen oder Statusänderungen beim Sender zu benachrichtigen.
[in] appState
Ein Hinweis 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
Erfolg.

Planet Heartbeat

WEAVE_ERROR ScheduleHeartbeat(
  void
)

Senden von Weave-Nachrichten vom Typ Heartbeat planen

Details
Rückgabewerte
WEAVE_SYSTEM_ERROR_NO_MEMORY
Wenn StartTimer() fehlgeschlagen ist
WEAVE_NO_ERROR
Erfolg

Herzschlagschlag

WEAVE_ERROR SendHeartbeatNow(
  void
)

Sende jetzt eine Weave-Heartbeat-Nachricht.

Details
Rückgabewerte
WEAVE_ERROR_INCORRECT_STATE
Wenn WeaveHeartbeatSender nicht initialisiert wurde
WEAVE_NO_ERROR
Erfolg

Set-Konfiguration

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

Konfiguration des Rhythmus der Herzfrequenz festlegen

Details
Parameter
[in] interval
Intervall, das beim Senden von Weave-Heartbeat-Nachrichten verwendet wird.
[in] phase
Phase zum Senden von Weave-Heartbeat-Nachrichten.
[in] window
Zeitraum für die Auswahl eines zufälligen Intervalls

SetEventCallback

void SetEventCallback(
  EventCallback eventCallback
)

Legt die Funktion fest, die aufgerufen wird, um die Anwendung von Ereignissen oder Änderungen im WeaveHeartbeatSender zu benachrichtigen.

SetRequestAck

void SetRequestAck(
  bool val
)

Legt ein Flag fest, das angibt, ob Nachrichten mit Weave Zuverlässige Messaging zuverlässig 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.

Abo-Abostatus

void SetSubscriptionState(
  uint8_t val
)

Aktuellen Abostatus festlegen.

Details
Parameter
[in] val
Ein 8-Bit-Abostatus, der mit der Heartbeat-Nachricht vermittelt wird.

Heruntergefahren

WEAVE_ERROR Shutdown(
  void
)

Sender von Weave Heartbeat herunterfahren.

Details
Rückgabewerte
WEAVE_NO_ERROR
Erfolg.

Herzschlagschlag

WEAVE_ERROR StartHeartbeat(
  void
)

Beginne mit dem Senden von Weave-Heartbeat-Nachrichten.

Details
Rückgabewerte
INET_ERROR_NO_MEMORY
Wenn StartTimer() fehlgeschlagen ist
WEAVE_NO_ERROR
Erfolg

Stoppherzschlag

WEAVE_ERROR StopHeartbeat(
  void
)

Senden von Weave-Heartbeat-Nachrichten beenden

Details
Rückgabewerte
WEAVE_NO_ERROR
bedingungslos

WeaveHeartbeatAbsender

 WeaveHeartbeatSender(
  void
)

Öffentliche statische Funktionen

Standard-EventHandler

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.