nl:: بافت:: پروفایل ها:: DeviceControl:: DeviceControl Delegate

این یک کلاس انتزاعی است.

#include <src/lib/profiles/device-control/DeviceControl.h>

یک کلاس برای اجرای عملیات کنترل دستگاه ورودی در دستگاه سرور.

خلاصه

وراثت

از: nl::Weave::WeaveServerDelegateBase به ارث می برد
زیر کلاس های مستقیم شناخته شده: nl::Weave::DeviceLayer::Internal::DeviceControlServer

توابع عمومی

EnforceAccessControl ( ExchangeContext *ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo *msgInfo, AccessControlResult & result)
virtual void
برای پیام درخواست DeviceControl ورودی، کنترل دسترسی در سطح پیام را اعمال کنید.
IsPairedToAccount () const
virtual bool
برای تعیین اینکه آیا دستگاه در حال حاضر با یک حساب جفت شده است یا خیر، فراخوانی می شود.
IsResetAllowed (uint16_t resetFlags)=0
virtual bool
بررسی کنید که آیا بازنشانی پیکربندی مشخص شده مجاز است یا خیر.
OnConnectionMonitorTimeout (uint64_t peerNodeId, IPAddress peerAddr)=0
virtual void
نشان دهید که مهلت زمانی مانیتور اتصال وجود داشته است.
OnFailSafeArmed (void)=0
virtual WEAVE_ERROR
نشان دهید که پیکربندی دستگاه با شکست امن مسلح شده است.
OnFailSafeDisarmed (void)=0
virtual WEAVE_ERROR
نشان می دهد که پیکربندی دستگاه با شکست امن خلع سلاح شده است.
OnRemotePassiveRendezvousDone (void)=0
virtual void
نشان می دهد که فرآیند Remote Passive Rendezvous به پایان رسیده است.
OnRemotePassiveRendezvousStarted (void)=0
virtual void
نشان می دهد که فرآیند Remote Passive Rendezvous شروع شده است.
OnResetConfig (uint16_t resetFlags)=0
virtual WEAVE_ERROR
تمام یا بخشی از پیکربندی دستگاه را بازنشانی کنید.
OnSystemTestStarted (uint32_t profileId, uint32_t testId)=0
virtual WEAVE_ERROR
تست سیستم مشخص شده را شروع کنید.
OnSystemTestStopped (void)=0
virtual WEAVE_ERROR
آزمایش سیستم در حال انجام را متوقف کنید.
ShouldCloseConBeforeResetConfig (uint16_t resetFlags)=0
virtual bool
تعیین کنید که آیا اتصال سرور، در صورت وجود، باید قبل از تنظیم مجدد پیکربندی بسته شود یا خیر.
WillCloseRemotePassiveRendezvous (void)=0
virtual void
برای توقف Remote Passive Rendezvous آماده شوید.
WillStartRemotePassiveRendezvous (void)=0
virtual WEAVE_ERROR
برای یک قرار ملاقات غیرفعال از راه دور آماده شوید.

توابع عمومی

EnforceAccessControl

virtual void EnforceAccessControl(
  ExchangeContext *ec,
  uint32_t msgProfileId,
  uint8_t msgType,
  const WeaveMessageInfo *msgInfo,
  AccessControlResult & result
)

برای پیام درخواست DeviceControl ورودی، کنترل دسترسی در سطح پیام را اعمال کنید.

جزئیات
مولفه های
[in] ec
ExchangeContext که پیام از طریق آن دریافت شده است.
[in] msgProfileId
شناسه پروفایل پیام دریافتی
[in] msgType
نوع پیام پیام دریافتی
[in] msgInfo
ساختار WeaveMessageInfo حاوی اطلاعاتی در مورد پیام دریافتی.
[in,out] result
یک مقدار شمارش شده که نتیجه ارزیابی خط مشی کنترل دسترسی را برای پیام دریافتی توصیف می کند. پس از ورود به روش، مقدار نشان دهنده نتیجه آزمایشی در نقطه فعلی در فرآیند ارزیابی است. پس از بازگشت، انتظار می رود که نتیجه ارزیابی نهایی سیاست کنترل دسترسی برای پیام را نشان دهد.

IsPairedToAccount

virtual bool IsPairedToAccount() const 

برای تعیین اینکه آیا دستگاه در حال حاضر با یک حساب جفت شده است یا خیر، فراخوانی می شود.

IsResetAllowed

virtual bool IsResetAllowed(
  uint16_t resetFlags
)=0

بررسی کنید که آیا بازنشانی پیکربندی مشخص شده مجاز است یا خیر.

جزئیات
مولفه های
[in] resetFlags
پرچم هایی که مشخص می کنند کدام پیکربندی باید بازنشانی شود.
ارزش های بازگشتی
TRUE
اگر تنظیم مجدد پیکربندی مجاز است.
FALSE
اگر تنظیم مجدد پیکربندی مجاز نیست.

OnConnectionMonitorTimeout

virtual void OnConnectionMonitorTimeout(
  uint64_t peerNodeId,
  IPAddress peerAddr
)=0

نشان دهید که مهلت زمانی مانیتور اتصال وجود داشته است.

