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

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

Objet client permettant d'émettre des requêtes de description d'appareil.

Résumé

Constructeurs et destructeurs
DeviceDescriptionClient(void)

Types publics
HandleIdentifyResponseFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg) typedef
void(*
Cette fonction est chargée de traiter les messages IdentityResponse.

Attributs publics
AppState
void *
Objet état défini par l'application.
ExchangeMgr
[LECTURE SEULE] Objet du gestionnaire d'échanges
FabricState
[LECTURE SEULE] Objet d'état Fabric
OnIdentifyResponseReceived

Fonctions publiques
CancelExchange(void)
Annulez un échange IdentifierRequest en cours en attente d'une réponse.
Init(WeaveExchangeManager *exchangeMgr)
Initialisez l'état du client "Description de l'appareil".
SendIdentifyRequest(const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
Envoyer un message IdentityRequest à une adresse IP spécifique.
SendIdentifyRequest(const IdentifyRequestMessage & msg)
Envoyez un message de diffusion IdentifierRequest pour découvrir les nœuds Weave.
Shutdown(void)
Arrêtez le client de description de l'appareil.

Types publics

HandleIdentifyResponseFunct

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

Cette fonction est chargée de traiter les messages IdentityResponse.

Détails
Paramètres
[in] appState
Pointeur vers l'état défini par l'application lors de la création du contexte IdentityRequest Exchange.
[in] nodeId
ID du nœud Weave de la source du message.
[in] nodeAddr
Adresse IP du nœud répondant.
[in] msg
Référence au message IdentityResponse entrant.

Attributs publics

AppState

void * AppState

Objet état défini par l'application.

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[LECTURE SEULE] Objet du gestionnaire d'échanges

FabricState

const WeaveFabricState * FabricState

[LECTURE SEULE] Objet d'état Fabric

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

Fonctions publiques

CancelExchange

WEAVE_ERROR CancelExchange(
  void
)

Annulez un échange IdentifierRequest en cours en attente d'une réponse.

Détails
Valeurs de retour
WEAVE_NO_ERROR
sans conditions.

DeviceDescriptionClient

 DeviceDescriptionClient(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Initialisez l'état du client "Description de l'appareil".

param[in] exchangeMgr Pointeur vers le gestionnaire de places de marché Weave.

Détails
Valeurs de retour
WEAVE_ERROR_INCORRECT_STATE
Lorsqu'un serveur de rendez-vous passif distant a déjà été enregistré.
WEAVE_NO_ERROR
Pour la réussite.

SendIdentifyRequest

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

Envoyer un message IdentityRequest à une adresse IP spécifique.

Détails
Paramètres
[in] nodeAddr
Référence à l'adresse IP du nœud Weave à interroger.
[in] msg
Référence au message IdentityRequest à envoyer.
Valeurs de retour
WEAVE_ERROR_NO_MEMORY
Si l'allocation du contexte d'échange du tampon de paquets échoue.
WEAVE_NO_ERROR
Pour la réussite.
other
Autres codes d'erreur spécifiques à la plate-forme ou Weave indiquant qu'une erreur s'est produite empêchant l'envoi d'IdentityRequest.

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

Envoyez un message de diffusion IdentifierRequest pour découvrir les nœuds Weave.

Détails
Paramètres
[in] msg
Référence au message IdentityRequest à envoyer.

Arrêt

WEAVE_ERROR Shutdown(
  void
)

Arrêtez le client de description de l'appareil.

Cette fonction ferme tout contexte d'échange actif et réinitialise les pointeurs. Pour réutiliser l'objet, appelez à nouveau la méthode Init.

Détails
Valeurs de retour
WEAVE_NO_ERROR
sans conditions.