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

nl:: Weben:: Profile:: Gerätesteuerung:: DeviceControlDelegate

Dies ist eine abstrakte Klasse.

#include <src/lib/profiles/device-control/DeviceControl.h>

Delegate-Klasse zum Implementieren eingehender Gerätesteuerungsvorgänge auf dem Servergerät.

Zusammenfassung

Erbe

Erbt von: nl :: Weave :: WeaveServerDelegateBase
Direkt bekannt Subklassen: nl :: Weave :: DeviceLayer :: Intern :: DeviceControlServer

Öffentliche Funktionen

EnforceAccessControl ( ExchangeContext *ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo *msgInfo, AccessControlResult & result)
virtual void
Erzwingen Nachrichtenebene Zugriffssteuerung für eine eingehende Deviceanforderungsnachricht.
IsPairedToAccount () const
virtual bool
Wird aufgerufen, um festzustellen, ob das Gerät derzeit mit einem Konto gekoppelt ist.
IsResetAllowed (uint16_t resetFlags)=0
virtual bool
Prüfen Sie, ob das Zurücksetzen der angegebenen Konfiguration zulässig ist.
OnConnectionMonitorTimeout (uint64_t peerNodeId, IPAddress peerAddr)=0
virtual void
Zeigt an, dass ein Timeout für die Verbindungsüberwachung aufgetreten ist.
OnFailSafeArmed (void)=0
virtual WEAVE_ERROR
Zeigt an, dass die ausfallsichere Gerätekonfiguration scharfgeschaltet wurde.
OnFailSafeDisarmed (void)=0
virtual WEAVE_ERROR
Zeigt an, dass die Gerätekonfiguration ausfallsicher deaktiviert wurde.
OnRemotePassiveRendezvousDone (void)=0
virtual void
Zeigt an, dass der Remote Passive Rendezvous-Prozess abgeschlossen ist.
OnRemotePassiveRendezvousStarted (void)=0
virtual void
Zeigt an, dass der Remote Passive Rendezvous-Prozess gestartet wurde.
OnResetConfig (uint16_t resetFlags)=0
virtual WEAVE_ERROR
Setzen Sie die gesamte oder einen Teil der Gerätekonfiguration zurück.
OnSystemTestStarted (uint32_t profileId, uint32_t testId)=0
virtual WEAVE_ERROR
Starten Sie den angegebenen Systemtest.
OnSystemTestStopped (void)=0
virtual WEAVE_ERROR
Stoppen Sie den laufenden Systemtest.
ShouldCloseConBeforeResetConfig (uint16_t resetFlags)=0
virtual bool
Legen Sie fest, ob eine Serververbindung, falls vorhanden, vor einem Konfigurationsreset geschlossen werden soll.
WillCloseRemotePassiveRendezvous (void)=0
virtual void
Bereiten Sie sich darauf vor, das passive Remote-Rendezvous zu beenden.
WillStartRemotePassiveRendezvous (void)=0
virtual WEAVE_ERROR
Bereiten Sie sich auf ein passives Remote-Rendezvous vor.

Öffentliche Funktionen

Zugriffskontrolle erzwingen

virtual void EnforceAccessControl(
  ExchangeContext *ec,
  uint32_t msgProfileId,
  uint8_t msgType,
  const WeaveMessageInfo *msgInfo,
  AccessControlResult & result
)

Erzwingen Nachrichtenebene Zugriffssteuerung für eine eingehende Deviceanforderungsnachricht.

Einzelheiten
Parameter
[in] ec
Die ExchangeContext , über die die Nachricht empfangen wurde.
[in] msgProfileId
Die Profil-ID der empfangenen Nachricht.
[in] msgType
Der Nachrichtentyp der empfangenen Nachricht.
[in] msgInfo
A WeaveMessageInfo Struktur Informationen über die empfangene Nachricht enthält.
[in,out] result
Ein Aufzählungswert, der das Ergebnis der Auswertung der Zugriffssteuerungsrichtlinie für die empfangene Nachricht beschreibt. Beim Eintritt in die Methode stellt der Wert das vorläufige Ergebnis zum aktuellen Zeitpunkt des Bewertungsprozesses dar. Bei der Rückkehr wird erwartet, dass das Ergebnis die endgültige Bewertung der Zugriffssteuerungsrichtlinie für die Nachricht darstellt.

IsPairedToAccount

virtual bool IsPairedToAccount() const 

Wird aufgerufen, um festzustellen, ob das Gerät derzeit mit einem Konto gekoppelt ist.

IstResetErlaubt

virtual bool IsResetAllowed(
  uint16_t resetFlags
)=0

Prüfen Sie, ob das Zurücksetzen der angegebenen Konfiguration zulässig ist.

Einzelheiten
Parameter
[in] resetFlags
Die Flags, die angeben, welche Konfiguration zurückgesetzt werden soll.
Rückgabewerte
TRUE
wenn das Zurücksetzen der Konfiguration erlaubt ist.
FALSE
wenn das Zurücksetzen der Konfiguration nicht erlaubt ist.

OnConnectionMonitorTimeout

virtual void OnConnectionMonitorTimeout(
  uint64_t peerNodeId,
  IPAddress peerAddr
)=0

Zeigt an, dass ein Timeout für die Verbindungsüberwachung aufgetreten ist.

Diese Funktion wird aufgerufen, wenn eine Verbindungsüberwachungszeitüberschreitung aufgetreten ist, dh wenn eine bestimmte Zeit lang keine Liveness-Prüfungen vom Remote-Host erkannt wurden.

