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
)

Init

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
)