این تابع زمانی فراخوانی می شود که یک وقفه مانیتور اتصال رخ داده باشد، یعنی زمانی که بررسی های زنده بودن از میزبان راه دور برای مدت زمان معینی شناسایی نشده باشد.

جزئیات
مولفه های
[in] peerNodeId
شناسه گره همتا از راه دور که زمان اتصال به آن تمام شده است.
[in] peerAddr
آدرس همتای راه دور.

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
)=0

نشان دهید که پیکربندی دستگاه با شکست امن مسلح شده است.

این تابع زمانی فراخوانی می شود که پیکربندی دستگاه سرور در پاسخ به درخواست مشتری مسلح شده باشد. در صورتی که فرآیند پیکربندی با موفقیت انجام نشود، گاوصندوق به طور خودکار پیکربندی دستگاه را به حالت شناخته شده بازنشانی می کند.

جزئیات
ارزش های بازگشتی
WEAVE_NO_ERROR
در مورد موفقیت
other
سایر کدهای خطای Weave یا پلتفرم خاص که نشان می دهد خطایی رخ داده است که مانع از مسلح شدن گاوصندوق خراب می شود.

OnFailSafeDisarmed

virtual WEAVE_ERROR OnFailSafeDisarmed(
  void
)=0

نشان می دهد که پیکربندی دستگاه با شکست امن خلع سلاح شده است.

این تابع زمانی فراخوانی می شود که پیکربندی دستگاه سرور در پاسخ به درخواست مشتری غیرفعال شده باشد. سرویس گیرنده پس از تکمیل پیکربندی، گاوصندوق خراب را خلع سلاح می کند.

جزئیات
ارزش های بازگشتی
WEAVE_NO_ERROR
در مورد موفقیت
other
سایر کدهای خطای Weave یا پلتفرم خاص که نشان می‌دهد خطایی رخ داده است که مانع از خلع سلاح نشدن گاوصندوق می‌شود.

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
)=0

نشان می دهد که فرآیند Remote Passive Rendezvous به پایان رسیده است.

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
)=0

نشان می دهد که فرآیند Remote Passive Rendezvous شروع شده است.

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
)=0

تمام یا بخشی از پیکربندی دستگاه را بازنشانی کنید.

انتظار می‌رود اجرای این تابع، طبق پرچم‌های بازنشانی، هر ترکیبی از پیکربندی‌های شبکه، بافت بافت یا سرویس را به حالت شناخته شده بازنشانی کند.

جزئیات
مولفه های
[in] resetFlags
پرچم هایی که مشخص می کنند کدام پیکربندی باید بازنشانی شود.
ارزش های بازگشتی
WEAVE_NO_ERROR
در مورد موفقیت
other
سایر کدهای خطای Weave یا پلتفرم خاص که نشان می دهد خطایی رخ داده است که مانع از تنظیم مجدد پیکربندی دستگاه می شود.

OnSystemTestStarted

virtual WEAVE_ERROR OnSystemTestStarted(
  uint32_t profileId,
  uint32_t testId
)=0

تست سیستم مشخص شده را شروع کنید.

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

OnSystemTestStopped

virtual WEAVE_ERROR OnSystemTestStopped(
  void
)=0

آزمایش سیستم در حال انجام را متوقف کنید.

جزئیات
ارزش های بازگشتی
WEAVE_NO_ERROR
در مورد موفقیت
other
سایر کدهای خطای خاص Weave یا پلتفرم که نشان می دهد خطایی از توقف آزمایش سیستم جلوگیری می کند.

ShouldCloseConBeforeResetConfig

virtual bool ShouldCloseConBeforeResetConfig(
  uint16_t resetFlags
)=0

تعیین کنید که آیا اتصال سرور، در صورت وجود، باید قبل از تنظیم مجدد پیکربندی بسته شود یا خیر.

این تابع برای پرس و جو از نماینده برای رفتار مورد نظر هنگام پردازش درخواست تنظیم مجدد پیکربندی استفاده می شود. اگر یک اتصال سرور در حال حاضر فعال است، یک پاسخ TRUE به این روش باعث می شود که آن اتصال قبل از تنظیم مجدد پیکربندی از طریق روش OnResetConfig، بسته شود.

جزئیات
مولفه های
[in] resetFlags
پرچم هایی که مشخص می کنند کدام پیکربندی باید بازنشانی شود.
ارزش های بازگشتی
true
اگر اتصال باید بسته شود.
false
اگر اتصال نیازی به بسته شدن نداشته باشد.

WillCloseRemotePassiveRendezvous

virtual void WillCloseRemotePassiveRendezvous(
  void
)=0

برای توقف Remote Passive Rendezvous آماده شوید.

همچنین ببینید:
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
)=0

برای یک قرار ملاقات غیرفعال از راه دور آماده شوید.

به عنوان مثال، شبکه 15.4/Thread را قابل اتصال کنید.

جزئیات
ارزش های بازگشتی
WEAVE_NO_ERROR
در مورد موفقیت
other
سایر کدهای خطای Weave یا پلتفرم خاص که نشان می دهد هنگام آماده شدن برای شروع Remote Passive Rendezvous خطایی رخ داده است.