nl::Weave::DeviceLayer::Internal::DeviceControlServer

#include <src/adaptations/device-layer/include/Weave/DeviceLayer/internal/DeviceControlServer.h>

تنفيذ الملف الشخصي للتحكم في جهاز Weave لجهاز Weave.

ملخّص

الاكتساب

يتم اكتسابه من:
  nl::Weave::Profiles::DeviceControl::DeviceControlServer
  nl::Weave::Profiles::DeviceControl::DeviceControlDelegate

الدوال العامة

Init()
IsPairedToAccount() const override
virtual bool
تم الاتصال لتحديد ما إذا كان الجهاز مقترنًا حاليًا بأحد الحسابات.
IsResetAllowed(uint16_t resetFlags) override
virtual bool
تحقَّق مما إذا كان مسموحًا بإعادة ضبط الإعدادات المحدّدة.
OnConnectionMonitorTimeout(uint64_t peerNodeId, IPAddress peerAddr) override
void
OnFailSafeArmed(void) override
virtual WEAVE_ERROR
تم تفعيل خيار الإشارة إلى أنّه تم تفعيل إعدادات الجهاز بشكلٍ آمن.
OnFailSafeDisarmed(void) override
virtual WEAVE_ERROR
تم إيقاف ميزة "الإشارة إلى تعذُّر ضبط الجهاز على نحو آمن".
OnPlatformEvent(const WeaveDeviceEvent *event)
void
OnRemotePassiveRendezvousDone(void) override
virtual void
يشير إلى انتهاء عملية "اللقاء السلبي عن بُعد".
OnRemotePassiveRendezvousStarted(void) override
virtual void
يشير إلى بدء عملية "اللقاء السلبي عن بُعد".
OnResetConfig(uint16_t resetFlags) override
virtual WEAVE_ERROR
عليك إعادة ضبط إعدادات الجهاز بالكامل أو جزء منها.
OnSystemTestStarted(uint32_t profileId, uint32_t testId) override
virtual WEAVE_ERROR
بدء اختبار النظام المحدّد
OnSystemTestStopped(void) override
virtual WEAVE_ERROR
أوقِف اختبار النظام الذي لا يزال قيد التقدم.
ShouldCloseConBeforeResetConfig(uint16_t resetFlags) override
virtual bool
حدِّد ما إذا كان يجب إغلاق اتصال الخادم، إن وجد، قبل إعادة ضبط الإعداد.
WillCloseRemotePassiveRendezvous(void) override
virtual void
عليك الاستعداد لإيقاف ميزة Remote Passive Rendezvous.
WillStartRemotePassiveRendezvous(void) override
virtual WEAVE_ERROR
التحضير للقاء سلبي عن بُعد.

الدوال المحمية

DeviceControlServer()=default
DeviceControlServer(const DeviceControlServer &)=delete
DeviceControlServer(const DeviceControlServer &&)=delete
operator=(const DeviceControlServer &)=delete
~DeviceControlServer()=default

الدوال العامة

إنت

WEAVE_ERROR Init()

IsPairedToAccount

virtual bool IsPairedToAccount() const override

تم الاتصال لتحديد ما إذا كان الجهاز مقترنًا حاليًا بأحد الحسابات.

IsResetAllowed

virtual bool IsResetAllowed(
  uint16_t resetFlags
) override

تحقَّق مما إذا كان مسموحًا بإعادة ضبط الإعدادات المحدّدة.

التفاصيل
المَعلمات
[in] resetFlags
العلامات التي تحدِّد الإعدادات المطلوب إعادة ضبطها
قيم الإرجاع
TRUE
في حال السماح بإعادة ضبط الإعداد.
FALSE
في حال عدم السماح بإعادة ضبط الإعدادات.

OnConnectionMonitorTimeout

void OnConnectionMonitorTimeout(
  uint64_t peerNodeId,
  IPAddress peerAddr
) override

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
) override

تم تفعيل خيار الإشارة إلى أنّه تم تفعيل إعدادات الجهاز بشكلٍ آمن.

يتم استدعاء هذه الوظيفة عندما يفشل الخادم في تهيئة الجهاز بشكلٍ آمن استجابةً لطلب من العميل. يؤدي ضمان الأمان إلى إعادة ضبط إعدادات الجهاز تلقائيًا على الحالة المعروفة في حال تعذّر إكمال عملية الضبط بنجاح.

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

OnFailSafeDisarmed

virtual WEAVE_ERROR OnFailSafeDisarmed(
  void
) override

تم إيقاف ميزة "الإشارة إلى تعذُّر ضبط الجهاز على نحو آمن".

يتم استدعاء هذه الوظيفة عندما يفشل الخادم في تهيئة الجهاز، وذلك استجابةً لطلب من العميل. سيُوقف العميل جهاز إنذار الفشل بأمان بعد اكتمال الضبط.

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

OnPlatformEvent

void OnPlatformEvent(
  const WeaveDeviceEvent *event
)

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
) override

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

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
) override

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

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
) override

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

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

التفاصيل
المَعلمات
[in] resetFlags
العلامات التي تحدِّد الإعدادات المطلوب إعادة ضبطها
قيم الإرجاع
WEAVE_NO_ERROR
عند النجاح
other
رموز الخطأ الأخرى في Weave أو النظام الأساسي والتي تشير إلى حدوث خطأ يمنع الجهاز من إعادة ضبط الإعداد.

OnSystemTestStarted

virtual WEAVE_ERROR OnSystemTestStarted(
  uint32_t profileId,
  uint32_t testId
) override

بدء اختبار النظام المحدّد

التفاصيل
المَعلمات
[in] profileId
تمثّل هذه السمة رقم تعريف الملف الشخصي للاختبار المطلوب.
[in] testId
رقم تعريف الاختبار المطلوب.
قيم الإرجاع
WEAVE_NO_ERROR
عند النجاح
other
رموز خطأ أخرى في Weave أو خاصة بالنظام الأساسي تشير إلى حدوث خطأ يمنع بدء اختبار النظام.

OnSystemTestStopped

virtual WEAVE_ERROR OnSystemTestStopped(
  void
) override

أوقِف اختبار النظام الذي لا يزال قيد التقدم.

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

ShouldCloseConBeforeResetConfig

virtual bool ShouldCloseConBeforeResetConfig(
  uint16_t resetFlags
) override

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

تُستخدم هذه الدالة للاستعلام عن السلوك المطلوب للمفوَّض عند معالجة طلب إعادة ضبط الإعداد. إذا كان الاتصال بالخادم نشطًا في الوقت الحالي، فستؤدي الاستجابة "صحيح" لهذه الطريقة إلى إغلاق الاتصال قبل تشغيل إعادة ضبط الإعداد من خلال الإجراء OnResetConfig.

التفاصيل
المَعلمات
[in] resetFlags
العلامات التي تحدِّد الإعدادات المطلوب إعادة ضبطها
قيم الإرجاع
true
إذا كانت هناك حاجة إلى إغلاق الاتصال.
false
إذا لم يكن هناك حاجة لإغلاق الاتصال.

WillCloseRemotePassiveRendezvous

virtual void WillCloseRemotePassiveRendezvous(
  void
) override

عليك الاستعداد لإيقاف ميزة Remote Passive Rendezvous.

يمكنك الاطّلاع أيضًا على:
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
) override

التحضير للقاء سلبي عن بُعد.

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

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

الدوال المحمية

DeviceControlServer

 DeviceControlServer()=default

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &
)=delete

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &&
)=delete

r=or

DeviceControlServer & operator=(
  const DeviceControlServer &
)=delete

~DeviceControlServer

 ~DeviceControlServer()=default