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

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

סיווג שרת ליישום הפרופיל להקצאת רשת.

סיכום

ירושה

עובר בירושה מ: nl::Weave::WeaveServerBase
מחלקות משנה מוכרות ישירות:
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl&lt; NetworkLDAPServerImpl >
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl&lt; ImplClass >

בנייה
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
להגדיר את בעל הגישה לעיבוד אירועים של שרת הקצאת הרשת (Network Management Server).
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

פונקציות ציבוריות

Init

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
)

להגדיר את בעל הגישה לעיבוד אירועים של שרת הקצאת הרשת (Network Management Server).

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

כיבוי

WEAVE_ERROR Shutdown(
  void
)

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

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