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)
לבטל החלפה פעילה של OAuthRequest ובהמתנה לתשובה.
Init(WeaveExchangeManager *exchangeMgr)
מאתחלים את מצב הלקוח של תיאור המכשיר.
SendIdentifyRequest(const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
לשלוח הודעת UniqueRequest לכתובת IP מסוימת.
SendIdentifyRequest(const IdentifyRequestMessage & msg)
יש לשלוח הודעת UniqueRequest לשידור כדי לגלות צומתי 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
)

לבטל החלפה פעילה של OAuthRequest ובהמתנה לתשובה.

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

DeviceDescriptionClient

 DeviceDescriptionClient(
  void
)

הפעלה

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

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

param[in] exchangeMgr A to the Weave Exchange Manager (מנהל Exchange Exchange של Weave).

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

SendIdentifyRequest

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

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

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

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

יש לשלוח הודעת UniqueRequest לשידור כדי לגלות צומתי Weave.

פרטים
פרמטרים
[in] msg
אסמכתה להודעה של RequestRequest לשליחה.

כיבוי

WEAVE_ERROR Shutdown(
  void
)

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

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

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