nl::Weave::Profiles::DeviceControl::DeviceControlDelegate

זהו שיעור מופשט.

#include <src/lib/profiles/device-control/DeviceControl.h>

הענקת גישה למחלקה להטמעת פעולות נכנסות של בקרת מכשירים (Device Control) במכשיר השרת.

סיכום

ירושה

עובר בירושה מ: nl::Weave::WeaveServerDelegateBase
מחלקות משנה מוכרות ישירות: nl::Weave::DeviceLayer::Internal::DeviceControlServer

פונקציות ציבוריות
EnforceAccessControl(ExchangeContext *ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo *msgInfo, AccessControlResult & result)
virtual void
אכיפה של בקרת גישה ברמת ההודעה עבור הודעת בקשה נכנסת של DeviceControl.
IsPairedToAccount() const
virtual bool
בוצעה שיחה כדי לקבוע אם המכשיר מותאם כרגע לחשבון.
IsResetAllowed(uint16_t resetFlags)=0
virtual bool
עליך לבדוק אם מותר לאפס את ההגדרות האישיות שצוינו.
OnConnectionMonitorTimeout(uint64_t peerNodeId, IPAddress peerAddr)=0
virtual void
מציין שהזמן הקצוב לתפוגה של צג החיבור הסתיים.
OnFailSafeArmed(void)=0
virtual WEAVE_ERROR
הסיבה לכך היא שהגדרת המכשיר נכשלה באופן בטוח.
OnFailSafeDisarmed(void)=0
virtual WEAVE_ERROR
ציון שהבטיחות של הגדרת המכשיר כושלה.
OnRemotePassiveRendezvousDone(void)=0
virtual void
מציין שתהליך 'סדר פסיבי' מרחוק הסתיים.
OnRemotePassiveRendezvousStarted(void)=0
virtual void
מציין שתהליך 'סדר פסיבי' מרחוק התחיל.
OnResetConfig(uint16_t resetFlags)=0
virtual WEAVE_ERROR
איפוס של כל הגדרות המכשיר או חלק מהן.
OnSystemTestStarted(uint32_t profileId, uint32_t testId)=0
virtual WEAVE_ERROR
מפעילים את בדיקת המערכת שצוינה.
OnSystemTestStopped(void)=0
virtual WEAVE_ERROR
עוצרים את בדיקת המערכת שמתבצעת.
ShouldCloseConBeforeResetConfig(uint16_t resetFlags)=0
virtual bool
המדיניות הזו קובעת אם צריך לסגור חיבור לשרת, אם קיים, לפני איפוס של ההגדרות.
WillCloseRemotePassiveRendezvous(void)=0
virtual void
מתכוננים להפסקת המצב הפסיבי מרחוק.
WillStartRemotePassiveRendezvous(void)=0
virtual WEAVE_ERROR
מתכוננים למפגש פסיבי מרחוק.

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

EnforceAccessControl

virtual void EnforceAccessControl(
  ExchangeContext *ec,
  uint32_t msgProfileId,
  uint8_t msgType,
  const WeaveMessageInfo *msgInfo,
  AccessControlResult & result
)

אכיפה של בקרת גישה ברמת ההודעה עבור הודעת בקשה נכנסת של DeviceControl.

פרטים
פרמטרים
[in] ec
ה-ExchangeContext שממנו ההודעה התקבלה.
[in] msgProfileId
מזהה הפרופיל של ההודעה שהתקבלה.
[in] msgType
סוג ההודעה של ההודעה שהתקבלה.
[in] msgInfo
מבנה מסוג WeaveMessageInfo שמכיל מידע על ההודעה שהתקבלה.
[in,out] result
ערך מורחב שמתאר את התוצאה של הערכת מדיניות בקרת הגישה עבור ההודעה שהתקבלה. כשנכנסים לשיטה, הערך מייצג את התוצאה הטנטטיבית בנקודה הנוכחית של תהליך ההערכה. לאחר החזרה, התוצאה צפויה לייצג את ההערכה הסופית של מדיניות בקרת הגישה של ההודעה.

IsPairedToAccount

virtual bool IsPairedToAccount() const

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

IsResetAllowed

virtual bool IsResetAllowed(
  uint16_t resetFlags
)=0

עליך לבדוק אם מותר לאפס את ההגדרות האישיות שצוינו.

פרטים
פרמטרים
[in] resetFlags
הדגלים שמציינים את ההגדרות האישיות שצריך לאפס.
מוחזר ערכים
TRUE
אם מותר לאפס את התצורה.
FALSE
אם איפוס התצורה אסור.

OnConnectionMonitorTimeout

virtual void OnConnectionMonitorTimeout(
  uint64_t peerNodeId,
  IPAddress peerAddr
)=0

מציין שהזמן הקצוב לתפוגה של צג החיבור הסתיים.

מתבצעת קריאה לפונקציה הזו כשמסתיים הזמן הקצוב לתפוגה של 'צג החיבור', כלומר כשלא זוהו בדיקות של פעילות (liveness) מהמארח המרוחק במשך פרק זמן מסוים.

