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

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

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

סיכום

בונים והורסים
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)
תזמון שליחת הודעות דופק ב-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'.
SetSubscriptionState(uint8_t val)
void
הגדרת המצב הנוכחי של המינוי.
Shutdown(void)
כבה את שולח קצב הלב של Weave.
StartHeartbeat(void)
מתחילים לשלוח הודעות דופק מ-Weave.
StopHeartbeat(void)
הפסק לשלוח הודעות פעימות לב של Weave.

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

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

מזינים פרמטרים לאירוע API WeaveHeartbeatSender.

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

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

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

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

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

הפעלה

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
)

תזמון שליחת הודעות דופק ב-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.
[in] phase
שלב לשימוש בעת שליחת הודעות דופק של Weave.
[in] window
טווח חלונות לשימוש לבחירת מרווח אקראי

SetEventCallback

void SetEventCallback(
  EventCallback eventCallback
)

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

SetRequestAck

void SetRequestAck(
  bool val
)

מגדיר סימון שמציין אם יש לשלוח הודעות של פעימת לב בצורה אמינה באמצעות התכונה 'העברת הודעות מהימנה של Weave'.

הערה: לסימון הזה יש משמעות רק כשמשתמשים ב-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
)

מתחילים לשלוח הודעות דופק מ-Weave.

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

StopHeartbeat

WEAVE_ERROR StopHeartbeat(
  void
)

הפסק לשלוח הודעות פעימות לב של Weave.

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

WeaveHeartbeatSender

 WeaveHeartbeatSender(
  void
)

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

DefaultEventHandler

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

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

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