nl::Weave::Profiles::DeviceControl::DeviceControlServer

#include <src/lib/profiles/device-control/DeviceControl.h>

فئة الخادم لتنفيذ الملف الشخصي للتحكّم في الجهاز.

ملخّص

الاكتساب

يكتسب من: nl::Weave::WeaveServerBase
الفئات الفرعية المعروفة المباشرة: nl::Weave::DeviceLayer::Internal::DeviceControlServer

الدلالة والهياكل
DeviceControlServer(void)

السمات المحمية
mCurClientOp
mDelegate
mFailSafeArmed
bool
mFailSafeToken
uint32_t
mRemotePassiveRendezvousClientCon
mRemotePassiveRendezvousEncryptionType
uint8_t
mRemotePassiveRendezvousJoinerAddr
mRemotePassiveRendezvousJoinerCon
mRemotePassiveRendezvousKeyId
uint16_t
mRemotePassiveRendezvousOp
mRemotePassiveRendezvousTimeout
uint16_t
mRemotePassiveRendezvousTunnel
mResetFlags
uint16_t
mTunnelInactivityTimeout
uint16_t

الدوال العامة
Init(WeaveExchangeManager *exchangeMgr)
يمكنك إعداد حالة "خادم التحكُّم في الجهاز" والتسجيل لتلقّي رسائل "التحكُّم في الجهاز".
IsRemotePassiveRendezvousInProgress(void) const
bool
إرجاع حالة الاستقبال السلبي عن بُعد
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
إرسال رد على طلب من خلال تقرير الحالة
SendSuccessResponse(void)
virtual WEAVE_ERROR
يمكنك إرسال ردّ ناجح إلى طلب "التحكّم في الجهاز".
SetDelegate(DeviceControlDelegate *delegate)
void
يمكنك ضبط المفوَّض لمعالجة أحداث "خادم التحكّم في الأجهزة".
Shutdown(void)
أوقِف تشغيل "خادم التحكّم في الجهاز".
SystemTestTimeout(void)
void

السمات المحمية

mCurClientOp

ExchangeContext * mCurClientOp

mDelegate

DeviceControlDelegate * mDelegate

mFailSafeArmed

bool mFailSafeArmed

mFailSafeToken

uint32_t mFailSafeToken

mRemotePassiveRendezvousClientCon

WeaveConnection * mRemotePassiveRendezvousClientCon

mRemotePassiveRendezvousEncryptionType

uint8_t mRemotePassiveRendezvousEncryptionType

mRemotePassiveRendezvousJoinerAddr

IPAddress mRemotePassiveRendezvousJoinerAddr

mRemotePassiveRendezvousJoinerCon

WeaveConnection * mRemotePassiveRendezvousJoinerCon

mRemotePassiveRendezvousKeyId

uint16_t mRemotePassiveRendezvousKeyId

mRemotePassiveRendezvousOp

ExchangeContext * mRemotePassiveRendezvousOp

mRemotePassiveRendezvousTimeout

uint16_t mRemotePassiveRendezvousTimeout

mRemotePassiveRendezvousTunnel

WeaveConnectionTunnel * mRemotePassiveRendezvousTunnel

mResetFlags

uint16_t mResetFlags

mTunnelInactivityTimeout

uint16_t mTunnelInactivityTimeout

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

DeviceControlServer

 DeviceControlServer(
  void
)

إنت

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

يمكنك إعداد حالة "خادم التحكُّم في الجهاز" والتسجيل لتلقّي رسائل "التحكُّم في الجهاز".

التفاصيل
المَعلمات
[in] exchangeMgr
مؤشر يوجِّه إلى Weave Exchange Manager.
قيم الإرجاع
WEAVE_ERROR_INCORRECT_STATE
عندما يتم تسجيل خادم اجتماع سلبي بعيد عن بُعد.
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
عند تسجيل عدد كبير جدًا من معالِجات الرسائل غير المرغوب فيها
WEAVE_NO_ERROR
عند النجاح

IsRemotePassiveRendezvousInProgress

bool IsRemotePassiveRendezvousInProgress(
  void
) const

إرجاع حالة الاستقبال السلبي عن بُعد

التفاصيل
قيم الإرجاع
TRUE
في حال عدم تنفيذ Rendezvous عن بُعد قيد التقدم.
FALSE
في حال عدم كون ميزة "الاستجابة السلبية عن بُعد" قيد التقدم.

SendStatusReport

virtual WEAVE_ERROR SendStatusReport(
  uint32_t statusProfileId,
  uint16_t statusCode,
  WEAVE_ERROR sysError
)

إرسال رد على طلب من خلال تقرير الحالة

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

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

يمكنك إرسال ردّ ناجح إلى طلب "التحكّم في الجهاز".

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

SetDelegate

void SetDelegate(
  DeviceControlDelegate *delegate
)

يمكنك ضبط المفوَّض لمعالجة أحداث "خادم التحكّم في الأجهزة".

التفاصيل
المَعلمات
[in] delegate
مؤشر إلى "تفويض التحكّم في الجهاز"

إيقاف التشغيل

WEAVE_ERROR Shutdown(
  void
)

أوقِف تشغيل "خادم التحكّم في الجهاز".

التفاصيل
قيم الإرجاع
WEAVE_NO_ERROR
بدون شرط.

SystemTestTimeout

void SystemTestTimeout(
  void
)