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

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

Client-Objekt zum Senden von Gerätebeschreibungsanfragen.

Zusammenfassung

Konstruktoren und Zerstörer
DeviceDescriptionClient(void)

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

Öffentliche Attribute
AppState
void *
Von der Anwendung definiertes Zustandsobjekt.
ExchangeMgr
[READ ONLY] Exchange-Manager-Objekt
FabricState
[READ ONLY] Fabric-Zustandsobjekt
OnIdentifyResponseReceived

Öffentliche Funktionen
CancelExchange(void)
Einen laufenden Identitätsanfrage-Austausch abbrechen, wenn auf eine Antwort gewartet wird
Init(WeaveExchangeManager *exchangeMgr)
Initialisieren Sie den Status des Gerätebeschreibungs-Clients.
SendIdentifyRequest(const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
Senden Sie eine IdentityRequest-Nachricht an eine bestimmte IP-Adresse.
SendIdentifyRequest(const IdentifyRequestMessage & msg)
Sende eine Broadcast-Identifizierungsanfrage-Nachricht, um Weave-Knoten zu finden.
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.

Details
Parameter
[in] appState
Ein Zeiger auf den von der Anwendung definierten Status, der beim Erstellen des IdentityRequest-Exchange-Kontexts festgelegt wird.
[in] nodeId
Die Weave-Knoten-ID der Nachrichtenquelle.
[in] nodeAddr
Die IP-Adresse des antwortenden Knotens.
[in] msg
Ein Verweis auf die eingehende IdentityResponse-Nachricht.

Öffentliche Attribute

AppState

void * AppState

Von der Anwendung definiertes Zustandsobjekt.

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[READ ONLY] Exchange-Manager-Objekt

FabricState

const WeaveFabricState * FabricState

[READ ONLY] Fabric-Zustandsobjekt

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

Öffentliche Funktionen

CancelExchange

WEAVE_ERROR CancelExchange(
  void
)

Einen laufenden Identitätsanfrage-Austausch abbrechen, wenn auf eine Antwort gewartet wird

Details
Rückgabewerte
WEAVE_NO_ERROR
bedingungslos.

DeviceDescriptionClient

 DeviceDescriptionClient(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Initialisieren Sie den Status des Gerätebeschreibungs-Clients.

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

SendIdentifyRequest

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

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

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

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

Sende eine Broadcast-Identifizierungsanfrage-Nachricht, um Weave-Knoten zu finden.

Details
Parameter
[in] msg
Ein Verweis auf die zu sendende IdentityRequest-Nachricht.

Herunterfahren

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 nochmaliges Aufrufen der Init-Methode wiederverwendet werden.

Details
Rückgabewerte
WEAVE_NO_ERROR
bedingungslos.