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

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

Weave Heartbeat – klasę nadawcy.

Podsumowanie

Konstruktorzy i niszczyciele
WeaveHeartbeatSender(void)

Typy publiczne
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 | typ wyliczeniowy

Atrybuty publiczne
AppState
void *

Funkcje publiczne
GetBinding() const
Pobierz obiekt powiązania powiązany z nadawcą pakietu podtrzymującego.
GetConfiguration(uint32_t & interval, uint32_t & phase, uint32_t & window) const
void
Pobranie konfiguracji czasu pakietów podtrzymujących.
GetEventCallback() const
EventCallback
Zwraca funkcję, która zostanie wywołana w celu powiadomienia aplikacji o zdarzeniach lub zmianach zachodzących w elemencie WeaveHeartbeatSender.
GetRequestAck() const
bool
Zwraca flagę wskazującą, czy wiadomości „heartbeat” będą wysyłane niezawodnie za pomocą Weave Reliable Messaging.
GetSubscriptionState() const
uint8_t
Pobierz bieżącą wartość stanu subskrypcji.
Init(WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState)
Inicjowanie nadawcy Weave Heartbeat.
ScheduleHeartbeat(void)
Zaplanuj wysyłanie wiadomości w aplikacji Weave Heartbeat.
SendHeartbeatNow(void)
Wyślij teraz wiadomość z funkcją Weave Heartbeat.
SetConfiguration(uint32_t interval, uint32_t phase, uint32_t window)
void
Ustaw konfigurację czasu pakietów podtrzymujących.
SetEventCallback(EventCallback eventCallback)
void
Ustawia funkcję, która będzie wywoływana w celu powiadamiania aplikacji o zdarzeniach lub zmianach zachodzących w elemencie WeaveHeartbeatSender.
SetRequestAck(bool val)
void
Ustawia flagę wskazującą, czy wiadomości podtrzymujące powinny być wysyłane niezawodnie za pomocą Weave Reliable Messaging.
SetSubscriptionState(uint8_t val)
void
Ustaw bieżący stan subskrypcji.
Shutdown(void)
Wyłącz nadawcę Weave Heartbeat.
StartHeartbeat(void)
Zacznij wysyłać wiadomości w aplikacji Weave Heartbeat.
StopHeartbeat(void)
Przestań wysyłać wiadomości z Weave Heartbeat.

Publiczne funkcje statyczne
DefaultEventHandler(void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam)
void
Domyślna funkcja obsługi zdarzeń interfejsu API WeaveHeartbeatSender.

Konstrukcja
nl::Weave::Profiles::Heartbeat::WeaveHeartbeatSender::InEventParam

Parametry wejściowe zdarzenia w interfejsie API WeaveHeartbeatSender.

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

Parametry wyjściowe zdarzenia w interfejsie API WeaveHeartbeatSender.

Typy publiczne

EventCallback

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

EventType

 EventType
Właściwości
kEvent_DefaultCheck

Służy do weryfikowania prawidłowej domyślnej obsługi zdarzeń w aplikacji.

Aplikacje NIE powinny wyraźnie obsługiwać tego zdarzenia.

kEvent_HeartbeatFailed

Nie udało się wysłać wiadomości podtrzymującej do peera.

kEvent_HeartbeatSent

Wiadomość podtrzymująca została wysłana do peera.

Jeśli włączona jest niezawodna transmisja, to zdarzenie wskazuje, że wiadomość została potwierdzona.

kEvent_UpdateSubscriptionState

Aplikacja prosi o zaktualizowanie stanu subskrypcji.

Atrybuty publiczne

AppState

void * AppState

Funkcje publiczne

GetBinding

Binding * GetBinding() const

Pobierz obiekt powiązania powiązany z nadawcą pakietu podtrzymującego.

GetConfiguration

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

Pobranie konfiguracji czasu pakietów podtrzymujących.

Szczegóły
Parametry
[out] interval
Odwołanie do liczby całkowitej umożliwiającej otrzymanie odstępu między uderzeniami serca.
[out] phase
Odwołanie do liczby całkowitej umożliwiającej otrzymanie fazy pakietu podtrzymującego.
[out] window
Odwołanie do liczby całkowitej umożliwiającej otrzymanie okna randomizacji rytmu serca.

GetEventCallback

EventCallback GetEventCallback() const

Zwraca funkcję, która zostanie wywołana w celu powiadomienia aplikacji o zdarzeniach lub zmianach zachodzących w elemencie WeaveHeartbeatSender.

GetRequestAck

bool GetRequestAck() const

Zwraca flagę wskazującą, czy wiadomości „heartbeat” będą wysyłane niezawodnie za pomocą Weave Reliable Messaging.

