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)
يمكنك إلغاء عملية تبادل SelectRequest قيد التقدم في انتظار الرد.
Init(WeaveExchangeManager *exchangeMgr)
تهيئة حالة عميل وصف الجهاز.
SendIdentifyRequest(const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
إرسال رسالة SelectRequest إلى عنوان IP معين.
SendIdentifyRequest(const IdentifyRequestMessage & msg)
أرسل رسالة SelectRequest للبث لاكتشاف عُقد 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
مرجع إلى رسالة SelectResponse الواردة.

السمات العامة

AppState

void * AppState

كائن الحالة المحددة للتطبيق.

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[للقراءة فقط] كائن مدير Exchange

FabricState

const WeaveFabricState * FabricState

[للقراءة فقط] عنصر حالة النسيج

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

الدوال العامة

CancelExchange

WEAVE_ERROR CancelExchange(
  void
)

يمكنك إلغاء عملية تبادل SelectRequest قيد التقدم في انتظار الرد.

التفاصيل
قيم الإرجاع
WEAVE_NO_ERROR
بدون شرط.

DeviceDescriptionClient

 DeviceDescriptionClient(
  void
)

إنت

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
)

إرسال رسالة SelectRequest إلى عنوان IP معين.

التفاصيل
المَعلمات
[in] nodeAddr
مرجع إلى عنوان IP لعقدة Weave المطلوب الاستعلام عنها.
[in] msg
مرجع إلى رسالة SelectRequest لإرسالها.
قيم الإرجاع
WEAVE_ERROR_NO_MEMORY
في حال تعذُّر تخصيص سياق تبادل المخزن المؤقت للحِزم
WEAVE_NO_ERROR
عند النجاح
other
رموز خطأ أخرى في Weave أو خاصة بالنظام الأساسي تشير إلى حدوث خطأ يمنع إرسال SelectRequest.

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

أرسل رسالة SelectRequest للبث لاكتشاف عُقد Weave.

التفاصيل
المَعلمات
[in] msg
مرجع إلى رسالة SelectRequest لإرسالها.

إيقاف التشغيل

WEAVE_ERROR Shutdown(
  void
)

أوقِف "برنامج وصف الجهاز".

تغلق هذه الدالة أي سياق تبادل نشط وتُعيد ضبط المؤشرات. يمكن إعادة استخدام الكائن من خلال استدعاء طريقة Init مرة أخرى.

التفاصيل
قيم الإرجاع
WEAVE_NO_ERROR
بدون شرط.