nl::Weave::Profiles::DeviceDescription::DeviceDescriptionClient

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

Oggetto client per l'invio di richieste Descrizione dispositivo.

Riepilogo

Costruttori e distruttori
DeviceDescriptionClient(void)

Tipi pubblici
HandleIdentifyResponseFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg) typedef
void(*
Questa funzione è responsabile dell'elaborazione dei messaggi IdentityResponse.

Attributi pubblici
AppState
void *
Oggetto di stato definito dell'applicazione.
ExchangeMgr
[SOLO LETTURA] Oggetto Exchange Manager
FabricState
[SOLO LETTURA] Oggetto stato fabric
OnIdentifyResponseReceived

Funzioni pubbliche
CancelExchange(void)
Annulla uno scambio IdentificaRequest in corso in attesa di risposta.
Init(WeaveExchangeManager *exchangeMgr)
Inizializzare lo stato client della descrizione del dispositivo.
SendIdentifyRequest(const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
Inviare un messaggio IdentityRequest a un determinato indirizzo IP.
SendIdentifyRequest(const IdentifyRequestMessage & msg)
Invia un messaggio IdentificaRequest per l'individuazione dei nodi Weave.
Shutdown(void)
Arresta il client di descrizione del dispositivo.

Tipi pubblici

HandleIdentifyResponseFunct

void(* HandleIdentifyResponseFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg)

Questa funzione è responsabile dell'elaborazione dei messaggi IdentityResponse.

Dettagli
Parametri
[in] appState
Un puntatore allo stato definito dall'applicazione impostato durante la creazione del contesto di IdentityRequest Exchange.
[in] nodeId
L'ID nodo Weave dell'origine del messaggio.
[in] nodeAddr
L'indirizzo IP del nodo che risponde.
[in] msg
Un riferimento al messaggio IdentificaResponse in arrivo.

Attributi pubblici

AppState

void * AppState

Oggetto di stato definito dell'applicazione.

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[SOLO LETTURA] Oggetto Exchange Manager

FabricState

const WeaveFabricState * FabricState

[SOLO LETTURA] Oggetto stato fabric

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

Funzioni pubbliche

CancelExchange

WEAVE_ERROR CancelExchange(
  void
)

Annulla uno scambio IdentificaRequest in corso in attesa di risposta.

Dettagli
Valori restituiti
WEAVE_NO_ERROR
incondizionatamente.

DeviceDescriptionClient

 DeviceDescriptionClient(
  void
)

Inizia

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Inizializzare lo stato client della descrizione del dispositivo.

param[in] ExchangeMgr Un puntatore a Weave Exchange Manager.

Dettagli
Valori restituiti
WEAVE_ERROR_INCORRECT_STATE
Quando un server rendezvous passivo remoto è già stato registrato.
WEAVE_NO_ERROR
In caso di successo.

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IPAddress & nodeAddr,
  const IdentifyRequestMessage & msg
)

Inviare un messaggio IdentityRequest a un determinato indirizzo IP.

Dettagli
Parametri
[in] nodeAddr
Un riferimento all'indirizzo IP del nodo Weave su cui eseguire la query.
[in] msg
Un riferimento al messaggio IdentityRequest da inviare.
Valori restituiti
WEAVE_ERROR_NO_MEMORY
Se l'allocazione del contesto di scambio del buffer dei pacchetti non va a buon fine.
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 l'invio di IdentityRequest.

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

Invia un messaggio IdentificaRequest per l'individuazione dei nodi Weave.

Dettagli
Parametri
[in] msg
Un riferimento al messaggio IdentityRequest da inviare.

Arresto

WEAVE_ERROR Shutdown(
  void
)

Arresta il client di descrizione del dispositivo.

Questa funzione chiude qualsiasi contesto di Exchange attivo e reimposta i puntatori. L'oggetto può essere riutilizzato richiamando il metodo Init.

Dettagli
Valori restituiti
WEAVE_NO_ERROR
incondizionatamente.