nl::Weave::DeviceLayer::Internal::DeviceControlServer

#include <src/adaptations/device-layer/include/Weave/DeviceLayer/internal/DeviceControlServer.h>

Implementiert das Weave Device Control-Profil für ein Weave-Gerät.

Zusammenfassung

Übernahme

Übernimmt von:
  nl::Weave::Profiles::DeviceControl::DeviceControlServer
  nl::Weave::Profiles::DeviceControl::DeviceControlDelegate

Öffentliche Funktionen

Init()
IsPairedToAccount() const override
virtual bool
Wird aufgerufen, um festzustellen, ob das Gerät derzeit mit einem Konto gekoppelt ist.
IsResetAllowed(uint16_t resetFlags) override
virtual bool
Prüfen Sie, ob das Zurücksetzen der angegebenen Konfiguration zulässig ist.
OnConnectionMonitorTimeout(uint64_t peerNodeId, IPAddress peerAddr) override
void
OnFailSafeArmed(void) override
virtual WEAVE_ERROR
Zeigt an, dass die Ausfallsicherung der Gerätekonfiguration scharf geschaltet wurde.
OnFailSafeDisarmed(void) override
virtual WEAVE_ERROR
Zeigt an, dass die Ausfallsicherung der Gerätekonfiguration unscharf ist.
OnPlatformEvent(const WeaveDeviceEvent *event)
void
OnRemotePassiveRendezvousDone(void) override
virtual void
Gibt an, dass der passive Remote-Rendezvous-Prozess abgeschlossen ist.
OnRemotePassiveRendezvousStarted(void) override
virtual void
Gibt an, dass der passive Remote-Rendezvous-Prozess gestartet wurde.
OnResetConfig(uint16_t resetFlags) override
virtual WEAVE_ERROR
Die gesamte Gerätekonfiguration oder einen Teil davon zurücksetzen
OnSystemTestStarted(uint32_t profileId, uint32_t testId) override
virtual WEAVE_ERROR
Startet den angegebenen Systemtest.
OnSystemTestStopped(void) override
virtual WEAVE_ERROR
Beendet den laufenden Systemtest.
ShouldCloseConBeforeResetConfig(uint16_t resetFlags) override
virtual bool
Legen Sie fest, ob eine Serververbindung, falls vorhanden, vor dem Zurücksetzen der Konfiguration getrennt werden soll.
WillCloseRemotePassiveRendezvous(void) override
virtual void
Bereiten Sie sich auf das Beenden von Remote Passive Rendezvous vor.
WillStartRemotePassiveRendezvous(void) override
virtual WEAVE_ERROR
Bereiten Sie sich auf ein passives Rendezvous per Fernzugriff vor.

Geschützte Funktionen

DeviceControlServer()=default
DeviceControlServer(const DeviceControlServer &)=delete
DeviceControlServer(const DeviceControlServer &&)=delete
operator=(const DeviceControlServer &)=delete
~DeviceControlServer()=default

Öffentliche Funktionen

Init

WEAVE_ERROR Init()

IsPairedToAccount

virtual bool IsPairedToAccount() const override

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

IsResetAllowed

virtual bool IsResetAllowed(
  uint16_t resetFlags
) override

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

void OnConnectionMonitorTimeout(
  uint64_t peerNodeId,
  IPAddress peerAddr
) override

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
) override

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
) override

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.

OnPlatformEvent

void OnPlatformEvent(
  const WeaveDeviceEvent *event
)

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
) override

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

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
) override

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

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
) override

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
) override

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
) override

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
) override

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
) override

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

Weitere Informationen:
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
) override

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.

Geschützte Funktionen

DeviceControlServer

 DeviceControlServer()=default

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &
)=delete

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &&
)=delete

Operator=

DeviceControlServer & operator=(
  const DeviceControlServer &
)=delete

~DeviceControlServer

 ~DeviceControlServer()=default