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

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

Serverklasse zum Implementieren des Profils für die Netzwerkbereitstellung.

Zusammenfassung

Übernahme

Übernimmt von: nl::Weave::WeaveServerBase
Direkte bekannte abgeleitete Klassen:
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl&lt; NetworkProvisioningServerImpl >
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl&lt; ImplClass >

Konstruktoren und Zerstörer
NetworkProvisioningServer(void)

Geschützte Attribute
mCurOp
mCurOpType
uint8_t
mDelegate
mLastOpResult
struct nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer::@217

Öffentliche Attribute
StatusCode
uint16_t
StatusProfileId
uint32_t
SysError

Öffentliche Funktionen
Init(WeaveExchangeManager *exchangeMgr)
Initialisieren Sie den Status des Network Provisioning Servers und registrieren Sie sich für den Empfang von Network Provisioning-Nachrichten.
SendAddNetworkComplete(uint32_t networkId)
virtual WEAVE_ERROR
Wenn das Netzwerk erfolgreich hinzugefügt wurde, wird eine Nachricht "Netzwerk hinzufügen abgeschlossen" gesendet.
SendGetNetworksComplete(uint8_t resultCount, PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
Eine Nachricht zum Abschluss des Netzwerks senden, die die zuvor gescannten Netzwerke enthält.
SendGetWirelessRegulatoryConfigComplete(PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
Senden Sie eine GetWirelessRegulatoryConfigComplete-Nachricht an den Peer.
SendNetworkScanComplete(uint8_t resultCount, PacketBuffer *scanResultsTLV)
virtual WEAVE_ERROR
Antwortnachricht für abgeschlossenen Netzwerkscan mit den Ergebnissen des Scans senden.
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
Senden Sie eine Statusberichtsantwort auf eine Anfrage.
SendSuccessResponse(void)
virtual WEAVE_ERROR
Senden Sie eine Erfolgsantwort auf eine Anfrage für die Netzwerkbereitstellung.
SetDelegate(NetworkProvisioningDelegate *delegate)
void
Legen Sie fest, dass der Bevollmächtigte Serverereignisse für die Netzwerkbereitstellung verarbeitet.
Shutdown(void)
Fahren Sie den Network Provisioning Server herunter.

Geschützte Attribute

mCurOp

ExchangeContext * mCurOp

mCurOpType

uint8_t mCurOpType

mDelegate

NetworkProvisioningDelegate * mDelegate

mLastOpResult

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

Öffentliche Attribute

StatusCode

uint16_t StatusCode

StatusProfileId

uint32_t StatusProfileId

SysError

WEAVE_ERROR SysError

Öffentliche Funktionen

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Initialisieren Sie den Status des Network Provisioning Servers und registrieren Sie sich für den Empfang von Network Provisioning-Nachrichten.

Details
Parameter
[in] exchangeMgr
Ein Verweis auf das System Weave Exchange Manager.
Rückgabewerte
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Wenn bereits zu viele Nachrichten-Handler registriert wurden.
WEAVE_NO_ERROR
Bei Erfolg.

NetworkProvisioningServer

 NetworkProvisioningServer(
  void
)

SendAddNetworkComplete

virtual WEAVE_ERROR SendAddNetworkComplete(
  uint32_t networkId
)

Wenn das Netzwerk erfolgreich hinzugefügt wurde, wird eine Nachricht "Netzwerk hinzufügen abgeschlossen" gesendet.

Details
Parameter
[in] networkId
Die ID des hinzugefügten Netzwerks.
Rückgabewerte
WEAVE_ERROR_INCORRECT_STATE
Wenn der Netzwerkbereitstellungsserver nicht korrekt initialisiert wurde.
WEAVE_ERROR_NO_MEMORY
Wenn ein PacketBuffer nicht zugeordnet werden kann.
WEAVE_NO_ERROR
Bei Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die darauf hinweisen, dass ein Fehler aufgetreten ist und das Gerät die Meldung „Netzwerk hinzufügen“ nicht senden konnte.

SendGetNetworksComplete

virtual WEAVE_ERROR SendGetNetworksComplete(
  uint8_t resultCount,
  PacketBuffer *resultsTLV
)

Eine Nachricht zum Abschluss des Netzwerks senden, die die zuvor gescannten Netzwerke enthält.

Details
Parameter
[in] resultCount
Die Anzahl der Scanergebnisse.
[in] scanResultsTLV
Die Scanergebnisse.
Rückgabewerte
WEAVE_ERROR_INCORRECT_STATE
Wenn der Netzwerkbereitstellungsserver nicht korrekt initialisiert wurde.
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn der Ergebnispuffer nicht groß genug ist.
WEAVE_NO_ERROR
Bei Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die darauf hinweisen, dass ein Fehler aufgetreten ist und das Gerät die Nachricht zum Abschluss des Netzwerks nicht senden konnte.

SendGetWirelessRegulatoryConfigComplete

virtual WEAVE_ERROR SendGetWirelessRegulatoryConfigComplete(
  PacketBuffer *resultsTLV
)

Senden Sie eine GetWirelessRegulatoryConfigComplete-Nachricht an den Peer.

Details
Parameter
[in] resultsTLV
Ein Paketzwischenspeicher mit den Informationen zur Regulierung des WLAN, die zurückgegeben werden sollen.
Rückgabewerte
WEAVE_ERROR_INCORRECT_STATE
Wenn der Netzwerkbereitstellungsserver nicht korrekt initialisiert wurde.
WEAVE_ERROR_NO_MEMORY
Wenn ein PacketBuffer nicht zugeordnet werden kann.
WEAVE_NO_ERROR
Bei Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die darauf hinweisen, dass ein Fehler aufgetreten ist und das Gerät die Meldung „Netzwerk hinzufügen“ nicht senden konnte.

SendNetworkScanComplete

virtual WEAVE_ERROR SendNetworkScanComplete(
  uint8_t resultCount,
  PacketBuffer *scanResultsTLV
)

Antwortnachricht für abgeschlossenen Netzwerkscan mit den Ergebnissen des Scans senden.

Details
Parameter
[in] resultCount
Die Anzahl der Scanergebnisse.
[in] scanResultsTLV
Die Scanergebnisse.
Rückgabewerte
WEAVE_ERROR_INCORRECT_STATE
Wenn der Netzwerkbereitstellungsserver nicht korrekt initialisiert wurde.
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn der Ergebnispuffer nicht groß genug ist.
WEAVE_NO_ERROR
Bei Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die darauf hinweisen, dass ein Fehler aufgetreten ist und das Gerät die Antwort „Scan abgeschlossen“ nicht sendet.

SendStatusReport

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

Senden Sie eine Statusberichtsantwort auf eine Anfrage.

Details
Parameter
[in] statusProfileId
Die Weave-Profil-ID, auf die sich dieser Statusbericht bezieht.
[in] statusCode
Der Statuscode, der in diese Antwort eingefügt werden soll.
[in] sysError
Der Systemfehlercode, der in dieser Antwort enthalten sein soll.
Rückgabewerte
WEAVE_ERROR_INCORRECT_STATE
Wenn gerade keine Anfrage bearbeitet wird.
WEAVE_NO_ERROR
Bei Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die darauf hinweisen, dass ein Fehler aufgetreten ist und das Gerät den Statusbericht nicht senden konnte.

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

Senden Sie eine Erfolgsantwort auf eine Anfrage für die Netzwerkbereitstellung.

Details
Rückgabewerte
WEAVE_ERROR_INCORRECT_STATE
Wenn gerade keine Anfrage bearbeitet wird.
WEAVE_NO_ERROR
Bei Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die darauf hinweisen, dass ein Fehler aufgetreten ist und das Gerät die Erfolgsantwort nicht senden konnte.

SetDelegate

void SetDelegate(
  NetworkProvisioningDelegate *delegate
)

Legen Sie fest, dass der Bevollmächtigte Serverereignisse für die Netzwerkbereitstellung verarbeitet.

Details
Parameter
[in] delegate
Ein Zeiger auf den Network Provisioning Delegate.

Herunterfahren

WEAVE_ERROR Shutdown(
  void
)

Fahren Sie den Network Provisioning Server herunter.

Details
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.