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

nl:: Weben:: Profile:: Gerätebeschreibung:: GerätebeschreibungClient

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

Client-Objekt zum Ausgeben von Gerätebeschreibungsanforderungen.

Zusammenfassung

Konstruktoren und Destruktoren

DeviceDescriptionClient (void)

Öffentliche Typen

HandleIdentifyResponseFunct )(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg) Typdef
void(*
Diese Funktion ist für die Verarbeitung von IdentityResponse-Nachrichten verantwortlich.

Öffentliche Attribute

AppState
void *
Anwendungsdefiniertes Zustandsobjekt.
ExchangeMgr
[NUR LESEN] Exchange-Manager-Objekt
FabricState
[NUR LESEN] Fabric-Zustandsobjekt
OnIdentifyResponseReceived

Öffentliche Funktionen

CancelExchange (void)
Brechen Sie einen laufenden IdentifyRequest-Austausch ab, der auf eine Antwort wartet.
Init ( WeaveExchangeManager *exchangeMgr)
Initialisieren Sie den Gerätebeschreibungs-Client-Status.
SendIdentifyRequest (const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
Senden Sie eine IdentifyRequest-Nachricht an eine bestimmte IP-Adresse.
SendIdentifyRequest (const IdentifyRequestMessage & msg)
Senden Sie eine Broadcast-IdentifyRequest-Nachricht, um Weave-Knoten zu erkennen.
Shutdown (void)
Fahren Sie den Device Description-Client herunter.

Öffentliche Typen

HandleIdentifyResponseFunct

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

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

Einzelheiten
Parameter
[in] appState
Ein Zeiger auf den anwendungsdefinierten Statussatz beim Erstellen des IdentityRequest Exchange-Kontexts.
[in] nodeId
Die Weave-Knoten-ID der Nachrichtenquelle.
[in] nodeAddr
Die IP-Adresse des antwortenden Knotens.
[in] msg
Ein Verweis auf die eingehende IdentifyResponse-Nachricht.

Öffentliche Attribute

AppState

void * AppState

Anwendungsdefiniertes Zustandsobjekt.

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[NUR LESEN] Exchange-Manager-Objekt

Stoffstatus

const WeaveFabricState * FabricState

[NUR LESEN] Fabric-Zustandsobjekt

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

Öffentliche Funktionen

AbbrechenExchange

WEAVE_ERROR CancelExchange(
  void
)

Brechen Sie einen laufenden IdentifyRequest-Austausch ab, der auf eine Antwort wartet.

Einzelheiten
Rückgabewerte
WEAVE_NO_ERROR
bedingungslos.

GerätebeschreibungClient

 DeviceDescriptionClient(
  void
)

Drin

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Initialisieren Sie den Gerätebeschreibungs-Client-Status.

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_NO_ERROR
Auf Erfolg.

SendIdentifyRequest

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

Senden Sie eine IdentifyRequest-Nachricht an eine bestimmte IP-Adresse.

Einzelheiten
Parameter
[in] nodeAddr
Ein Verweis auf die IP-Adresse des abzufragenden Weave-Knotens.
[in] msg
Ein Verweis auf die zu sendende IdentifyRequest-Nachricht.
Rückgabewerte
WEAVE_ERROR_NO_MEMORY
Wenn die Zuweisung des Austauschkontexts des Paketpuffers fehlschlägt.
WEAVE_NO_ERROR
Auf Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die anzeigen, dass ein Fehler aufgetreten ist, der das Senden der IdentifyRequest verhindert.

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

Senden Sie eine Broadcast-IdentifyRequest-Nachricht, um Weave-Knoten zu erkennen.

Einzelheiten
Parameter
[in] msg
Ein Verweis auf die zu sendende IdentifyRequest-Nachricht.

Schließen

WEAVE_ERROR Shutdown(
  void
)

Fahren Sie den Device Description-Client herunter.

Diese Funktion schließt alle aktiven Austauschkontexte und setzt Zeiger zurück. Das Objekt kann durch den Aufruf der wiederverwendet werden Init erneut Methode.

Einzelheiten
Rückgabewerte
WEAVE_NO_ERROR
bedingungslos.