nl:: बुनें:: प्रोफाइल:: नेटवर्कप्रोविजनिंग:: नेटवर्क प्रोविजनिंग सर्वर

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

नेटवर्क प्रोविजनिंग प्रोफाइल को लागू करने के लिए सर्वर क्लास।

सारांश

विरासत

: से विरासत में मिली nl :: Weave :: WeaveServerBase
प्रत्यक्ष ज्ञात उपवर्ग:
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl< NetworkProvisioningServerImpl >
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl< 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
पहले स्कैन किए गए नेटवर्क वाले Get Networks पूर्ण संदेश भेजें।
SendGetWirelessRegulatoryConfigComplete ( PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
सहकर्मी को GetWirelessRegulatoryConfigComplete संदेश भेजें।
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)
नेटवर्क प्रोविजनिंग सर्वर को शट डाउन करें।

संरक्षित गुण

एमक्यूरओप

ExchangeContext * mCurOp

mCurOpType

uint8_t mCurOpType

एम-प्रतिनिधि

NetworkProvisioningDelegate * mDelegate

एमएलस्टऑप परिणामRe

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

सार्वजनिक गुण

स्थिति का कोड

uint16_t StatusCode

StatusProfileId

uint32_t StatusProfileId

SysError

WEAVE_ERROR SysError

सार्वजनिक समारोह

में इस

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

नेटवर्क प्रोविजनिंग सर्वर स्थिति को इनिशियलाइज़ करें और नेटवर्क प्रोविजनिंग संदेश प्राप्त करने के लिए पंजीकरण करें।

विवरण
मापदंडों
[in] exchangeMgr
सिस्टम वेव एक्सचेंज मैनेजर के लिए एक सूचक।
वापसी मूल्य
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
यदि बहुत से संदेश हैंडलर पहले ही पंजीकृत हो चुके हैं।
WEAVE_NO_ERROR
सफलता पर।

नेटवर्कप्रोविजनिंग सर्वर

 NetworkProvisioningServer(
  void
)

SendAddNetworkपूर्ण

virtual WEAVE_ERROR SendAddNetworkComplete(
  uint32_t networkId
)

यदि नेटवर्क सफलतापूर्वक जोड़ा गया था, तो नेटवर्क जोड़ें पूर्ण संदेश भेजें।

विवरण
मापदंडों
[in] networkId
जोड़े गए नेटवर्क की आईडी.
वापसी मूल्य
WEAVE_ERROR_INCORRECT_STATE
यदि नेटवर्क प्रोविजनिंग सर्वर ठीक से इनिशियलाइज़ नहीं किया गया है।
WEAVE_ERROR_NO_MEMORY
पैकेटबफर आवंटित करने में विफलता पर।
WEAVE_NO_ERROR
सफलता पर।
other
अन्य वीव या प्लेटफ़ॉर्म-विशिष्ट त्रुटि कोड इंगित करते हैं कि एक त्रुटि हुई है जो डिवाइस को नेटवर्क जोड़ें पूर्ण संदेश भेजने से रोक रही है।

SendGetNetworksपूर्ण

virtual WEAVE_ERROR SendGetNetworksComplete(
  uint8_t resultCount,
  PacketBuffer *resultsTLV
)

पहले स्कैन किए गए नेटवर्क वाले Get Networks पूर्ण संदेश भेजें।

विवरण
मापदंडों
[in] resultCount
स्कैन परिणामों की संख्या।
[in] scanResultsTLV
स्कैन के परिणाम।
वापसी मूल्य
WEAVE_ERROR_INCORRECT_STATE
यदि नेटवर्क प्रोविजनिंग सर्वर ठीक से इनिशियलाइज़ नहीं किया गया है।
WEAVE_ERROR_BUFFER_TOO_SMALL
यदि परिणाम बफर पर्याप्त बड़ा नहीं है।
WEAVE_NO_ERROR
सफलता पर।
other
अन्य वीव या प्लेटफ़ॉर्म-विशिष्ट त्रुटि कोड इंगित करते हैं कि एक त्रुटि हुई है जो डिवाइस को गेट नेटवर्क्स पूर्ण संदेश भेजने से रोक रही है।

