Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

nl:: Weben:: Profile:: Netzwerkbereitstellung:: NetworkProvisioningServer

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

Serverklasse zum Implementieren des Network Provisioning-Profils.

Zusammenfassung

Erbe

Erbt von: nl :: Weave :: WeaveServerBase
Direkt bekannte Unterklassen:
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl< NetworkProvisioningServerImpl >
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl< ImplClass >

Konstruktoren und Destruktoren

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
Senden Sie eine Nachricht zum vollständigen Hinzufügen des Netzwerks, wenn das Netzwerk erfolgreich hinzugefügt wurde.
SendGetNetworksComplete (uint8_t resultCount, PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
Senden Sie eine Get Networks Complete-Nachricht mit den zuvor gescannten Netzwerken.
SendGetWirelessRegulatoryConfigComplete ( PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
Senden Sie eine GetWirelessRegulatoryConfigComplete-Nachricht an den Peer.
SendNetworkScanComplete (uint8_t resultCount, PacketBuffer *scanResultsTLV)
virtual WEAVE_ERROR
Senden Sie eine Antwortnachricht "Network Scan Complete" mit den Ergebnissen des Scans.
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 Netzwerkbereitstellungsanforderung.
SetDelegate ( NetworkProvisioningDelegate *delegate)
void
Legen Sie den Stellvertreter fest, um Network Provisioning Server-Ereignisse zu verarbeiten.
Shutdown (void)
Fahren Sie den Netzwerkbereitstellungsserver herunter.

Geschützte Attribute

mCurOp

ExchangeContext * mCurOp

mCurOpType

uint8_t mCurOpType

mDelegieren

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

Drin

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.

Einzelheiten
Parameter
[in] exchangeMgr
Ein Zeiger auf den Weave Exchange Manager des Systems.
Rückgabewerte
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Wenn bereits zu viele Message-Handler registriert wurden.
WEAVE_NO_ERROR
Auf Erfolg.

NetworkProvisioningServer

 NetworkProvisioningServer(
  void
)

SendAddNetworkComplete

virtual WEAVE_ERROR SendAddNetworkComplete(
  uint32_t networkId
)

Senden Sie eine Nachricht zum vollständigen Hinzufügen des Netzwerks, wenn das Netzwerk erfolgreich hinzugefügt wurde.

Einzelheiten
Parameter
[in] networkId
Die ID des hinzugefügten Netzwerks.
Rückgabewerte
WEAVE_ERROR_INCORRECT_STATE
Wenn der Network Provisioning Server nicht richtig initialisiert wurde.
WEAVE_ERROR_NO_MEMORY
Bei fehlgeschlagener Zuweisung eines PacketBuffer.
WEAVE_NO_ERROR
Auf Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die darauf hinweisen, dass ein Fehler aufgetreten ist, der das Gerät daran hindert, die Nachricht Add Network Complete zu senden.

SendGetNetworksComplete

virtual WEAVE_ERROR SendGetNetworksComplete(
  uint8_t resultCount,
  PacketBuffer *resultsTLV
)

Senden Sie eine Get Networks Complete-Nachricht mit den zuvor gescannten Netzwerken.

Einzelheiten
Parameter
[in] resultCount
Die Anzahl der Scanergebnisse.
[in] scanResultsTLV
Die Scan-Ergebnisse.
Rückgabewerte
WEAVE_ERROR_INCORRECT_STATE
Wenn der Network Provisioning Server nicht richtig initialisiert ist.
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn der Ergebnispuffer nicht groß genug ist.
WEAVE_NO_ERROR
Auf Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die anzeigen, dass ein Fehler aufgetreten ist, der verhindert, dass das Gerät die Nachricht Get Networks Complete sendet.

SendGetWirelessRegulatoryConfigComplete

virtual WEAVE_ERROR SendGetWirelessRegulatoryConfigComplete(
  PacketBuffer *resultsTLV
)

Senden Sie eine GetWirelessRegulatoryConfigComplete-Nachricht an den Peer.

Einzelheiten
Parameter
[in] resultsTLV
Ein Paketpuffer, der die zurückzugebenden drahtlosen regulatorischen Konfigurationsinformationen enthält.
Rückgabewerte
WEAVE_ERROR_INCORRECT_STATE
Wenn der Network Provisioning Server nicht richtig initialisiert wurde.
WEAVE_ERROR_NO_MEMORY
Bei fehlgeschlagener Zuweisung eines PacketBuffer.
WEAVE_NO_ERROR
Auf Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die darauf hinweisen, dass ein Fehler aufgetreten ist, der das Gerät daran hindert, die Nachricht Add Network Complete zu senden.

SendNetworkScanComplete

virtual WEAVE_ERROR SendNetworkScanComplete(
  uint8_t resultCount,
  PacketBuffer *scanResultsTLV
)

Senden Sie eine Antwortnachricht "Network Scan Complete" mit den Ergebnissen des Scans.

Einzelheiten
Parameter
[in] resultCount
Die Anzahl der Scanergebnisse.
[in] scanResultsTLV
Die Scan-Ergebnisse.
Rückgabewerte
WEAVE_ERROR_INCORRECT_STATE
Wenn der Network Provisioning Server nicht richtig initialisiert wurde.
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn der Ergebnispuffer nicht groß genug ist.
WEAVE_NO_ERROR
Auf Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die anzeigen, dass ein Fehler aufgetreten ist, der verhindert, dass das Gerät die Antwort „Scan abgeschlossen“ sendet.

Statusbericht senden

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

Senden Sie eine Statusberichtsantwort auf eine Anfrage.

Einzelheiten
Parameter
[in] statusProfileId
Die Weave-Profil-ID, auf die sich dieser Statusbericht bezieht.
[in] statusCode
Der Statuscode, der in diese Antwort aufgenommen werden soll.
[in] sysError
Der in diese Antwort aufzunehmende Systemfehlercode.
Rückgabewerte
WEAVE_ERROR_INCORRECT_STATE
Wenn keine Anfrage bearbeitet wird.
WEAVE_NO_ERROR
Auf Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die anzeigen, dass ein Fehler aufgetreten ist, der das Senden des Statusberichts durch das Gerät verhindert hat.

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

Senden Sie eine Erfolgsantwort auf eine Netzwerkbereitstellungsanforderung.

Einzelheiten
Rückgabewerte
WEAVE_ERROR_INCORRECT_STATE
Wenn keine Anfrage bearbeitet wird.
WEAVE_NO_ERROR
Auf Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die anzeigen, dass ein Fehler aufgetreten ist, der verhindert, dass das Gerät die Erfolgsantwort sendet.

Stellvertreter einstellen

void SetDelegate(
  NetworkProvisioningDelegate *delegate
)

Legen Sie fest, dass die Stellvertretung Network Provisioning Server-Ereignisse verarbeitet.

Einzelheiten
Parameter
[in] delegate
Ein Zeiger auf den Netzwerkbereitstellungsdelegierten.

Schließen

WEAVE_ERROR Shutdown(
  void
)

Fahren Sie den Netzwerkbereitstellungsserver herunter.

Einzelheiten
Rückgabewerte
WEAVE_NO_ERROR
Auf Erfolg.