nl:: بافت:: پروفایل ها:: توضیحات دستگاه:: DeviceDescriptionServer

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

شیء سرور برای پاسخ به درخواست‌های Device Description.

خلاصه

وراثت

از: 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)
حالت Device Description Server را راه اندازی کنید و برای دریافت پیام های Device Description ثبت نام کنید.
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
شناسه گره بافت منبع پیام.
[in] nodeAddr
آدرس IP منبع پیام.
[in] reqMsg
ارجاع به پیام IdentifyRequest ورودی.
[out] sendResp
ارجاع به یک بولی که اگر پیام پاسخی به آغازگر ارسال شود باید روی true تنظیم شود.
[out] respMsg
ارجاع به پیام IdentifyResponse برای ارسال به آغازگر.

توابع عمومی

DeviceDescriptionServer

 DeviceDescriptionServer(
  void
)

شروع کنید

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

حالت Device Description Server را راه اندازی کنید و برای دریافت پیام های Device Description ثبت نام کنید.

param[in] 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
بدون قید و شرط.