nl::Weave::Profiles::Heartbeat::WeaveHeartbeatSender
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
#include <src/lib/profiles/heartbeat/WeaveHeartbeat.h>
Klasa nadawcy Weave Heartbeat.
Podsumowanie
Konstruktory i niszczyciele |
|
---|---|
WeaveHeartbeatSender(void)
|
Typy publiczne |
|
---|---|
EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
|
typedefvoid(*
|
EventType{
|
enum | typ wyliczeniowy |
Atrybuty publiczne |
|
---|---|
AppState
|
void *
|
Funkcje publiczne |
|
---|---|
GetBinding() const
|
Binding *
Pobierz obiekt powiązania powiązany z nadawcą pakietów podtrzymujących.
|
GetConfiguration(uint32_t & interval, uint32_t & phase, uint32_t & window) const
|
void
Uzyskanie konfiguracji czasu pakietów podtrzymujących.
|
GetEventCallback() const
|
EventCallback
Zwraca funkcję, która będzie wywoływana w celu powiadamiania aplikacji o zdarzeniach lub zmianach występujących w elemencie WeaveHeartbeatSender.
|
GetRequestAck() const
|
bool
Zwraca flagę wskazującą, czy wiadomości typu „heartbeat” będą prawidłowo wysyłane przy użyciu Weave Reliable Messaging.
|
GetSubscriptionState() const
|
uint8_t
Pobierz wartość bieżącego stanu subskrypcji.
|
Init(WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState)
|
Zainicjuj nadawcę Heartbeat Weave.
|
ScheduleHeartbeat(void)
|
Zaplanuj wysyłanie wiadomości z weave Heartbeat.
|
SendHeartbeatNow(void)
|
Wyślij teraz wiadomość Heartbeat weave.
|
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 o zdarzeniach lub zmianach występujących w WeaveHeartbeatSender.
|
SetRequestAck(bool val)
|
void
Ustawia flagę wskazującą, czy wiadomości „heartbeat” mają być niezawodnie wysyłane przy użyciu Weave Reliable Messaging.
|
SetSubscriptionState(uint8_t val)
|
void
Ustaw bieżący stan subskrypcji.
|
Shutdown(void)
|
Wyłącz nadawcę Heartbeat Weave.
|
StartHeartbeat(void)
|
Zacznij wysyłać wiadomości Heartbeat weave.
|
StopHeartbeat(void)
|
Przestań wysyłać wiadomości Heartbeat do Weave.
|
Publiczne funkcje statyczne |
|
---|---|
DefaultEventHandler(void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam)
|
void
Domyślna funkcja obsługi zdarzeń interfejsu API WeaveHeartbeatSender.
|
Struktura |
|
---|---|
nl:: |
Dane wejściowe zdarzenia interfejsu API WeaveHeartbeatSender. |
nl:: |
Parametry wyjściowe zdarzenia interfejsu 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 weryfikacji prawidłowej domyślnej obsługi zdarzeń w aplikacji. Aplikacje NIE powinny obsługiwać tego zdarzenia wprost. |
kEvent_HeartbeatFailed
|
Nie udało się wysłać wiadomości „heartbeat” do elementu równorzędnego. |
kEvent_HeartbeatSent
|
Wiadomość podtrzymująca została wysłana do elementu równorzędnego. Jeśli włączona jest niezawodna transmisja, to zdarzenie wskazuje, że wiadomość została potwierdzony. |
kEvent_UpdateSubscriptionState
|
Do aplikacji zażądano zaktualizowania stanu subskrypcji. |
Atrybuty publiczne
AppState
void * AppState
Funkcje publiczne
GetBinding
Binding * GetBinding() const
Pobierz obiekt powiązania powiązany z nadawcą pakietów podtrzymujących.
GetConfiguration
void GetConfiguration(
uint32_t & interval,
uint32_t & phase,
uint32_t & window
) const
Uzyskanie konfiguracji czasu pakietów podtrzymujących.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
GetEventCallback
EventCallback GetEventCallback() const
Zwraca funkcję, która będzie wywoływana w celu powiadamiania aplikacji o zdarzeniach lub zmianach występujących w elemencie WeaveHeartbeatSender.
GetRequestAck
bool GetRequestAck() const
Zwraca flagę wskazującą, czy wiadomości typu „heartbeat” będą prawidłowo wysyłane przy użyciu Weave Reliable Messaging.
GetSubscriptionState
uint8_t GetSubscriptionState() const
Pobierz wartość bieżącego stanu subskrypcji.
Init
WEAVE_ERROR Init(
WeaveExchangeManager *exchangeMgr,
Binding *binding,
EventCallback eventCallback,
void *appState
)
Zainicjuj nadawcę Heartbeat Weave.
Szczegóły | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||
Zwracane wartości |
|
ScheduleHeartbeat
WEAVE_ERROR ScheduleHeartbeat(
void
)
Zaplanuj wysyłanie wiadomości z weave Heartbeat.
Szczegóły | |||||
---|---|---|---|---|---|
Zwracane wartości |
|
SendHeartbeatNow
WEAVE_ERROR SendHeartbeatNow(
void
)
Wyślij teraz wiadomość Heartbeat weave.
Szczegóły | |||||
---|---|---|---|---|---|
Zwracane wartości |
|
SetConfiguration
void SetConfiguration(
uint32_t interval,
uint32_t phase,
uint32_t window
)
Ustaw konfigurację czasu pakietów podtrzymujących.
SetEventCallback
void SetEventCallback(
EventCallback eventCallback
)
Ustawia funkcję, która będzie wywoływana w celu powiadamiania o zdarzeniach lub zmianach występujących w WeaveHeartbeatSender.
SetRequestAck
void SetRequestAck(
bool val
)
Ustawia flagę wskazującą, czy wiadomości „heartbeat” mają być niezawodnie wysyłane przy użyciu Weave Reliable Messaging.
Pamiętaj, że ta flaga ma znaczenie tylko wtedy, gdy jako transportu używasz UDP.
Szczegóły | |||
---|---|---|---|
Parametry |
|
SetSubscriptionState
void SetSubscriptionState(
uint8_t val
)
Ustaw bieżący stan subskrypcji.
Szczegóły | |||
---|---|---|---|
Parametry |
|
Wyłączono
WEAVE_ERROR Shutdown(
void
)
StartHeartbeat
WEAVE_ERROR StartHeartbeat(
void
)
Zacznij wysyłać wiadomości Heartbeat weave.
Szczegóły | |||||
---|---|---|---|---|---|
Zwracane wartości |
|
StopHeartbeat
WEAVE_ERROR StopHeartbeat(
void
)
Przestań wysyłać wiadomości Heartbeat do Weave.
Szczegóły | |||
---|---|---|---|
Zwracane wartości |
|
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órych nie obsługują.