nl :: نسج:: مظهر:: وصف الجهاز:: الجهاز الوصف العميل

#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
[للقراءة فقط] كائن مدير الصرف
FabricState
[للقراءة فقط] كائن حالة النسيج
OnIdentifyResponseReceived

الوظائف العامة

CancelExchange (void)
إلغاء تبادل IdentifyRequest قيد التقدم في انتظار الرد.
Init ( WeaveExchangeManager *exchangeMgr)
تهيئة حالة العميل لوصف الجهاز.
SendIdentifyRequest (const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
أرسل رسالة IdentifyRequest إلى عنوان IP معين.
SendIdentifyRequest (const IdentifyRequestMessage & msg)
أرسل رسالة إذاعية IdentifyRequest لاكتشاف عقد Weave.
Shutdown (void)
قم بإيقاف تشغيل عميل وصف الجهاز.

الأنواع العامة

التعامل مع تحديد الرد

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

هذه الوظيفة مسؤولة عن معالجة رسائل IdentityResponse.

تفاصيل
المعلمات
[in] appState
تم تعيين مؤشر إلى الحالة المحددة للتطبيق عند إنشاء سياق تبادل IdentityRequest.
[in] nodeId
Weave node ID لمصدر الرسالة.
[in] nodeAddr
عنوان IP الخاص بالعقدة المستجيبة.
[in] msg
مرجع لرسالة IdentifyResponse الواردة.

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

AppState

void * AppState

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

الصرف

WeaveExchangeManager * ExchangeMgr

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

FabricState

const WeaveFabricState * FabricState

[للقراءة فقط] كائن حالة النسيج

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

الوظائف العامة

إلغاء الصرف

WEAVE_ERROR CancelExchange(
  void
)

إلغاء تبادل IdentifyRequest قيد التقدم في انتظار الرد.

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

الجهاز الوصف العميل

 DeviceDescriptionClient(
  void
)

فيه

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

تهيئة حالة العميل لوصف الجهاز.

param [في] exchangeMgr مؤشر إلى Weave Exchange Manager.

تفاصيل
إرجاع القيم
WEAVE_ERROR_INCORRECT_STATE
عندما يكون قد تم تسجيل خادم موعد خامل عن بعد.
WEAVE_NO_ERROR
عن النجاح.

SendIdentifyRequest

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

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

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

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

أرسل رسالة إذاعية IdentifyRequest لاكتشاف عقد Weave.

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

اغلق

WEAVE_ERROR Shutdown(
  void
)

قم بإيقاف تشغيل عميل وصف الجهاز.

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

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