Einzelheiten
Parameter
[in] peerNodeId
Die Node-ID der Gegenstelle, zu der die Verbindungslebensdauer abgelaufen ist.
[in] peerAddr
Die Adresse der Gegenstelle.

OnFailSafeBewaffnet

virtual WEAVE_ERROR OnFailSafeArmed(
  void
)=0

Zeigt an, dass die ausfallsichere Gerätekonfiguration scharfgeschaltet wurde.

Diese Funktion wird aufgerufen, wenn die ausfallsichere Konfiguration der Server-Geräte als Reaktion auf eine Anforderung des Clients scharfgeschaltet wurde. Der Fail Safe setzt die Gerätekonfiguration automatisch auf einen bekannten Zustand zurück, sollte der Konfigurationsprozess nicht erfolgreich abgeschlossen werden.

Einzelheiten
Rückgabewerte
WEAVE_NO_ERROR
Auf Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die anzeigen, dass ein Fehler aufgetreten ist, der das Scharfschalten des Failsafe verhindert.

OnFailSafeDisarmed

virtual WEAVE_ERROR OnFailSafeDisarmed(
  void
)=0

Zeigt an, dass die Gerätekonfiguration ausfallsicher deaktiviert wurde.

Diese Funktion wird aufgerufen, wenn die ausfallsichere Konfiguration der Servervorrichtung als Reaktion auf eine Anforderung des Clients unscharf wurde. Der Client deaktiviert den Fail Safe, nachdem die Konfiguration abgeschlossen ist.

Einzelheiten
Rückgabewerte
WEAVE_NO_ERROR
Auf Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die anzeigen, dass ein Fehler aufgetreten ist, der die Deaktivierung des Failsafes verhindert hat.

OnRemotePassivRendezvousFertig

virtual void OnRemotePassiveRendezvousDone(
  void
)=0

Zeigt an, dass der Remote Passive Rendezvous-Prozess abgeschlossen ist.

OnRemotePassivRendezvousGestartet

virtual void OnRemotePassiveRendezvousStarted(
  void
)=0

Zeigt an, dass der Remote Passive Rendezvous-Prozess gestartet wurde.

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
)=0

Setzen Sie die gesamte oder einen Teil der Gerätekonfiguration zurück.

Es wird erwartet, dass die Implementierung dieser Funktion jede Kombination von Netzwerk-, Weave-Fabric- oder Dienstkonfigurationen gemäß den Reset-Flags auf einen bekannten Zustand zurücksetzt.

Einzelheiten
Parameter
[in] resetFlags
Die Flags, die angeben, welche Konfiguration zurückgesetzt werden soll.
Rückgabewerte
WEAVE_NO_ERROR
Auf Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die darauf hinweisen, dass ein Fehler aufgetreten ist, der das Zurücksetzen des Geräts verhindert

OnSystemTestStarted

virtual WEAVE_ERROR OnSystemTestStarted(
  uint32_t profileId,
  uint32_t testId
)=0

Starten Sie den angegebenen Systemtest.

Einzelheiten
Parameter
[in] profileId
Die ID des Profils des angeforderten Tests.
[in] testId
Die ID des angeforderten Tests.
Rückgabewerte
WEAVE_NO_ERROR
Auf Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die anzeigen, dass ein Fehler aufgetreten ist, der den Start des Systemtests verhindert hat.

OnSystemTestStopped

virtual WEAVE_ERROR OnSystemTestStopped(
  void
)=0

Stoppen Sie den laufenden Systemtest.

Einzelheiten
Rückgabewerte
WEAVE_NO_ERROR
Auf Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die anzeigen, dass ein Fehler aufgetreten ist, der das Beenden des Systemtests verhindert hat.

ShouldCloseConBeforeResetConfig

virtual bool ShouldCloseConBeforeResetConfig(
  uint16_t resetFlags
)=0

Legen Sie fest, ob eine Serververbindung, falls vorhanden, vor einem Konfigurationsreset geschlossen werden soll.

Diese Funktion wird verwendet, um den Delegaten nach dem gewünschten Verhalten bei der Verarbeitung einer Konfigurationsrücksetzungsanforderung abzufragen. Wenn derzeit eine Serververbindung aktiv ist, führt eine TRUE-Antwort auf diese Methode dazu, dass diese Verbindung geschlossen wird, bevor das Zurücksetzen der Konfiguration über die Methode OnResetConfig ausgelöst wird.

Einzelheiten
Parameter
[in] resetFlags
Die Flags, die angeben, welche Konfiguration zurückgesetzt werden soll.
Rückgabewerte
true
wenn die Verbindung geschlossen werden muss.
false
wenn die Verbindung nicht geschlossen werden muss.

WillCloseRemotePassivRendezvous

virtual void WillCloseRemotePassiveRendezvous(
  void
)=0

Bereiten Sie sich darauf vor, das passive Remote-Rendezvous zu beenden.

Siehe auch:
WillStartRemotePassivRendezvous(void)

WillStartRemotePassivRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
)=0

Bereiten Sie sich auf ein passives Remote-Rendezvous vor.

Machen Sie beispielsweise das Netzwerk 15.4/Thread zugreifbar.

Einzelheiten
Rückgabewerte
WEAVE_NO_ERROR
Auf Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die anzeigen, dass bei der Vorbereitung des Starts von Remote Passive Rendezvous ein Fehler aufgetreten ist.