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

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

Weave Heart לאפליקציה – מחלקת השולח.

סיכום

בנייה
WeaveHeartbeatSender(void)

סוגים ציבוריים
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)

מאפיינים ציבוריים
AppState
void *

פונקציות ציבוריות
GetBinding() const
מקבלים את האובייקט המקשר שמשויך לשולח של פעימות הלב.
GetConfiguration(uint32_t & interval, uint32_t & phase, uint32_t & window) const
void
קבלת תצורה של תזמון פעימות הלב.
GetEventCallback() const
EventCallback
מחזירה את הפונקציה שתתבצע כדי להודיע לאפליקציה של אירועים או שינויים שמתרחשים ב-WeaveHeartbeatSender.
GetRequestAck() const
bool
הפונקציה מחזירה דגל שמציין אם הודעות קצב הלב יישלחו באופן מהימן באמצעות Weave Trusted Messaging.
GetSubscriptionState() const
uint8_t
מקבלים את הערך הנוכחי של מצב המינוי.
Init(WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState)
אתחול השולח של דופק ב-Weave.
ScheduleHeartbeat(void)
תזמון של שליחת הודעות Heartbuy ב-Weave.
SendHeartbeatNow(void)
עליך לשלוח הודעת דופק של Weave עכשיו.
SetConfiguration(uint32_t interval, uint32_t phase, uint32_t window)
void
הגדרת תזמון פעימות הלב.
SetEventCallback(EventCallback eventCallback)
void
מגדיר את הפונקציה שתיקרא כדי להודיע לאפליקציה של אירועים או שינויים שמתרחשים ב-WeaveHeartbeatSender.
SetRequestAck(bool val)
void
מגדיר סימון שמציין אם הודעות קצב הלב יישלחו באופן מהימן באמצעות Weave Trusted Messaging.
SetSubscriptionState(uint8_t val)
void
מגדירים את מצב המינוי הנוכחי.
Shutdown(void)
מכבים את שולח הפעימות של Weave.
StartHeartbeat(void)
מתחילים לשלוח הודעות עם Heartbeat.
StopHeartbeat(void)
הפסקת השליחה של הודעות Heartb עם Weave.

פונקציות סטטיות ציבוריות
DefaultEventHandler(void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam)
void
פונקציית ה-handler שמוגדרת כברירת מחדל לאירועי WeaveHeartbeatSender.

מבנים
nl::Weave::Profiles::Heartbeat::WeaveHeartbeatSender::InEventParam

צריך להזין פרמטרים לאירוע WeaveHeartbeatSender ב-API.

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

פרמטרים של פלט לאירוע WeaveHeartbeatSender ב-API.

סוגים ציבוריים

EventCallback

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

EventType

 EventType
מאפיינים
kEvent_DefaultCheck

משמש לאימות הטיפול הנכון באירועים באפליקציה כברירת מחדל.

אפליקציות לא יטפלו באירוע הזה באופן מפורש.

kEvent_HeartbeatFailed

נשלחה הודעת קצב לב לעמית.

kEvent_HeartbeatSent

הודעת קצב נשלחה בהצלחה לעמית.

אם מופעל שידור מהימן, האירוע הזה מציין שההודעה אושרה.

kEvent_UpdateSubscriptionState

האפליקציה מבקשת לעדכן את מצב המינוי.

מאפיינים ציבוריים

AppState

void * AppState

פונקציות ציבוריות

GetBinding

Binding * GetBinding() const

מקבלים את האובייקט המקשר שמשויך לשולח של פעימות הלב.

GetConfiguration

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

קבלת תצורה של תזמון פעימות הלב.

פרטים
פרמטרים
[out] interval
הפניה למספר שלם לקבלת מרווח פעימות הלב.
[out] phase
הפניה למספר שלם לקבלת שלב פעימות הלב.
[out] window
הפניה למספר שלם לקבלת חלון הרנדומיזציה של פעימות הלב.

GetEventCallback

EventCallback GetEventCallback() const

מחזירה את הפונקציה שתתבצע כדי להודיע לאפליקציה של אירועים או שינויים שמתרחשים ב-WeaveHeartbeatSender.

GetRequestAck

bool GetRequestAck() const

הפונקציה מחזירה דגל שמציין אם הודעות קצב הלב יישלחו באופן מהימן באמצעות Weave Trusted Messaging.

