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

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

Objet serveur permettant de répondre aux requêtes de description d'appareil.

Résumé

Héritage

Hérite de: nl::Weave::WeaveServerBase
Sous-classes directes connues: nl::Weave::DeviceLayer::Internal::DeviceDescriptionServer

Constructeurs et destructeurs
DeviceDescriptionServer(void)

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

Attributs publics
AppState
void *
Pointeur d'état défini par l'application pour fournir un contexte pour les rappels.
OnIdentifyRequestReceived
HandleIdentifyRequestFunct
Cette fonction est responsable du traitement des messages IdentityRequest.

Fonctions publiques
Init(WeaveExchangeManager *exchangeMgr)
Initialisez l'état du serveur de description de l'appareil et enregistrez-vous pour recevoir des messages de description des appareils.
Shutdown(void)
Arrêtez le serveur de description des appareils.

Types publics

HandleIdentifyRequestFunct

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

Attributs publics

AppState

void * AppState

Pointeur d'état défini par l'application pour fournir un contexte pour les rappels.

OnIdentifyRequestReceived

HandleIdentifyRequestFunct OnIdentifyRequestReceived

Cette fonction est responsable du traitement des messages IdentityRequest.

Détails
Paramètres
[in] appState
Pointeur vers l'état défini par l'application défini lors de l'enregistrement pour recevoir des messages de ce type.
[in] nodeId
ID du nœud Weave de la source du message.
[in] nodeAddr
Adresse IP de la source du message.
[in] reqMsg
Référence au message IdentityRequest entrant.
[out] sendResp
Référence à une valeur booléenne qui doit être définie sur "true" si un message de réponse doit être envoyé à l'initiateur.
[out] respMsg
Référence au message IdentifieResponse à envoyer à l'initiateur.

Fonctions publiques

DeviceDescriptionServer

 DeviceDescriptionServer(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Initialisez l'état du serveur de description de l'appareil et enregistrez-vous pour recevoir des messages de description des appareils.

param[in] ExchangeMgr Un pointeur vers le gestionnaire Weave Exchange.

Détails
Valeurs renvoyées
WEAVE_ERROR_INCORRECT_STATE
Lorsqu'un serveur de rendez-vous passif distant a déjà été enregistré.
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Lorsque trop de gestionnaires de messages non sollicités sont enregistrés.
WEAVE_NO_ERROR
En cas de réussite.

Arrêt

WEAVE_ERROR Shutdown(
  void
)

Arrêtez le serveur de description des appareils.

Détails
Valeurs renvoyées
WEAVE_NO_ERROR
sans condition.