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) تعريف الكتابة
void(*
هذه الدالة مسؤولة عن معالجة رسائل IdentityResponse.

السمات العامة
AppState
void *
عنصر حالة معرّف التطبيق.
ExchangeMgr
[READ ONLY] عنصر Exchange Manager
FabricState
[للقراءة فقط] عنصر حالة النسيج
OnIdentifyResponseReceived

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

[READ ONLY] عنصر Exchange Manager

FabricState

const WeaveFabricState * FabricState

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

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

وظائف عامة

CancelExchange

WEAVE_ERROR CancelExchange(
  void
)

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

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

DeviceDescriptionClient

 DeviceDescriptionClient(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

إعداد حالة عميل "وصف الجهاز"

param[in] exchangeMgr A لصالح

التفاصيل
قيم الإرجاع
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 أو خاصة بالنظام الأساسي تشير إلى حدوث خطأ ما يمنع إرسال IdentityRequest.

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

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

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

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

WEAVE_ERROR Shutdown(
  void
)

إيقاف برنامج وصف الجهاز

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

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