nl::Weave::Profiles::DeviceDescription::DeviceDescriptionServer

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

كائن الخادم للاستجابة لطلبات وصف الجهاز.

ملخّص

الاكتساب

يكتسب من: nl::Weave::WeaveServerBase
الفئات الفرعية المعروفة المباشرة: nl::Weave::DeviceLayer::Internal::DeviceDescriptionServer

الدلالة والهياكل
DeviceDescriptionServer(void)

الأنواع العلنية
HandleIdentifyRequestFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyRequestMessage &reqMsg, bool &sendResp, IdentifyResponseMessage &respMsg) typedef
void(*

السمات العامة
AppState
void *
مؤشر الحالة المحدّدة للتطبيق لتوفير سياق لعمليات معاودة الاتصال.
OnIdentifyRequestReceived
HandleIdentifyRequestFunct
وهذه الوظيفة مسؤولة عن معالجة رسائل IdentityRequest.

الدوال العامة
Init(WeaveExchangeManager *exchangeMgr)
يمكنك إعداد حالة خادم وصف الجهاز والتسجيل لتلقّي رسائل "وصف الجهاز".
Shutdown(void)
أوقِف تشغيل خادم وصف الجهاز.

الأنواع العلنية

HandleIdentifyRequestFunct

void(* HandleIdentifyRequestFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyRequestMessage &reqMsg, bool &sendResp, IdentifyResponseMessage &respMsg)

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

AppState

void * AppState

مؤشر الحالة المحدّدة للتطبيق لتوفير سياق لعمليات معاودة الاتصال.

OnIdentifyRequestReceived

HandleIdentifyRequestFunct OnIdentifyRequestReceived

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

التفاصيل
المَعلمات
[in] appState
يشير هذا المصطلح إلى مؤشر إلى الحالة المحدَّدة للتطبيق عند التسجيل لتلقّي رسائل من هذا النوع.
[in] nodeId
رقم تعريف عقدة Weave لمصدر الرسالة.
[in] nodeAddr
عنوان IP لمصدر الرسالة.
[in] reqMsg
مرجع إلى رسالة SelectRequest الواردة.
[out] sendResp
مرجع إلى قيمة منطقية يجب ضبطها على "صحيح" إذا كان يجب إرسال رسالة رد إلى المُنشئ.
[out] respMsg
مرجع إلى رسالة IdentityResponse التي سيتم إرسالها إلى منشئ الميزة.

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

DeviceDescriptionServer

 DeviceDescriptionServer(
  void
)

إنت

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

يمكنك إعداد حالة خادم وصف الجهاز والتسجيل لتلقّي رسائل "وصف الجهاز".

مؤشر param[in] exchangeMgr A إلى Weave Exchange Manager.

التفاصيل
قيم الإرجاع
WEAVE_ERROR_INCORRECT_STATE
عندما يتم تسجيل خادم اجتماع سلبي بعيد عن بُعد.
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
عند تسجيل عدد كبير جدًا من معالِجات الرسائل غير المرغوب فيها
WEAVE_NO_ERROR
عند النجاح

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

WEAVE_ERROR Shutdown(
  void
)

أوقِف تشغيل خادم وصف الجهاز.

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