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

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

Classe server per l'implementazione del profilo di provisioning di rete.

Riepilogo

Eredità

Eredita da: nl::Weave::WeaveServerBase
Sottoclassi note dirette:
  nl::Weave::Devicestrato::Internal::GenericNetworkProvisioningServerImpl< NetworkProvisioningServerImpl >
  nl:Weave::DeviceLayer::Internal Provisioning{/1

Costruttori e distruttori

NetworkProvisioningServer(void)

Attributi protetti

mCurOp
mCurOpType
uint8_t
mDelegate
mLastOpResult
struct nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer::@217

Attributi pubblici

StatusCode
uint16_t
StatusProfileId
uint32_t
SysError

Funzioni pubbliche

Init(WeaveExchangeManager *exchangeMgr)
Inizializzare lo stato del server di provisioning di rete e registrarsi per ricevere i messaggi di provisioning di rete.
SendAddNetworkComplete(uint32_t networkId)
virtual WEAVE_ERROR
Invia un messaggio Aggiungi completamento rete se la rete è stata aggiunta correttamente.
SendGetNetworksComplete(uint8_t resultCount, PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
Invia un messaggio Ottieni reti completato contenente le reti scansionate in precedenza.
SendGetWirelessRegulatoryConfigComplete(PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
Invia un messaggio GetCellulareRegulatoryConfigComplete al peer.
SendNetworkScanComplete(uint8_t resultCount, PacketBuffer *scanResultsTLV)
virtual WEAVE_ERROR
Invia un messaggio di risposta di completamento della scansione della rete contenente i risultati della scansione.
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
Inviare una risposta a un report di stato a una richiesta.
SendSuccessResponse(void)
virtual WEAVE_ERROR
Invia una risposta corretta a una richiesta di provisioning di rete.
SetDelegate(NetworkProvisioningDelegate *delegate)
void
Imposta il delegato affinché elabori gli eventi del server di provisioning di rete.
Shutdown(void)
Arresta il server di provisioning della rete.

Attributi protetti

mCurOp

ExchangeContext * mCurOp

mCurOpType

uint8_t mCurOpType

mDelegate

NetworkProvisioningDelegate * mDelegate

mLastOpResult

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

Attributi pubblici

StatusCode

uint16_t StatusCode

StatusProfileId

uint32_t StatusProfileId

SysError

WEAVE_ERROR SysError

Funzioni pubbliche

Inizia

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Inizializzare lo stato del server di provisioning di rete e registrarsi per ricevere i messaggi di provisioning di rete.

Dettagli
Parametri
[in] exchangeMgr
Un puntatore al sistema Weave Exchange Manager.
Valori restituiti
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Se sono già stati registrati troppi gestori di messaggi.
WEAVE_NO_ERROR
In caso di successo.

NetworkProvisioningServer

 NetworkProvisioningServer(
  void
)

SendAddNetworkComplete

virtual WEAVE_ERROR SendAddNetworkComplete(
  uint32_t networkId
)

Invia un messaggio Aggiungi completamento rete se la rete è stata aggiunta correttamente.

Dettagli
Parametri
[in] networkId
L'ID della rete aggiunta.
Valori restituiti
WEAVE_ERROR_INCORRECT_STATE
Se il server di provisioning della rete non è inizializzato correttamente.
WEAVE_ERROR_NO_MEMORY
In caso di errore durante l'allocazione di un PacketBuffer.
WEAVE_NO_ERROR
In caso di successo.
other
Altri codici di errore Weave o specifici della piattaforma che indicano che si è verificato un errore che impedisce al dispositivo di inviare il messaggio Aggiungi rete completata.

SendGetNetworksComplete

virtual WEAVE_ERROR SendGetNetworksComplete(
  uint8_t resultCount,
  PacketBuffer *resultsTLV
)

Invia un messaggio Ottieni reti completato contenente le reti scansionate in precedenza.

Dettagli
Parametri
[in] resultCount
Il numero di risultati della scansione.
[in] scanResultsTLV
I risultati della scansione.
Valori restituiti
WEAVE_ERROR_INCORRECT_STATE
Se il server di provisioning della rete non è inizializzato correttamente.
WEAVE_ERROR_BUFFER_TOO_SMALL
Se il buffer dei risultati non è abbastanza grande.
WEAVE_NO_ERROR
In caso di successo.
other
Altri codici di errore Weave o specifici della piattaforma che indicano che si è verificato un errore che impedisce al dispositivo di inviare il messaggio Ottieni reti completate.

SendGetWirelessRegulatoryConfigComplete

virtual WEAVE_ERROR SendGetWirelessRegulatoryConfigComplete(
  PacketBuffer *resultsTLV
)

Invia un messaggio GetCellulareRegulatoryConfigComplete al peer.

Dettagli
Parametri
[in] resultsTLV
Un buffer di pacchetti contenente le informazioni di configurazione normative wireless da restituire.
Valori restituiti
WEAVE_ERROR_INCORRECT_STATE
Se il server di provisioning della rete non è inizializzato correttamente.
WEAVE_ERROR_NO_MEMORY
In caso di errore durante l'allocazione di un PacketBuffer.
WEAVE_NO_ERROR
In caso di successo.
other
Altri codici di errore Weave o specifici della piattaforma che indicano che si è verificato un errore che impedisce al dispositivo di inviare il messaggio Aggiungi rete completata.

SendNetworkScanComplete

virtual WEAVE_ERROR SendNetworkScanComplete(
  uint8_t resultCount,
  PacketBuffer *scanResultsTLV
)

Invia un messaggio di risposta di completamento della scansione della rete contenente i risultati della scansione.

Dettagli
Parametri
[in] resultCount
Il numero di risultati della scansione.
[in] scanResultsTLV
I risultati della scansione.
Valori restituiti
WEAVE_ERROR_INCORRECT_STATE
Se il server di provisioning della rete non è inizializzato correttamente.
WEAVE_ERROR_BUFFER_TOO_SMALL
Se il buffer dei risultati non è abbastanza grande.
WEAVE_NO_ERROR
In caso di successo.
other
Altri codici di errore Weave o specifici della piattaforma che indicano che si è verificato un errore che impedisce al dispositivo di inviare la risposta Scansione completa.

SendStatusReport

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

Inviare una risposta a un report di stato a una richiesta.

Dettagli
Parametri
[in] statusProfileId
L'ID profilo Weave a cui fa riferimento questo rapporto di stato.
[in] statusCode
Il codice di stato da includere in questa risposta.
[in] sysError
Il codice di errore di sistema da includere in questa risposta.
Valori restituiti
WEAVE_ERROR_INCORRECT_STATE
Se non ci sono richieste in fase di elaborazione.
WEAVE_NO_ERROR
In caso di successo.
other
Altri codici di errore Weave o specifici della piattaforma che indicano che si è verificato un errore che impedisce al dispositivo di inviare il report sullo stato.

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

Invia una risposta corretta a una richiesta di provisioning di rete.

Dettagli
Valori restituiti
WEAVE_ERROR_INCORRECT_STATE
Se non ci sono richieste in fase di elaborazione.
WEAVE_NO_ERROR
In caso di successo.
other
Altri codici di errore Weave o specifici della piattaforma che indicano che si è verificato un errore che impedisce al dispositivo di inviare la risposta corretta.

SetDelegate

void SetDelegate(
  NetworkProvisioningDelegate *delegate
)

Imposta il delegato affinché elabori gli eventi del server di provisioning di rete.

Dettagli
Parametri
[in] delegate
Un puntatore al delegato del provisioning di rete.

Arresto

WEAVE_ERROR Shutdown(
  void
)

Arresta il server di provisioning della rete.

Dettagli
Valori restituiti
WEAVE_NO_ERROR
In caso di successo.