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
استعِدّ للتوقّف عن بُعد Autoive Passive Rendezvous.
WillStartRemotePassiveRendezvous(void) override
virtual WEAVE_ERROR
استعِد لموعد سلبي عن بُعد.

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

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

وظائف عامة

Init

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

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

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

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

WillCloseRemotePassiveRendezvous

virtual void WillCloseRemotePassiveRendezvous(
  void
) override

استعِدّ للتوقّف عن بُعد Autoive 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

operator=

DeviceControlServer & operator=(
  const DeviceControlServer &
)=delete

~DeviceControlServer

 ~DeviceControlServer()=default