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

Dies ist eine abstrakte Klasse.

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

Delegieren Sie die Klasse für die Implementierung eingehender Gerätesteuerungsvorgänge auf dem Servergerät.

Zusammenfassung

Übernahme

Übernimmt von: nl::Weave::WeaveServerDelegateBase
Direkte bekannte abgeleitete Klassen: 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
Zeigt an, dass eine Zeitüberschreitung bei der Verbindungsüberwachung aufgetreten ist.
OnFailSafeArmed(void)=0
virtual WEAVE_ERROR
Zeigt an, dass die Ausfallsicherheit der Gerätekonfiguration scharf geschaltet wurde.
OnFailSafeDisarmed(void)=0
virtual WEAVE_ERROR
Zeigt an, dass die Gerätekonfiguration „Fail Safe“ unscharf geschaltet wurde.
OnRemotePassiveRendezvousDone(void)=0
virtual void
Gibt an, dass der Remote-Passive Rendezvous-Prozess abgeschlossen ist.
OnRemotePassiveRendezvousStarted(void)=0
virtual void
Gibt an, dass der Remote-Passive Rendezvous-Prozess gestartet wurde.
OnResetConfig(uint16_t resetFlags)=0
virtual WEAVE_ERROR
Gerätekonfiguration vollständig oder teilweise zurücksetzen.
OnSystemTestStarted(uint32_t profileId, uint32_t testId)=0
virtual WEAVE_ERROR
Startet den angegebenen Systemtest.
OnSystemTestStopped(void)=0
virtual WEAVE_ERROR
Stoppen Sie den laufenden Systemtest.
ShouldCloseConBeforeResetConfig(uint16_t resetFlags)=0
virtual bool
Bestimmen Sie, ob eine Serververbindung, falls vorhanden, vor dem Zurücksetzen der Konfiguration geschlossen werden soll.
WillCloseRemotePassiveRendezvous(void)=0
virtual void
Das Remote-Passive Rendezvous wird beendet.
WillStartRemotePassiveRendezvous(void)=0
virtual WEAVE_ERROR
Bereite dich auf ein passives Rendezvous 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 mit Informationen zur empfangenen Nachricht.
[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 zum aktuellen Zeitpunkt des Bewertungsprozesses dar. Nach 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
wenn das Zurücksetzen der Konfiguration erlaubt ist.
FALSE
wenn die Konfiguration nicht zurückgesetzt werden kann.

OnConnectionMonitorTimeout

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

Zeigt an, dass eine Zeitüberschreitung bei der Verbindungsüberwachung aufgetreten ist.

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

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

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
)=0

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

Diese Funktion wird aufgerufen, wenn die Ausfallsicherheit der Servergerätekonfiguration als Reaktion auf eine Anfrage vom Client scharf geschaltet wurde. Wenn der Konfigurationsprozess fehlschlägt, wird die Gerätekonfiguration automatisch auf einen bekannten Status zurückgesetzt.

Details
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die auf einen Fehler hinweisen, der die Sicherung der Fail-Safe-Verwarnung verhindert.

OnFailSafeDisarmed

virtual WEAVE_ERROR OnFailSafeDisarmed(
  void
)=0

Zeigt an, dass die Gerätekonfiguration „Fail Safe“ unscharf geschaltet wurde.

Diese Funktion wird aufgerufen, wenn die Ausfallsicherheit der Servergerätekonfiguration als Reaktion auf eine Anfrage vom Client unscharf geschaltet wurde. Der Client schaltet die Fail-Safe-Funktion nach Abschluss der Konfiguration unscharf.

Details
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die auf einen Fehler hinweisen, der das Unscharfschalten des Fail Safe verhindert.

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
)=0

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

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
)=0

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

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
)=0

Gerätekonfiguration vollständig oder teilweise zurücksetzen.

Bei der Implementierung dieser Funktion wird erwartet, dass jede Kombination aus Netzwerk-, Weave-Fabric- oder Dienstkonfigurationen gemäß den Flags zum Zurücksetzen 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 und die Konfiguration des Geräts nicht zurückgesetzt werden konnte.

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 darauf hinweisen, dass ein Fehler aufgetreten ist, der das Starten des Systemtests verhindert.

OnSystemTestStopped

virtual WEAVE_ERROR OnSystemTestStopped(
  void
)=0

Stoppen Sie den laufenden Systemtest.

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

ShouldCloseConBeforeResetConfig

virtual bool ShouldCloseConBeforeResetConfig(
  uint16_t resetFlags
)=0

Bestimmen Sie, ob eine Serververbindung, falls vorhanden, vor dem Zurücksetzen der Konfiguration geschlossen werden soll.

Mit dieser Funktion wird das gewünschte Verhalten beim Verarbeiten einer Anfrage zum Zurücksetzen der Konfiguration vom Bevollmächtigten abgefragt. Wenn eine Serververbindung derzeit aktiv ist, führt die Antwort TRUE auf diese Methode dazu, dass diese Verbindung geschlossen wird, bevor die Konfiguration über die Methode OnResetConfig 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

Das Remote-Passive Rendezvous wird beendet.

Weitere Informationen:
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
)=0

Bereite dich auf ein passives Rendezvous vor.

Sorgen Sie beispielsweise dafür, dass das Netzwerk 15.4/Thread verbunden werden kann.

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.