Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

nl:: Weben:: Profile:: Gerätebeschreibung:: GerätebeschreibungServer

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

Serverobjekt zum Antworten auf Gerätebeschreibungsanforderungen.

Zusammenfassung

Erbe

Erbt von: nl :: Weave :: WeaveServerBase
Direkt bekannt Subklassen: nl :: Weave :: DeviceLayer :: Intern :: DeviceDescriptionServer

Konstruktoren und Destruktoren

DeviceDescriptionServer (void)

Öffentliche Typen

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

Öffentliche Attribute

AppState
void *
Anwendungsdefinierter Zustandszeiger, um Kontext für Rückrufe bereitzustellen.
OnIdentifyRequestReceived
HandleIdentifyRequestFunct
Diese Funktion ist für die Verarbeitung von IdentityRequest-Nachrichten verantwortlich.

Öffentliche Funktionen

Init ( WeaveExchangeManager *exchangeMgr)
Initialisieren Sie den Status des Gerätebeschreibungsservers und registrieren Sie sich für den Empfang von Gerätebeschreibungsnachrichten.
Shutdown (void)
Fahren Sie den Gerätebeschreibungsserver 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

Anwendungsdefinierter Zustandszeiger, um Kontext für Rückrufe bereitzustellen.

OnIdentifyRequestReceived

HandleIdentifyRequestFunct OnIdentifyRequestReceived

Diese Funktion ist für die Verarbeitung von IdentityRequest-Nachrichten verantwortlich.

Einzelheiten
Parameter
[in] appState
Ein Zeiger auf den anwendungsdefinierten Status, der beim Registrieren 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 IdentifyRequest-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 IdentifyResponse-Nachricht, die an den Initiator gesendet werden soll.

Öffentliche Funktionen

GerätebeschreibungServer

 DeviceDescriptionServer(
  void
)

Drin

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

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

param[in] exchangeMgr Ein Zeiger auf den Weave Exchange Manager.

Einzelheiten
Rückgabewerte
WEAVE_ERROR_INCORRECT_STATE
Wenn bereits ein entfernter passiver Rendezvous-Server registriert wurde.
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Wenn zu viele unerwünschte Nachrichtenhandler registriert sind.
WEAVE_NO_ERROR
Auf Erfolg.

Schließen

WEAVE_ERROR Shutdown(
  void
)

Fahren Sie den Gerätebeschreibungsserver herunter.

Einzelheiten
Rückgabewerte
WEAVE_NO_ERROR
bedingungslos.