भेजेंगेटवायरलेसरेगुलेटरीकॉन्फ़िगरेशनपूरा

virtual WEAVE_ERROR SendGetWirelessRegulatoryConfigComplete(
  PacketBuffer *resultsTLV
)

सहकर्मी को GetWirelessRegulatoryConfigComplete संदेश भेजें।

विवरण
मापदंडों
[in] resultsTLV
एक पैकेट बफ़र जिसमें वायरलेस नियामक कॉन्फ़िगरेशन जानकारी होती है जिसे वापस किया जाना है।
वापसी मूल्य
WEAVE_ERROR_INCORRECT_STATE
यदि नेटवर्क प्रोविजनिंग सर्वर ठीक से इनिशियलाइज़ नहीं किया गया है।
WEAVE_ERROR_NO_MEMORY
पैकेटबफर आवंटित करने में विफलता पर।
WEAVE_NO_ERROR
सफलता पर।
other
अन्य वीव या प्लेटफ़ॉर्म-विशिष्ट त्रुटि कोड इंगित करते हैं कि एक त्रुटि हुई है जो डिवाइस को नेटवर्क जोड़ें पूर्ण संदेश भेजने से रोक रही है।

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
अन्य वीव या प्लेटफ़ॉर्म-विशिष्ट त्रुटि कोड इंगित करते हैं कि डिवाइस को स्कैन पूर्ण प्रतिक्रिया भेजने से रोकने में त्रुटि हुई है।

SendStatusReport

virtual WEAVE_ERROR SendStatusReport(
  uint32_t statusProfileId,
  uint16_t statusCode,
  WEAVE_ERROR sysError
)

एक अनुरोध के लिए एक स्थिति रिपोर्ट प्रतिक्रिया भेजें।

विवरण
मापदंडों
[in] statusProfileId
बुन प्रोफ़ाइल आईडी यह स्थिति रिपोर्ट संबंधित है।
[in] statusCode
इस प्रतिक्रिया में शामिल किया जाने वाला स्थिति कोड।
[in] sysError
इस प्रतिक्रिया में शामिल किया जाने वाला सिस्टम त्रुटि कोड।
वापसी मूल्य
WEAVE_ERROR_INCORRECT_STATE
यदि कोई अनुरोध संसाधित नहीं किया जा रहा है।
WEAVE_NO_ERROR
सफलता पर।
other
अन्य वीव या प्लेटफ़ॉर्म-विशिष्ट त्रुटि कोड इंगित करते हैं कि डिवाइस को स्थिति रिपोर्ट भेजने से रोकने में त्रुटि हुई है।

भेजें सफलता प्रतिक्रिया

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

नेटवर्क प्रोविजनिंग अनुरोध के लिए एक सफल प्रतिक्रिया भेजें।

विवरण
वापसी मूल्य
WEAVE_ERROR_INCORRECT_STATE
यदि कोई अनुरोध संसाधित नहीं किया जा रहा है।
WEAVE_NO_ERROR
सफलता पर।
other
अन्य वीव या प्लेटफ़ॉर्म-विशिष्ट त्रुटि कोड इंगित करते हैं कि डिवाइस को सफलता प्रतिक्रिया भेजने से रोकने में त्रुटि हुई।

प्रतिनिधि सेट करें

void SetDelegate(
  NetworkProvisioningDelegate *delegate
)

नेटवर्क प्रोविजनिंग सर्वर ईवेंट को संसाधित करने के लिए प्रतिनिधि को सेट करें।

विवरण
मापदंडों
[in] delegate
नेटवर्क प्रोविजनिंग प्रतिनिधि के लिए एक सूचक।

शट डाउन

WEAVE_ERROR Shutdown(
  void
)

नेटवर्क प्रोविजनिंग सर्वर को शट डाउन करें।

विवरण
वापसी मूल्य
WEAVE_NO_ERROR
सफलता पर।