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

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

شی کلاینت برای صدور درخواست های Device Description.

خلاصه

سازندگان و ویرانگرها

DeviceDescriptionClient (void)

انواع عمومی

HandleIdentifyResponseFunct )(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg) typedef
void(*
این تابع وظیفه پردازش پیام های IdentityResponse را بر عهده دارد.

صفات عمومی

AppState
void *
شیء حالت تعریف شده از برنامه.
ExchangeMgr
[فقط خواندن] شی مدیر Exchange
FabricState
[فقط بخوانید] شیء حالت پارچه
OnIdentifyResponseReceived

توابع عمومی

CancelExchange (void)
در انتظار پاسخ، تبادل IdentifyRequest در حال انجام را لغو کنید.
Init ( WeaveExchangeManager *exchangeMgr)
حالت سرویس گیرنده Device Description را راه اندازی کنید.
SendIdentifyRequest (const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
یک پیام IdentifyRequest به یک آدرس IP خاص ارسال کنید.
SendIdentifyRequest (const IdentifyRequestMessage & msg)
یک پیام پخش IdentifyRequest برای کشف گره های Weave ارسال کنید.
Shutdown (void)
سرویس گیرنده توضیحات دستگاه را خاموش کنید.

انواع عمومی

HandleIdentifyResponseFunct

void(* HandleIdentifyResponseFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg)

این تابع وظیفه پردازش پیام های IdentityResponse را بر عهده دارد.

جزئیات
پارامترها
[in] appState
یک اشاره گر به مجموعه حالت تعریف شده برنامه هنگام ایجاد IdentityRequest Exchange Context.
[in] nodeId
شناسه گره بافت منبع پیام.
[in] nodeAddr
آدرس IP گره پاسخ دهنده.
[in] msg
ارجاع به پیام IdentifyResponse ورودی.

صفات عمومی

AppState

void * AppState

شیء حالت تعریف شده از برنامه.

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[فقط خواندن] شی مدیر Exchange

Fabric State

const WeaveFabricState * FabricState

[فقط بخوانید] شیء حالت پارچه

OnIdentifyResponseReceived 

HandleIdentifyResponseFunct OnIdentifyResponseReceived

توابع عمومی

لغوExchange

WEAVE_ERROR CancelExchange(
  void
)

در انتظار پاسخ، تبادل IdentifyRequest در حال انجام را لغو کنید.

جزئیات
ارزش های بازگشتی
WEAVE_NO_ERROR
بدون قید و شرط

DeviceDescriptionClient 

 DeviceDescriptionClient(
  void
)

شروع کنید

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

حالت سرویس گیرنده Device Description را راه اندازی کنید.

param[in] exchangeMgr یک اشاره گر به Weave Exchange Manager.

جزئیات
ارزش های بازگشتی
WEAVE_ERROR_INCORRECT_STATE
هنگامی که یک سرور قرار ملاقات غیرفعال از راه دور قبلاً ثبت شده است.
WEAVE_NO_ERROR
در مورد موفقیت

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IPAddress & nodeAddr,
  const IdentifyRequestMessage & msg
)

یک پیام IdentifyRequest به یک آدرس IP خاص ارسال کنید.

جزئیات
پارامترها
[in] nodeAddr
ارجاع به آدرس IP گره Weave برای پرس و جو.
[in] msg
ارجاع به پیام IdentifyRequest برای ارسال.
ارزش های بازگشتی
WEAVE_ERROR_NO_MEMORY
اگر تخصیص زمینه تبادل بافر بسته با شکست مواجه شود.
WEAVE_NO_ERROR
در مورد موفقیت
other
سایر کدهای خطای Weave یا پلتفرم خاص که نشان می دهد خطایی در جلوگیری از ارسال IdentifyRequest رخ داده است.

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

یک پیام پخش IdentifyRequest برای کشف گره های Weave ارسال کنید.

جزئیات
پارامترها
[in] msg
ارجاع به پیام IdentifyRequest برای ارسال.

خاموش شدن

WEAVE_ERROR Shutdown(
  void
)

سرویس گیرنده توضیحات دستگاه را خاموش کنید.

این تابع هر زمینه تبادل فعال را می بندد و نشانگرها را بازنشانی می کند. شی را می توان با فراخوانی مجدد متد Init دوباره استفاده کرد.

جزئیات
ارزش های بازگشتی
WEAVE_NO_ERROR
بدون قید و شرط