פרטים
פרמטרים
[in] peerNodeId
מזהה הצומת של הרשת השכנה מרחוק שאליה פג הזמן הקצוב לתפוגה של חיבור בזמן אמת.
[in] peerAddr
הכתובת של האפליקציות להשוואה מרחוק.

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
)=0

הסיבה לכך היא שהגדרת המכשיר נכשלה באופן בטוח.

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

פרטים
מוחזר ערכים
WEAVE_NO_ERROR
הצלחה.
other
קודי שגיאה אחרים של Weave או פלטפורמה ספציפית, שמציינים שאירעה שגיאה שמונעת את בטיחות הכשל.

OnFailSafeDisarmed

virtual WEAVE_ERROR OnFailSafeDisarmed(
  void
)=0

ציון שהבטיחות של הגדרת המכשיר כושלה.

מתבצעת קריאה לפונקציה הזו כשהגדרת המכשיר השרת 'נכשלה' במצב בטוח בתגובה לבקשה מהלקוח. לאחר השלמת ההגדרה, הלקוח ינטרל את הבטיחות של הכשל.

פרטים
מוחזר ערכים
WEAVE_NO_ERROR
הצלחה.
other
קודי שגיאה אחרים של Weave או פלטפורמה ספציפית, שמציינים שאירעה שגיאה שמונעת את נטרול אמצעי הביטחון של מכשיר הכשל.

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
)=0

מציין שתהליך 'סדר פסיבי' מרחוק הסתיים.

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
)=0

מציין שתהליך 'סדר פסיבי' מרחוק התחיל.

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
)=0

איפוס של כל הגדרות המכשיר או חלק מהן.

היישום של הפונקציה הזו צפוי לאפס כל שילוב של רשת, מבד Weave או הגדרות שירות למצב ידוע, בהתאם לדגלי האיפוס.

פרטים
פרמטרים
[in] resetFlags
הדגלים שמציינים את ההגדרות האישיות שצריך לאפס.
מוחזר ערכים
WEAVE_NO_ERROR
הצלחה.
other
קודי שגיאה אחרים של Weave או פלטפורמה ספציפית, שמציינים שאירעה שגיאה המונעת מהמכשיר לאפס את הגדרות התצורה שלו.

OnSystemTestStarted

virtual WEAVE_ERROR OnSystemTestStarted(
  uint32_t profileId,
  uint32_t testId
)=0

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

פרטים
פרמטרים
[in] profileId
מזהה הפרופיל של הבדיקה המבוקשת.
[in] testId
מזהה הבדיקה המבוקשת.
מוחזר ערכים
WEAVE_NO_ERROR
הצלחה.
other
קודי שגיאה אחרים של Weave או פלטפורמה ספציפית, שמצביעים על כך שאירעה שגיאה שמונעת את ההתחלה של בדיקת המערכת.

OnSystemTestStopped

virtual WEAVE_ERROR OnSystemTestStopped(
  void
)=0

מפסיקים את בדיקת המערכת שמתבצעת.

פרטים
מוחזר ערכים
WEAVE_NO_ERROR
הצלחה.
other
קודי שגיאה אחרים של Weave או פלטפורמה ספציפית, שמציינים שאירעה שגיאה שמונעת את העצירה של בדיקת המערכת.

ShouldCloseConBeforeResetConfig

virtual bool ShouldCloseConBeforeResetConfig(
  uint16_t resetFlags
)=0

המדיניות הזו קובעת אם צריך לסגור חיבור לשרת, אם קיים, לפני איפוס של ההגדרות.

הפונקציה הזו משמשת כדי להריץ שאילתה על בעל הגישה לגבי ההתנהגות הרצויה במהלך עיבוד בקשה לאיפוס הגדרה. אם יש כרגע חיבור לשרת פעיל, תגובת TRUE לשיטה הזו תגרום לסגירת החיבור לפני הפעלת איפוס ההגדרות באמצעות שיטת OnResetConfig.

פרטים
פרמטרים
[in] resetFlags
הדגלים שמציינים את ההגדרות האישיות שצריך לאפס.
מוחזר ערכים
true
אם צריך לסגור את החיבור.
false
אם לא צריך לסגור את החיבור.

WillCloseRemotePassiveRendezvous

virtual void WillCloseRemotePassiveRendezvous(
  void
)=0

מתכוננים להפסקת המצב הפסיבי מרחוק.

למידע נוסף:
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
)=0

מתכוננים למפגש פסיבי מרחוק.

לדוגמה, להפוך את הרשת 15.4/Thread לניתנת להצטרפות.

פרטים
מוחזר ערכים
WEAVE_NO_ERROR
הצלחה.
other
קודי שגיאה אחרים של Weave או פלטפורמה ספציפית, שמציינים שאירעה שגיאה במהלך ההכנות להפעלת Rendezvous מרחוק.