nl :: نسج:: طبقة الجهاز :: داخلي:: DeviceControlServer

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

تنفذ ملف تعريف Weave Device Control لجهاز 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
استعد لإيقاف الالتقاء السلبي البعيد.
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
رموز خطأ أخرى خاصة بالنسيج أو النظام الأساسي تشير إلى حدوث خطأ يمنع الفشل الآمن من التسليح.

OnFailSafeDisarmed

virtual WEAVE_ERROR OnFailSafeDisarmed(
  void
) override

أشر إلى أن تكوين الجهاز قد تم تعطيله بشكل آمن.

يتم استدعاء هذه الوظيفة عندما يفشل تكوين جهاز الخادم بشكل آمن ، وقد تم إلغاء تفعيله استجابة لطلب من العميل. سيقوم العميل بنزع سلاح الفشل الآمن بعد اكتمال التكوين.

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

OnPlatformEvent

void OnPlatformEvent(
  const WeaveDeviceEvent *event
)

OnRemotePassiveRendezvous تم

virtual void OnRemotePassiveRendezvousDone(
  void
) override

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

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
) override

يشير إلى أن عملية الالتقاء الخامل عن بُعد قد بدأت.

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
) override

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

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

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

OnSystemTestStarted

virtual WEAVE_ERROR OnSystemTestStarted(
  uint32_t profileId,
  uint32_t testId
) override

ابدأ اختبار النظام المحدد.

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

OnSystemTestStopped

virtual WEAVE_ERROR OnSystemTestStopped(
  void
) override

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

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

shouldCloseConBeforeResetConfig

virtual bool ShouldCloseConBeforeResetConfig(
  uint16_t resetFlags
) override

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

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

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

WillCloseRemotePassiveRendezvous

virtual void WillCloseRemotePassiveRendezvous(
  void
) override

استعد لإيقاف الالتقاء السلبي البعيد.

أنظر أيضا:
WillStartRemotePassiveRendezvous (باطل)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
) override

استعد للالتقاء الخامل عن بعد.

على سبيل المثال ، اجعل شبكة 15.4 / Thread قابلة للانضمام.

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

وظائف محمية

DeviceControlServer

 DeviceControlServer()=default

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &
)=delete

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &&
)=delete

عامل التشغيل =

DeviceControlServer & operator=(
  const DeviceControlServer &
)=delete

~ DeviceControlServer

 ~DeviceControlServer()=default