GetSubscriptionState

uint8_t GetSubscriptionState() const

מקבלים את הערך הנוכחי של מצב המינוי.

Init

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

אתחול השולח של דופק ב-Weave.

פרטים
פרמטרים
[in] exchangeMgr
מצביע אל המערכת של Weave Exchange Manager.
[in] binding
מצביע לאובייקט קישור של Weave, שישמש לטיפול בצומת של אפליקציה להשוואה.
[in] eventCallback
מצביע אל פונקציה שתתבצע כדי ליידע את האפליקציה של אירועים או שינויי מצב שמתרחשים אצל השולח.
[in] appState
מצביע לנתונים ספציפיים לאפליקציה. המצביע הזה יוחזר בקריאות חוזרות לאפליקציה.
מוחזר ערכים
WEAVE_ERROR_INCORRECT_STATE
אם האובייקט WeaveHeartbeatSender כבר אותחל.
WEAVE_ERROR_INVALID_ARGUMENT
אם אחד מהארגומנטים הנתונים הוא null.
WEAVE_NO_ERROR
הצלחה.

ScheduleHeartbeat

WEAVE_ERROR ScheduleHeartbeat(
  void
)

תזמון של שליחת הודעות Heartbuy ב-Weave.

פרטים
מוחזר ערכים
WEAVE_SYSTEM_ERROR_NO_MEMORY
אם StartTimer() נכשל
WEAVE_NO_ERROR
להצלחה

SendHeartbeatNow

WEAVE_ERROR SendHeartbeatNow(
  void
)

עליך לשלוח הודעת דופק של Weave עכשיו.

פרטים
מוחזר ערכים
WEAVE_ERROR_INCORRECT_STATE
אם הפונקציה WeaveHeartbeatSender לא מאותרת
WEAVE_NO_ERROR
להצלחה

SetConfiguration

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

הגדרת תזמון פעימות הלב.

פרטים
פרמטרים
[in] interval
מרווח הזמן שבו יש להשתמש לשליחת הודעות של Weave Heartbeat.
[in] phase
השלב לשימוש כששולחים הודעות של Weave Heartbeat.
[in] window
טווח חלונות לשימוש לבחירת מרווח אקראי

SetEventCallback

void SetEventCallback(
  EventCallback eventCallback
)

מגדיר את הפונקציה שתיקרא כדי להודיע לאפליקציה של אירועים או שינויים שמתרחשים ב-WeaveHeartbeatSender.

SetRequestAck

void SetRequestAck(
  bool val
)

מגדיר סימון שמציין אם הודעות קצב הלב יישלחו באופן מהימן באמצעות Weave Trusted Messaging.

לתשומת ליבכם: לדגל הזה יש משמעות רק כשמשתמשים ב-UDP כהעברה.

פרטים
פרמטרים
[in] val
הערך הוא True אם הודעות על פעימות הלב צריכות להישלח באופן מהימן.

SetSubscriptionState

void SetSubscriptionState(
  uint8_t val
)

מגדירים את מצב המינוי הנוכחי.

פרטים
פרמטרים
[in] val
ערך של מצב מינוי ב-8 ביט שיועבר עם הודעת קצב הלב.

כיבוי

WEAVE_ERROR Shutdown(
  void
)

מכבים את שולח הפעימות של Weave.

פרטים
מוחזר ערכים
WEAVE_NO_ERROR
הצלחה.

StartHeartbeat

WEAVE_ERROR StartHeartbeat(
  void
)

מתחילים לשלוח הודעות עם Heartbeat.

פרטים
מוחזר ערכים
INET_ERROR_NO_MEMORY
אם StartTimer() נכשל
WEAVE_NO_ERROR
להצלחה

StopHeartbeat

WEAVE_ERROR StopHeartbeat(
  void
)

הפסקת השליחה של הודעות Heartb עם Weave.

פרטים
מוחזר ערכים
WEAVE_NO_ERROR
ללא תנאים

WeaveHeartbeatSender

 WeaveHeartbeatSender(
  void
)

פונקציות סטטיות ציבוריות

DefaultEventHandler

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

פונקציית ה-handler שמוגדרת כברירת מחדל לאירועי WeaveHeartbeatSender.

אפליקציות חייבות לקרוא לפונקציה הזו לכל אירועי API שהן לא מטפלות בהן.