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) تعريف الكتابة
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
مرجع لرسالة IdentityRequest الواردة.
[out] sendResp
يشير إلى قيمة منطقية يجب ضبطها على "صحيح" إذا كان يجب إرسال رسالة ردّ إلى منشئ الرسالة.
[out] respMsg
مرجع لرسالة IdentityResponse المطلوب إرسالها إلى منشئ الرسالة.

وظائف عامة

DeviceDescriptionServer

 DeviceDescriptionServer(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

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

param[in] exchangeMgr A لصالح

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

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

WEAVE_ERROR Shutdown(
  void
)

إيقاف خادم وصف الجهاز

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