nl::Weave::Profiles::DeviceControl::DeviceControlDelegate

Das ist eine abstrakte Klasse.

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

Delegate-Klasse zur Implementierung eingehender Gerätesteuerungsvorgänge auf dem Servergerät.

Zusammenfassung

Übernahme

Übernommen von: nl::Weave::WeaveServerDelegateBase
Direkte bekannte Unterklassen: nl::Weave::DeviceLayer::Internal::DeviceControlServer

Öffentliche Funktionen

EnforceAccessControl(ExchangeContext *ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo *msgInfo, AccessControlResult & result)
virtual void
Zugriffssteuerung auf Nachrichtenebene für eine eingehende DeviceControl-Anfragenachricht erzwingen.
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
Gibt an, dass es ein Zeitlimit für die Verbindungsüberwachung gab.
OnFailSafeArmed(void)=0
virtual WEAVE_ERROR
Zeigt an, dass die Ausfallsicherung der Gerätekonfiguration scharf geschaltet wurde.
OnFailSafeDisarmed(void)=0
virtual WEAVE_ERROR
Zeigt an, dass die Ausfallsicherung der Gerätekonfiguration unscharf ist.
OnRemotePassiveRendezvousDone(void)=0
virtual void
Gibt an, dass der passive Remote-Rendezvous-Prozess abgeschlossen ist.
OnRemotePassiveRendezvousStarted(void)=0
virtual void
Gibt an, dass der passive Remote-Rendezvous-Prozess gestartet wurde.
OnResetConfig(uint16_t resetFlags)=0
virtual WEAVE_ERROR
Die gesamte Gerätekonfiguration oder einen Teil davon zurücksetzen
OnSystemTestStarted(uint32_t profileId, uint32_t testId)=0
virtual WEAVE_ERROR
Startet den angegebenen Systemtest.
OnSystemTestStopped(void)=0
virtual WEAVE_ERROR
Beendet den laufenden Systemtest.
ShouldCloseConBeforeResetConfig(uint16_t resetFlags)=0
virtual bool
Legen Sie fest, ob eine Serververbindung, falls vorhanden, vor dem Zurücksetzen der Konfiguration getrennt werden soll.
WillCloseRemotePassiveRendezvous(void)=0
virtual void
Bereiten Sie sich auf das Beenden von Remote Passive Rendezvous vor.
WillStartRemotePassiveRendezvous(void)=0
virtual WEAVE_ERROR
Bereiten Sie sich auf ein passives Rendezvous per Fernzugriff vor.

Öffentliche Funktionen

EnforceAccessControl

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

Zugriffssteuerung auf Nachrichtenebene für eine eingehende DeviceControl-Anfragenachricht erzwingen.

Details
Parameter
[in] ec
Der ExchangeContext, über den die Nachricht empfangen wurde.
[in] msgProfileId
Die Profil-ID der empfangenen Nachricht.
[in] msgType
Der Nachrichtentyp der empfangenen Nachricht.
[in] msgInfo
Eine WeaveMessageInfo-Struktur, die Informationen zur empfangenen Nachricht enthält.
[in,out] result
Ein Aufzählungswert, der das Ergebnis der Auswertung der Zugriffssteuerungsrichtlinie für die empfangene Nachricht beschreibt. Beim Einstieg in die Methode stellt der Wert das vorläufige Ergebnis am aktuellen Punkt im Bewertungsprozess dar. Bei der Rückgabe 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.

IsResetAllowed

virtual bool IsResetAllowed(
  uint16_t resetFlags
)=0

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

Details
Parameter
[in] resetFlags
Die Flags, die angeben, welche Konfiguration zurückgesetzt werden soll.
Rückgabewerte
TRUE
ob das Zurücksetzen der Konfiguration zulässig ist.
FALSE
Das Zurücksetzen der Konfiguration ist nicht zulässig.

OnConnectionMonitorTimeout

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

Gibt an, dass es ein Zeitlimit für die Verbindungsüberwachung gab.

