nl::Weave::Profiles::DeviceDescription::DeviceDescriptionServer

#include <src/lib/profiles/device-description/DeviceDescription.h>

Oggetto server per rispondere alle richieste di descrizione del dispositivo.

Riepilogo

Eredità

Eredita da: nl::Weave::WeaveServerBase
Sottoclassi note direttamente: nl::Weave::DeviceLayer::Internal::DeviceDescriptionServer

Costruttori e distruttori
DeviceDescriptionServer(void)

Tipi pubblici
HandleIdentifyRequestFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyRequestMessage &reqMsg, bool &sendResp, IdentifyResponseMessage &respMsg) typedef
void(*

Attributi pubblici
AppState
void *
Puntatore dello stato definito dall'applicazione per fornire il contesto per i callback.
OnIdentifyRequestReceived
HandleIdentifyRequestFunct
Questa funzione è responsabile dell'elaborazione dei messaggi IdentityRequest.

Funzioni pubbliche
Init(WeaveExchangeManager *exchangeMgr)
Inizializza lo stato del server di descrizione del dispositivo ed esegui la registrazione per ricevere i messaggi di descrizione del dispositivo.
Shutdown(void)
Arresta il server di descrizione del dispositivo.

Tipi pubblici

HandleIdentifyRequestFunct

void(* HandleIdentifyRequestFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyRequestMessage &reqMsg, bool &sendResp, IdentifyResponseMessage &respMsg)

Attributi pubblici

AppState

void * AppState

Puntatore dello stato definito dall'applicazione per fornire il contesto per i callback.

OnIdentifyRequestReceived

HandleIdentifyRequestFunct OnIdentifyRequestReceived

Questa funzione è responsabile dell'elaborazione dei messaggi IdentityRequest.

Dettagli
Parametri
[in] appState
Un puntatore allo stato definito dall'applicazione impostato durante la registrazione per ricevere messaggi di questo tipo.
[in] nodeId
L'ID nodo Weave dell'origine del messaggio.
[in] nodeAddr
L'indirizzo IP dell'origine del messaggio.
[in] reqMsg
Un riferimento al messaggio IdentityRequest in arrivo.
[out] sendResp
Un riferimento a un valore booleano che deve essere impostato su true se un messaggio di risposta deve essere inviato all'iniziatore.
[out] respMsg
Un riferimento al messaggio IdentityResponse da inviare all'iniziatore.

Funzioni pubbliche

DeviceDescriptionServer

 DeviceDescriptionServer(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Inizializza lo stato del server di descrizione del dispositivo ed esegui la registrazione per ricevere i messaggi di descrizione del dispositivo.

param[in] exchangeMgr Un puntatore al gestore della piattaforma di scambio Weave.

Dettagli
Valori restituiti
WEAVE_ERROR_INCORRECT_STATE
Quando un server rendezvous passivo remoto è già stato registrato.
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Quando vengono registrati troppi gestori di messaggi non richiesti.
WEAVE_NO_ERROR
Un successo.

Arresto

WEAVE_ERROR Shutdown(
  void
)

Arresta il server di descrizione del dispositivo.

Dettagli
Valori restituiti
WEAVE_NO_ERROR
incondizionatamente.