nl:: بافت:: پروفایل ها:: DeviceControl:: DeviceControlServer

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

کلاس سرور برای پیاده سازی نمایه Device Control.

خلاصه

ارث

از: 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

mfailsaftoken

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
اگر Remote Passive Rendezvous در حال انجام باشد.
FALSE
اگر Remote Passive Rendezvous در حال انجام نباشد.

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
اشاره گر به Device Control Delegate.

خاموش شدن

WEAVE_ERROR Shutdown(
  void
)

سرور کنترل دستگاه را خاموش کنید.

جزئیات
ارزش های بازگشتی
WEAVE_NO_ERROR
بدون قید و شرط

SystemTestTimeout

void SystemTestTimeout(
  void
)