GetSubscriptionState

uint8_t GetSubscriptionState() const

Pobierz bieżącą wartość stanu subskrypcji.

Zainicjuj

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

Inicjowanie nadawcy Weave Heartbeat.

Szczegóły
Parametry
[in] exchangeMgr
Wskaźnik do systemowego menedżera wymiany Weave Exchange.
[in] binding
Wskaźnik do obiektu powiązania Weave, który będzie używany do adresowania węzła równorzędnego.
[in] eventCallback
Wskaźnik do funkcji, która zostanie wywołana w celu powiadomienia aplikacji o zdarzeniach lub zmianach stanu u nadawcy.
[in] appState
Wskaźnik do danych specyficznych dla aplikacji. Wskaźnik ten będzie zwracany podczas wywołań zwrotnych do aplikacji.
Zwracane wartości
WEAVE_ERROR_INCORRECT_STATE
Jeśli obiekt WeaveHeartbeatSender został już zainicjowany.
WEAVE_ERROR_INVALID_ARGUMENT
Jeśli dowolny z podanych argumentów ma wartość null.
WEAVE_NO_ERROR
Na sukces.

ScheduleHeartbeat

WEAVE_ERROR ScheduleHeartbeat(
  void
)

Zaplanuj wysyłanie wiadomości w aplikacji Weave Heartbeat.

Szczegóły
Zwracane wartości
WEAVE_SYSTEM_ERROR_NO_MEMORY
jeśli funkcja StartTimer() nie powiodła się
WEAVE_NO_ERROR
po pomyślnym zakończeniu

SendHeartbeatNow

WEAVE_ERROR SendHeartbeatNow(
  void
)

Wyślij teraz wiadomość z funkcją Weave Heartbeat.

Szczegóły
Zwracane wartości
WEAVE_ERROR_INCORRECT_STATE
jeśli WeaveHeartbeatSender nie zostanie zainicjowana
WEAVE_NO_ERROR
po pomyślnym zakończeniu

SetConfiguration

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

Ustaw konfigurację czasu pakietów podtrzymujących.

Szczegóły
Parametry
[in] interval
Interwał używany podczas wysyłania wiadomości Heartbeat weave.
[in] phase
Etap, który ma być używany podczas wysyłania wiadomości Heartbeat funkcji Weave.
[in] window
Zakres okna do wyboru przedziału czasu

SetEventCallback

void SetEventCallback(
  EventCallback eventCallback
)

Ustawia funkcję, która będzie wywoływana w celu powiadamiania aplikacji o zdarzeniach lub zmianach zachodzących w elemencie WeaveHeartbeatSender.

SetRequestAck

void SetRequestAck(
  bool val
)

Ustawia flagę wskazującą, czy wiadomości podtrzymujące powinny być wysyłane niezawodnie za pomocą Weave Reliable Messaging.

Pamiętaj, że ta flaga ma znaczenie tylko wtedy, gdy jako transport używasz UDP.

Szczegóły
Parametry
[in] val
Wartość to „prawda”, jeśli wiadomości podtrzymujące powinny być wysyłane w sposób niezawodny.

SetSubscriptionState

void SetSubscriptionState(
  uint8_t val
)

Ustaw bieżący stan subskrypcji.

Szczegóły
Parametry
[in] val
8-bitowa wartość stanu subskrypcji do przekazania wraz z wiadomością podtrzymującą.

Wyłączono

WEAVE_ERROR Shutdown(
  void
)

Wyłącz nadawcę Weave Heartbeat.

Szczegóły
Zwracane wartości
WEAVE_NO_ERROR
Na sukces.

StartHeartbeat

WEAVE_ERROR StartHeartbeat(
  void
)

Zacznij wysyłać wiadomości w aplikacji Weave Heartbeat.

Szczegóły
Zwracane wartości
INET_ERROR_NO_MEMORY
jeśli funkcja StartTimer() nie powiodła się
WEAVE_NO_ERROR
po pomyślnym zakończeniu

StopHeartbeat

WEAVE_ERROR StopHeartbeat(
  void
)

Przestań wysyłać wiadomości z Weave Heartbeat.

Szczegóły
Zwracane wartości
WEAVE_NO_ERROR
bezwarunkowo

WeaveHeartbeatSender

 WeaveHeartbeatSender(
  void
)

Publiczne funkcje statyczne

DefaultEventHandler

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

Domyślna funkcja obsługi zdarzeń interfejsu API WeaveHeartbeatSender.

Aplikacje muszą wywoływać tę funkcję w przypadku wszystkich zdarzeń interfejsu API, które nie obsługują.