nl::Weave::Profiles::DeviceControl::DeviceControlDelegate

هذا صف مجرّد.

#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
يشير إلى انتهاء عملية "الموعد السلبي عن بُعد".
OnRemotePassiveRendezvousStarted(void)=0
virtual void
يشير إلى أن عملية "الموعد السلبي عن بُعد" قد بدأت.
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
استعِدّ للتوقّف عن بُعد Autoive 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

يشير إلى انتهاء عملية "الموعد السلبي عن بُعد".

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
)=0

يشير إلى أن عملية "الموعد السلبي عن بُعد" قد بدأت.

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
)=0

إعادة ضبط جميع إعدادات الجهاز أو جزء منها

من المتوقع أن يؤدي تنفيذ هذه الدالة إلى إعادة ضبط أي مجموعة من إعدادات الشبكة أو Weave النسيج أو الخدمة إلى حالة معروفة، وفقًا لعلامات إعادة الضبط.

التفاصيل
المعلمات
[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

استعِدّ للتوقّف عن بُعد Autoive Passive Rendezvous.

يُرجى الاطّلاع أيضًا على:
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
)=0

استعِد لموعد سلبي عن بُعد.

على سبيل المثال، يمكنك إتاحة الانضمام إلى شبكة 15.4/Thread.

التفاصيل
قيم الإرجاع
WEAVE_NO_ERROR
عند النجاح.
other
رموز خطأ أخرى لـ Weave أو خاصة بالنظام الأساسي تشير إلى حدوث خطأ أثناء الاستعداد لبدء Rendezvous عن بُعد.