nl::Weave::Profiles::DeviceDescription::DeviceDescriptionClient

#include <src/lib/profiles/device-description/DeviceDescription.h>

אובייקט לקוח לשליחת בקשות לתיאור המכשיר.

סיכום

בנייה
DeviceDescriptionClient(void)

סוגים ציבוריים
HandleIdentifyResponseFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg) typedef
void(*
הפונקציה הזו אחראית לעיבוד הודעות IdentityResponse.

מאפיינים ציבוריים
AppState
void *
אובייקט מצב המוגדר באפליקציה.
ExchangeMgr
[לקריאה בלבד] אובייקט של מנהל Exchange
FabricState
[קריאה בלבד] אובייקט של מצב בד
OnIdentifyResponseReceived

פונקציות ציבוריות
CancelExchange(void)
ביטול החלפה של IdentityRequest שנמצאת בתהליך עיבוד וממתינה לתשובה.
Init(WeaveExchangeManager *exchangeMgr)
אתחול מצב הלקוח של תיאור המכשיר.
SendIdentifyRequest(const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
לשלוח הודעת IdentityRequest לכתובת IP מסוימת.
SendIdentifyRequest(const IdentifyRequestMessage & msg)
שליחת הודעת זיהוי בקשה בשידור כדי לגלות צמתים של Weave.
Shutdown(void)
מכבים את לקוח התיאור של המכשיר.

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

HandleIdentifyResponseFunct

void(* HandleIdentifyResponseFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg)

הפונקציה הזו אחראית לעיבוד הודעות IdentityResponse.

פרטים
פרמטרים
[in] appState
מצביע אל המצב המוגדר באפליקציה בזמן יצירת ההקשר של IdentityRequest Exchange.
[in] nodeId
מזהה הצומת של Weave של מקור ההודעה.
[in] nodeAddr
כתובת ה-IP של הצומת שמגיב.
[in] msg
הפניה להודעת IdentityResponse הנכנסת.

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

AppState

void * AppState

אובייקט מצב המוגדר באפליקציה.

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[לקריאה בלבד] אובייקט של מנהל Exchange

FabricState

const WeaveFabricState * FabricState

[קריאה בלבד] אובייקט של מצב בד

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

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

CancelExchange

WEAVE_ERROR CancelExchange(
  void
)

ביטול החלפה של IdentityRequest שנמצאת בתהליך עיבוד וממתינה לתשובה.

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

DeviceDescriptionClient

 DeviceDescriptionClient(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

אתחול מצב הלקוח של תיאור המכשיר.

param[in] ExchangeMgr A מצביע אל Weave Exchange Manager.

פרטים
מוחזר ערכים
WEAVE_ERROR_INCORRECT_STATE
כששרת ניתוב פסיבי מרוחק כבר נרשם.
WEAVE_NO_ERROR
הצלחה.

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IPAddress & nodeAddr,
  const IdentifyRequestMessage & msg
)

לשלוח הודעת IdentityRequest לכתובת IP מסוימת.

פרטים
פרמטרים
[in] nodeAddr
הפניה לכתובת ה-IP של צומת Weave עבור השאילתה.
[in] msg
הפניה להודעת IdentityRequest שצריך לשלוח.
מוחזר ערכים
WEAVE_ERROR_NO_MEMORY
אם הקצאת ההקשר של חילופי החבילות של מאגר הנתונים הזמני נכשלת.
WEAVE_NO_ERROR
הצלחה.
other
קודי שגיאה אחרים של Weave או פלטפורמה ספציפית, שמציינים שאירעה שגיאה שמונעת את השליחה של RequestRequest.

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

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

פרטים
פרמטרים
[in] msg
הפניה להודעת IdentityRequest שצריך לשלוח.

כיבוי

WEAVE_ERROR Shutdown(
  void
)

מכבים את לקוח התיאור של המכשיר.

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

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