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

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

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

ملخص

ميراث

يرث من: NL :: :: نسج WeaveServerBase
توجيه الفئات الفرعية المعروفة: NL :: :: نسج DeviceLayer :: :: الداخلية 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)
قم بإيقاف تشغيل خادم وصف الجهاز.

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

HandIdentifyRequestFunct

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

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

AppState

void * AppState

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

تم استلام OnIdentifyRequest

HandleIdentifyRequestFunct OnIdentifyRequestReceived

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

تفاصيل
المعلمات
[in] appState
يتم تعيين مؤشر إلى الحالة المحددة للتطبيق عند التسجيل لتلقي رسائل من هذا النوع.
[in] nodeId
Weave node ID لمصدر الرسالة.
[in] nodeAddr
عنوان IP لمصدر الرسالة.
[in] reqMsg
مرجع لرسالة IdentifyRequest الواردة.
[out] sendResp
مرجع منطقي يجب تعيينه على صحيح إذا كان يجب إرسال رسالة استجابة إلى البادئ.
[out] respMsg
مرجع لرسالة IdentifyResponse ليتم إرسالها إلى البادئ.

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

DeviceDescriptionServer

 DeviceDescriptionServer(
  void
)

فيه

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

قم بتهيئة حالة خادم وصف الجهاز وقم بالتسجيل لتلقي رسائل وصف الجهاز.

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

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

اغلق

WEAVE_ERROR Shutdown(
  void
)

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

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