nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer

#include <src/lib/profiles/network-provisioning/NetworkProvisioning.h>

מחלקת שרת ליישום הפרופיל של הקצאת הרשת.

סיכום

ירושה

Inherits from: nl::Weave::WeaveServerBase
Direct known Subclasses:
  nl::Weave::DeviceLayer::Internal::כלליNetworkResourceingServerImpl< NetworkProvideingServerImpl >
  nl::Weave::plLayerLayer:nl::Weave::plLayer:

בונים והורסים
NetworkProvisioningServer(void)

מאפיינים מוגנים
mCurOp
mCurOpType
uint8_t
mDelegate
mLastOpResult
struct nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer::@217

מאפיינים ציבוריים
StatusCode
uint16_t
StatusProfileId
uint32_t
SysError

תפקידים ציבוריים
Init(WeaveExchangeManager *exchangeMgr)
אתחל את המצב של שרת הקצאת רשת ורשום לקבלת הודעות להקצאת רשת.
SendAddNetworkComplete(uint32_t networkId)
virtual WEAVE_ERROR
שלח הודעה על הוספת הרשת הושלמה אם הרשת נוספה בהצלחה.
SendGetNetworksComplete(uint8_t resultCount, PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
שלח הודעה מסוג 'קבלת רשתות מלאות' שמכילה את הרשתות שנסרקו בעבר.
SendGetWirelessRegulatoryConfigComplete(PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
שולחים הודעה ל-Get WirelessRegulatoryConfigComplete לעמית.
SendNetworkScanComplete(uint8_t resultCount, PacketBuffer *scanResultsTLV)
virtual WEAVE_ERROR
שולחים הודעת תגובה לסריקת רשת מלאה שמכילה את תוצאות הסריקה.
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
שליחת תגובה של דוח סטטוס לבקשה.
SendSuccessResponse(void)
virtual WEAVE_ERROR
שליחת תגובת הצלחה לבקשה להקצאת רשת.
SetDelegate(NetworkProvisioningDelegate *delegate)
void
הגדרת בעל הגישה שיעבד אירועים של שרת הקצאת רשת.
Shutdown(void)
כיבוי של שרת הקצאת הרשת.

מאפיינים מוגנים

mCurOp

ExchangeContext * mCurOp

mCurOpType

uint8_t mCurOpType

mDelegate

NetworkProvisioningDelegate * mDelegate

mLastOpResult

struct nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer::@217 mLastOpResult

מאפיינים ציבוריים

StatusCode

uint16_t StatusCode

StatusProfileId

uint32_t StatusProfileId

SysError

WEAVE_ERROR SysError

תפקידים ציבוריים

הפעלה

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

אתחל את המצב של שרת הקצאת רשת ורשום לקבלת הודעות להקצאת רשת.

פרטים
פרמטרים
[in] exchangeMgr
מצביע אל המערכת של Weave Exchange Manager.
ערכים מוחזרים
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
אם כבר נרשמו יותר מדי רכיבי handler של הודעות.
WEAVE_NO_ERROR
בהצלחה.

NetworkProvisioningServer

 NetworkProvisioningServer(
  void
)

SendAddNetworkComplete

virtual WEAVE_ERROR SendAddNetworkComplete(
  uint32_t networkId
)

שלח הודעה על הוספת הרשת הושלמה אם הרשת נוספה בהצלחה.

פרטים
פרמטרים
[in] networkId
המזהה של הרשת שנוספה.
ערכים מוחזרים
WEAVE_ERROR_INCORRECT_STATE
אם שרת הקצאת הרשת לא מאותחל כראוי.
WEAVE_ERROR_NO_MEMORY
כשל בהקצאה של PacketBuffer.
WEAVE_NO_ERROR
בהצלחה.
other
קודי שגיאה אחרים הספציפיים ל-Weave או לפלטפורמה, המציינים שאירעה שגיאה המונעת מהמכשיר לשלוח את הודעת השגיאה 'הוספת רשת מלאה'.

SendGetNetworksComplete

virtual WEAVE_ERROR SendGetNetworksComplete(
  uint8_t resultCount,
  PacketBuffer *resultsTLV
)

שלח הודעה מסוג 'קבלת רשתות מלאות' שמכילה את הרשתות שנסרקו בעבר.

פרטים
פרמטרים
[in] resultCount
מספר תוצאות הסריקה.
[in] scanResultsTLV
תוצאות הסריקה.
ערכים מוחזרים
WEAVE_ERROR_INCORRECT_STATE
אם שרת הקצאת הרשת לא מאותחל כראוי.
WEAVE_ERROR_BUFFER_TOO_SMALL
אם מאגר התוצאות לא גדול מספיק.
WEAVE_NO_ERROR
בהצלחה.
other
קודי שגיאה אחרים של Weave או ספציפיים לפלטפורמה, שמציינים שאירעה שגיאה שמונעת מהמכשיר לשלוח את ההודעה 'קבלת ההודעה הושלמה'.

SendGetWirelessRegulatoryConfigComplete

virtual WEAVE_ERROR SendGetWirelessRegulatoryConfigComplete(
  PacketBuffer *resultsTLV
)

שולחים הודעה ל-Get WirelessRegulatoryConfigComplete לעמית.

פרטים
פרמטרים
[in] resultsTLV
מאגר חבילות המכיל את המידע על תצורת התקינה האלחוטית שיש להחזיר.
ערכים מוחזרים
WEAVE_ERROR_INCORRECT_STATE
אם שרת הקצאת הרשת לא מאותחל כראוי.
WEAVE_ERROR_NO_MEMORY
כשל בהקצאה של PacketBuffer.
WEAVE_NO_ERROR
בהצלחה.
other
קודי שגיאה אחרים הספציפיים ל-Weave או לפלטפורמה, המציינים שאירעה שגיאה המונעת מהמכשיר לשלוח את הודעת השגיאה 'הוספת רשת מלאה'.

SendNetworkScanComplete

virtual WEAVE_ERROR SendNetworkScanComplete(
  uint8_t resultCount,
  PacketBuffer *scanResultsTLV
)

שולחים הודעת תגובה לסריקת רשת מלאה שמכילה את תוצאות הסריקה.

פרטים
פרמטרים
[in] resultCount
מספר תוצאות הסריקה.
[in] scanResultsTLV
תוצאות הסריקה.
ערכים מוחזרים
WEAVE_ERROR_INCORRECT_STATE
אם שרת הקצאת הרשת לא מאותחל כראוי.
WEAVE_ERROR_BUFFER_TOO_SMALL
אם מאגר התוצאות לא גדול מספיק.
WEAVE_NO_ERROR
בהצלחה.
other
קודי שגיאה אחרים הספציפיים ל-Weave או לפלטפורמה מסוימת, המציינים שאירעה שגיאה המונעת מהמכשיר לשלוח את התגובה 'הסריקה הושלמה'.

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(
  NetworkProvisioningDelegate *delegate
)

הגדרת בעל הגישה שיעבד אירועים של שרת הקצאת רשת.

פרטים
פרמטרים
[in] delegate
מצביע אל ' בעל גישה להקצאת רשת'.

כיבוי

WEAVE_ERROR Shutdown(
  void
)

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

פרטים
ערכים מוחזרים
WEAVE_NO_ERROR
בהצלחה.