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
عليك الاستعداد لإيقاف ميزة 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

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

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

حدِّد ما إذا كان يجب إغلاق اتصال الخادم، إن وجد، قبل إعادة ضبط الإعداد.

تُستخدم هذه الدالة للاستعلام عن السلوك المطلوب للمفوَّض عند معالجة طلب إعادة ضبط الإعداد. إذا كان الاتصال بالخادم نشطًا في الوقت الحالي، فستؤدي الاستجابة "صحيح" لهذه الطريقة إلى إغلاق الاتصال قبل تشغيل إعادة ضبط الإعداد من خلال الإجراء 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 أو النظام الأساسي والتي تشير إلى حدوث خطأ أثناء التحضير لبدء Rendezvous عن بُعد.