Diese Funktion wird aufgerufen, wenn eine Zeitüberschreitung der Verbindungsüberwachung aufgetreten ist, d. h. wenn Aktivitätsprüfungen vom Remote-Host für einen bestimmten Zeitraum nicht erkannt wurden.

Details
Parameter
[in] peerNodeId
Die Knoten-ID des Remote-Peers, zu dem die Verbindungsaktivität abgelaufen ist.
[in] peerAddr
Die Adresse des Remote-Peers.

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
)=0

Zeigt an, dass die Ausfallsicherung der Gerätekonfiguration scharf geschaltet wurde.

Diese Funktion wird aufgerufen, wenn die Ausfallsicherung der Servergerätekonfiguration als Antwort auf eine Anfrage des Clients scharf geschaltet wurde. Durch die Ausfallsicherung wird die Gerätekonfiguration automatisch auf einen bekannten Status zurückgesetzt, wenn der Konfigurationsprozess nicht erfolgreich abgeschlossen werden kann.

Details
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die darauf hinweisen, dass ein Fehler aufgetreten ist, der die Scharfschaltung verhindert.

OnFailSafeDisarmed

virtual WEAVE_ERROR OnFailSafeDisarmed(
  void
)=0

Zeigt an, dass die Ausfallsicherung der Gerätekonfiguration unscharf ist.

Diese Funktion wird aufgerufen, wenn die Ausfallsicherung der Servergerätekonfiguration in Reaktion auf eine Anfrage vom Client unscharf geschaltet wurde. Der Client schaltet die Sicherheitseinstellung nach Abschluss der Konfiguration unscharf.

Details
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die darauf hinweisen, dass ein Fehler aufgetreten ist, der das Unscharfschalten der Failover-Funktion verhindert.

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
)=0

Gibt an, dass der passive Remote-Rendezvous-Prozess abgeschlossen ist.

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
)=0

Gibt an, dass der passive Remote-Rendezvous-Prozess gestartet wurde.

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
)=0

Die gesamte Gerätekonfiguration oder einen Teil davon zurücksetzen

Bei der Implementierung dieser Funktion wird erwartet, dass jede Kombination aus Netzwerk-, Weave-Struktur- oder Dienstkonfigurationen gemäß den Zurücksetzen-Flags auf einen bekannten Zustand zurückgesetzt wird.

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

OnSystemTestStarted

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

Startet den angegebenen Systemtest.

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

OnSystemTestStopped

virtual WEAVE_ERROR OnSystemTestStopped(
  void
)=0

Beendet den laufenden Systemtest.

Details
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die anzeigen, dass ein Fehler aufgetreten ist, der das Anhalten des Systemtests verhindert.

ShouldCloseConBeforeResetConfig

virtual bool ShouldCloseConBeforeResetConfig(
  uint16_t resetFlags
)=0

Legen Sie fest, ob eine Serververbindung, falls vorhanden, vor dem Zurücksetzen der Konfiguration getrennt werden soll.

Mit dieser Funktion wird beim Bevollmächtigten das gewünschte Verhalten abgefragt, wenn eine Anfrage zum Zurücksetzen einer Konfiguration verarbeitet wird. Wenn eine Serververbindung derzeit aktiv ist, bewirkt eine TRUE-Antwort auf diese Methode, dass diese Verbindung beendet wird, bevor das Zurücksetzen der Konfiguration über die OnResetConfig-Methode ausgelöst wird.

Details
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.

WillCloseRemotePassiveRendezvous

virtual void WillCloseRemotePassiveRendezvous(
  void
)=0

Bereiten Sie sich auf das Beenden von Remote Passive Rendezvous vor.

Weitere Informationen:
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
)=0

Bereiten Sie sich auf ein passives Rendezvous per Fernzugriff vor.

So können Sie beispielsweise das 15.4/Thread-Netzwerk verbinden.

Details
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die darauf hinweisen, dass bei der Vorbereitung auf den Start von Remote Passive Rendezvous ein Fehler aufgetreten ist.