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

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

Serverobjekt zum Antworten auf Anfragen zur Gerätebeschreibung.

Zusammenfassung

Übernahme

Übernimmt von: nl::Weave::WeaveServerBase
Direkte bekannte Unterklassen: nl::Weave::DeviceLayer::Internal::DeviceDescriptionServer

Konstruktoren und Zerstörer
DeviceDescriptionServer(void)

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

Öffentliche Attribute
AppState
void *
Ein von der Anwendung definierter Zustandszeiger, um Kontext für Rückrufe bereitzustellen.
OnIdentifyRequestReceived
HandleIdentifyRequestFunct
Diese Funktion ist für die Verarbeitung von IdentityRequest-Nachrichten zuständig.

Öffentliche Funktionen
Init(WeaveExchangeManager *exchangeMgr)
Initialisieren Sie den Status des Gerätebeschreibungsservers und registrieren Sie sich für den Empfang von Nachrichten zur Gerätebeschreibung.
Shutdown(void)
Fahren Sie den Device Description-Server herunter.

Öffentliche Typen

HandleIdentifyRequestFunct

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

Öffentliche Attribute

AppState

void * AppState

Ein von der Anwendung definierter Zustandszeiger, um Kontext für Rückrufe bereitzustellen.

OnIdentifyRequestReceived

HandleIdentifyRequestFunct OnIdentifyRequestReceived

Diese Funktion ist für die Verarbeitung von IdentityRequest-Nachrichten zuständig.

Details
Parameter
[in] appState
Ein Zeiger auf den von der Anwendung definierten Status, der bei der Registrierung für den Empfang von Nachrichten dieses Typs festgelegt wird.
[in] nodeId
Die Weave-Knoten-ID der Nachrichtenquelle.
[in] nodeAddr
Die IP-Adresse der Nachrichtenquelle.
[in] reqMsg
Ein Verweis auf die eingehende IdentityRequest-Nachricht.
[out] sendResp
Ein Verweis auf einen booleschen Wert, der auf „true“ gesetzt werden sollte, wenn eine Antwortnachricht an den Initiator gesendet werden soll.
[out] respMsg
Ein Verweis auf die IdentityResponse-Nachricht, die an den Initiator gesendet werden soll.

Öffentliche Funktionen

DeviceDescriptionServer

 DeviceDescriptionServer(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Initialisieren Sie den Status des Gerätebeschreibungsservers und registrieren Sie sich für den Empfang von Nachrichten zur Gerätebeschreibung.

param[in] ExchangeMgr Ein Hinweis auf den Weave Exchange Manager.

Details
Rückgabewerte
WEAVE_ERROR_INCORRECT_STATE
Wenn ein passiver Rendezvous-Remoteserver bereits registriert wurde.
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Wenn zu viele unerwünschte Nachrichten-Handler registriert sind.
WEAVE_NO_ERROR
Bei Erfolg.

Herunterfahren

WEAVE_ERROR Shutdown(
  void
)

Fahren Sie den Device Description-Server herunter.

Details
Rückgabewerte
WEAVE_NO_ERROR
bedingungslos.