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

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

מחלקת השרת להטמעת פרופיל Device Control.

סיכום

ירושה

יורשים מ: nl::Weave::WeaveServerBase
Direct known Subclasses: 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
החזרת המצב של Rendezvous מרוחקת.
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
מצביע אל מנהל Exchange Exchange.
ערכים מוחזרים
WEAVE_ERROR_INCORRECT_STATE
כאשר כבר נרשם שרת מפגש פסיבי מרוחק.
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
כאשר נרשמים יותר מדי רכיבי handler של הודעות ללא אישור מצד המשתמש.
WEAVE_NO_ERROR
בהצלחה.

IsRemotePassiveRendezvousInProgress

bool IsRemotePassiveRendezvousInProgress(
  void
) const

החזרת המצב של Rendezvous מרוחקת.

פרטים
ערכים מוחזרים
TRUE
אם מתבצע חיבור פסיבי מרוחק.
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
מצביע אל 'הענקת גישה לבקרת מכשירים'.

כיבוי

WEAVE_ERROR Shutdown(
  void
)

יש לכבות את שרת בקרת המכשיר.

פרטים
ערכים מוחזרים
WEAVE_NO_ERROR
ללא תנאי.

SystemTestTimeout

void SystemTestTimeout(
  void
)